12. The Command Line Tool

The Command Line Tool shows some informations about a Vortex Link system:

  • Services
  • Participants
  • Writers
  • Readers

by getting data form one or more of the services of the system.

Command Line Tool

12.1. Commands

All the available commands on the Command Line Tool

12.1.1. service list

The tool prints a list of all the discovered Services and it shows their GUIDs plus some other properties:

  • node name
  • exec name

12.1.2. service <service_GUID>

The tool prints some informations about the specified Service:

  • node name
  • exec name

12.1.3. participant list

The tool prints a list of all the discovered Participants and it shows their GUID

12.1.4. writer list

The tool prints a list of all the discovered DataWriters and it shows their GUID plus some other informations:

  • topic name
  • topic kind

12.1.5. writer <writer_GUID>

The tool prints some informations about the specified DataWriter:

  • topic name

  • topic kind

  • entity name

  • QoS

    • GroupData
    • UserData
    • Lifespan
    • Partition
    • LatencyBudget
    • DestinationOrder
    • Deadline
    • Presentation
    • Ownership
    • DurabilityService
    • Durability
    • Liveliness
    • Reliability
    • ResourceLimits
    • History
    • TransportPriority
    • WriterDataLifeCycle
    • OwnershipStrength

12.1.6. reader list

The tool prints a list of all the discovered DataReaders and it shows their GUID plus some other informations:

  • topic name
  • topic kind

12.1.7. reader <reader_GUID>

The tool prints some informations about the specified DataReader:

  • topic name

  • topic kind

  • entity name

  • QoS

    • GroupData
    • UserData
    • Lifespan
    • Partition
    • LatencyBudget
    • DestinationOrder
    • Deadline
    • Ownership
    • DurabilityService
    • Durability
    • Liveliness
    • Reliability
    • ResourceLimits
    • History
    • ReaderDataLifeCycle
    • TimeBasedFilter

12.1.8. route list

The tool prints a list of all the discovered routes and it shows the Services discovered by GUID and all the routes between DataWriter and DataReader related to those Services:

  • service GUID_x

    • writer GUID_y
    • reader GUID_z
    • writer GUID_y
    • reader GUID_r

  • service GUID_r

    • writer GUID_g
    • reader GUID_f
    • writer GUID_e
    • reader GUID_d
    • writer GUID_e
    • reader GUID_a

...

12.1.9. route <service_GUID>

The tool prints a list of all the discovered routes related to the specified Service

12.1.10. route <service_GUID> <writer_GUID> <reader_GUID>

The tool prints a list of only the specified route

12.1.11. route nb

The tool prints the total number of the discovered routes

12.1.12. route nb <service_GUID>

The tool prints the total number of the discovered routes releated to the specified Service

12.1.13. exit

This command closes the Tool

12.1.14. quit

This command closes the Tool

12.1.15. help

The list of all the available commands is printed

12.2. Examples

12.2.1. Service

Example 1

input:

> service list

output:

service [007f0101.000069f9.00000000 PARTICIP]
   node name : Unknown
   exec name : Unknown
service [004d0101.0000759e.00000000 PARTICIP]
   node name : Unknown
   exec name : Unknown

Example 2

input:

> service [007f0101.000069f9.00000000 PARTICIP]

output:

service [007f0101.000069f9.00000000 PARTICIP]
   node name : Unknown
   exec name : Unknown

12.2.2. Participant

Example 1

input:

> paticipant list

output:

participant [007f0101.00007607.00000000 PARTICIP]
participant [007f0101.000075ba.00000000 PARTICIP]

12.2.3. Writer

Example 1

input:

> writer list

output:

writer [007f0101.000075ba.00000000 00000302]
   topic name : Circle
   topic kind : ShapeType
writer [007f0101.000075ba.00000000 00000402]
   topic name : Square
   topic kind : ShapeType

Example 2

input:

> writer [007f0101.000075ba.00000000 00000302]

output:

