All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Functions
ign.hh File Reference
#include <cstring>
#include "ignition/transport/Helpers.hh"
Include dependency graph for ign.hh:

Go to the source code of this file.

Functions

IGNITION_TRANSPORT_VISIBLE void cmdServiceInfo (const char *_service)
 External hook to execute 'ign service -i' from the command line. More...
 
IGNITION_TRANSPORT_VISIBLE void cmdServiceList ()
 External hook to execute 'ign service -l' from the command line. More...
 
IGNITION_TRANSPORT_VISIBLE void cmdServiceReq (const char *_service, const char *_reqType, const char *_repType, const int _timeout, const char *_reqData)
 External hook to execute 'ign service -r' from the command line. More...
 
IGNITION_TRANSPORT_VISIBLE void cmdTopicEcho (const char *_topic, const double _duration)
 External hook to execute 'ign topic -e' from the command line. More...
 
IGNITION_TRANSPORT_VISIBLE void cmdTopicInfo (const char *_topic)
 External hook to execute 'ign topic -i' from the command line. More...
 
IGNITION_TRANSPORT_VISIBLE void cmdTopicList ()
 External hook to execute 'ign topic -l' from the command line. More...
 
IGNITION_TRANSPORT_VISIBLE void cmdTopicPub (const char *_topic, const char *_msgType, const char *_msgData)
 External hook to execute 'ign topic -p' from the command line. More...
 
IGNITION_TRANSPORT_VISIBLE char * ignitionVersion ()
 External hook to read the library version. More...
 

Function Documentation

IGNITION_TRANSPORT_VISIBLE void cmdServiceInfo ( const char *  _service)

External hook to execute 'ign service -i' from the command line.

Parameters
[in]_serviceService name.
IGNITION_TRANSPORT_VISIBLE void cmdServiceList ( )

External hook to execute 'ign service -l' from the command line.

IGNITION_TRANSPORT_VISIBLE void cmdServiceReq ( const char *  _service,
const char *  _reqType,
const char *  _repType,
const int  _timeout,
const char *  _reqData 
)

External hook to execute 'ign service -r' from the command line.

Parameters
[in]_serviceService name.
[in]_reqTypeMessage type used in the request.
[in]_repTypeMessage type used in the response.
[in]_timeoutThe request will timeout after '_timeout' ms.
[in]_reqDataInput data sent in the request. The format expected is the same used by Protobuf DebugString(). E.g.: cmdServiceReq("/bar", "ignition.msgs.StringMsg", "ignition.msgs.StringMsg", 1000, "'data:\"Custom data"');
IGNITION_TRANSPORT_VISIBLE void cmdTopicEcho ( const char *  _topic,
const double  _duration 
)

External hook to execute 'ign topic -e' from the command line.

Parameters
[in]_topicTopic name.
[in]_durationDuration (seconds) to run.
IGNITION_TRANSPORT_VISIBLE void cmdTopicInfo ( const char *  _topic)

External hook to execute 'ign topic -i' from the command line.

Parameters
[in]_topicTopic name.
IGNITION_TRANSPORT_VISIBLE void cmdTopicList ( )

External hook to execute 'ign topic -l' from the command line.

IGNITION_TRANSPORT_VISIBLE void cmdTopicPub ( const char *  _topic,
const char *  _msgType,
const char *  _msgData 
)

External hook to execute 'ign topic -p' from the command line.

Parameters
[in]_topicTopic name.
[in]_msgTypeMessage type.
[in]_msgDataThe format expected is the same used by Protobuf DebugString(). E.g.: cmdTopicPub("/foo", "ignition.msgs.StringMsg", "'data:\"Custom data"');
IGNITION_TRANSPORT_VISIBLE char* ignitionVersion ( )

External hook to read the library version.

Returns
C-string representing the version. Ex.: 0.1.2