.. .. Vortex Link .. .. This software and documentation are Copyright 2010 to 2018 ADLINK .. Technology Limited, its affiliated companies and licensors. All rights .. reserved. .. .. Licensed under the ADLINK Software License Agreement Rev 2.7 2nd October .. 2014 (the "License"); you may not use this file except in compliance with .. the License. .. You may obtain a copy of the License at: .. docs/LICENSE.html .. .. See the License for the specific language governing permissions and .. limitations under the License. .. ##################### 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. .. figure:: ./images/CommandLineTool.png :alt: Command Line Tool :width: 40em :align: center =============== Commands =============== **All the available commands on the Command Line Tool** --------------- 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 ------------------------ service ------------------------ The tool prints some informations about the specified Service: + node name + exec name ------------------ participant list ------------------ The tool prints a list of all the discovered Participants and it shows their GUID --------------- 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 ---------------------- writer ---------------------- 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 --------------- 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 ---------------------- reader ---------------------- 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 --------------- 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 ... ---------------------- route ---------------------- The tool prints a list of all the discovered routes related to the specified Service --------------- route --------------- The tool prints a list of only the specified route --------------- route nb --------------- The tool prints the total number of the discovered routes --------------- route nb --------------- The tool prints the total number of the discovered routes releated to the specified Service --------------- exit --------------- This command closes the Tool --------------- quit --------------- This command closes the Tool --------------- help --------------- The list of all the available commands is printed =============== Examples =============== ------- Service ------- **Example 1** input: .. code-block:: shell > service list output: .. code-block:: shell 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: .. code-block:: shell > service [007f0101.000069f9.00000000 PARTICIP] output: .. code-block:: shell service [007f0101.000069f9.00000000 PARTICIP] node name : Unknown exec name : Unknown ----------- Participant ----------- **Example 1** input: .. code-block:: shell > paticipant list output: .. code-block:: shell participant [007f0101.00007607.00000000 PARTICIP] participant [007f0101.000075ba.00000000 PARTICIP] ------ Writer ------ **Example 1** input: .. code-block:: shell > writer list output: .. code-block:: shell 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: .. code-block:: shell > writer [007f0101.000075ba.00000000 00000302] output: .. code-block:: shell 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 ------ Reader ------ **Example 1** input: .. code-block:: shell > reader list output: .. code-block:: shell 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: .. code-block:: shell > reader [007f0101.00007607.00000000 00000307] output: .. code-block:: shell 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 ----- Route ----- **Example 1** input: .. code-block:: shell > route list output: .. code-block:: shell 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: .. code-block:: shell > route list [007f0101.0000759e.00000000 PARTICIP] output: .. code-block:: shell 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 .. Error on the pdf file about visualization of line 464 (out of page) .. .. **Example 3** .. .. input: ......... .. .. code-block:: shell .. .. > route [007f0101.0000759e.00000000 PARTICIP] [007f0101.000075ba.00000000 00000302] [007f0101.00007a74.00000000 00000307] .. .. output: .......... .. code-block:: shell .. .. service [007f0101.0000759e.00000000 PARTICIP] .. 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: .. code-block:: shell > route nb output: .. code-block:: shell 3 **Example 5** input: .. code-block:: shell > route nb [007f0101.0000759e.00000000 PARTICIP] output: .. code-block:: shell 2