writer [007f0101.000075ba.00000000 00000302]
   topic name : Circle
   topic kind : ShapeType
   entity name : Circle_DataWriter
   QoS :
          GroupData: Empty
          UserData: Empty
          Lifespan: Duration = INFINITE
          Partition: []
          LatencyBudget: Duration = 0
          DestinationOrder: Kind = BY_RECEPTION_TIMESTAMP
          Deadline: Period = INFINITE
          Presentation: AccessScope = INSTANCE
          Ownership: Kind =  SHARED
          DurabilityService:
                 HistoryDepth = 1, HistoryKind = KEEP_LAST
                 MaxInstances = -1, MaxSamples = -1
                 MaxSamplesPerInstance = -1
          Durability: Kind = VOLATILE
          Liveliness: Kind = AUTOMATIC, LeaseDuration = INFINITE
          Reliability: Kind = BEST_EFFORT, MaxBlockingTime = 0.099999998
          ResourceLimits:
                 MaxInstances = -1, MaxSamples = -1
                 MaxSamplesPerInstance = -1
          History: Kind = KEEP_LAST, Depth = 1
          TransportPriority: 50
          WriterDataLifeCycle:
                 AutoDisposeUnregisteredInstances = true
                 AutoPurgeSuspendedSamplesDelay = INFINITE
                 AutoUnregisterInstanceDelay = INFINITE
          OwnershipStrength: 50

12.2.4. Reader

Example 1

input:

> reader list

output:

reader [007f0101.00007607.00000000 00000407]
   topic name : Triangle
   topic kind : ShapeType
reader [007f0101.00007607.00000000 00000307]
   topic name : Circle
   topic kind : ShapeType

Example 2

input:

> reader [007f0101.00007607.00000000 00000307]

output:

reader [007f0101.00007607.00000000 00000307]
   topic name : Circle
   topic kind : ShapeType
   entity name : Circle_DataReader
   QoS :
          GroupData: Empty
          UserData: Empty
          Partition: []
          LatencyBudget: Duration = INFINITE
          DestinationOrder: Kind = BY_RECEPTION_TIMESTAMP
          Deadline: Period = INFINITE
          Ownership: Kind =  SHARED
          Durability: Kind = VOLATILE
          Liveliness: Kind = AUTOMATIC, LeaseDuration = INFINITE
          Reliability: Kind = BEST_EFFORT, MaxBlockingTime = 0.099999998
          ResourceLimits:
                 MaxInstances = -1, MaxSamples = -1
                 MaxSamplesPerInstance = -1
          History: Kind = KEEP_LAST, Depth = 1
          ReaderDataLifeCycle:
                 AutoPurgeDisposedSamplesDelay = INFINITE
                 AutoPurgeNoWriterSamplesDelay = INFINITE
          TimeBasedFilter:  Minimum Separation = 0

12.2.5. Route

Example 1

input:

> route list

output:

service [007f0101.0000759e.00000000 PARTICIP]
   writer [007f0101.000075ba.00000000 00000302]
      Unicast Locators List:
         TCP 10.100.1.227:8000
      No Multicast Locators
   reader [007f0101.00007607.00000000 00000307]
      Unicast Locators List:
         TCP 10.100.1.227:8100
      No Multicast Locators

   writer [007f0101.000075ba.00000000 00000302]
      Unicast Locators List:
         TCP 10.100.1.227:8000
      No Multicast Locators
   reader [007f0101.00007a74.00000000 00000307]
      Unicast Locators List:
         UDP 10.100.1.227:7431
      Multicast Locators List:
         UDP 239.255.0.1:7401

service [004d0101.000069f8.00000000 PARTICIP]
   writer [004d0101.000042ca.00000000 00000402]
      Unicast Locators List:
         TCP 10.100.1.70:8200
      No Multicast Locators
   reader [004d0101.00003407.00000000 00000507]
      Unicast Locators List:
         TCP 10.100.1.70:8100
      No Multicast Locators

Example 2

input:

> route list [007f0101.0000759e.00000000 PARTICIP]

output:

service [007f0101.0000759e.00000000 PARTICIP]
   writer [007f0101.000075ba.00000000 00000302]
      Unicast Locators List:
         TCP 10.100.1.227:8000
      No Multicast Locators
   reader [007f0101.00007607.00000000 00000307]
      Unicast Locators List:
         TCP 10.100.1.227:8100
      No Multicast Locators

   writer [007f0101.000075ba.00000000 00000302]
      Unicast Locators List:
         TCP 10.100.1.227:8000
      No Multicast Locators
   reader [007f0101.00007a74.00000000 00000307]
      Unicast Locators List:
         UDP 10.100.1.227:7431
      Multicast Locators List:
         UDP 239.255.0.1:7401

Example 3

input:

> route nb

output:

3

Example 5

input:

> route nb [007f0101.0000759e.00000000 PARTICIP]

output:

2