ign.hh File Reference

#include <cstring>
#include "ignition/transport/Export.hh"

Go to the source code of this file.

Functions
void	cmdServiceInfo (const char *_service)
	External hook to execute 'ign service -i' from the command line. More...
void	cmdServiceList ()
	External hook to execute 'ign service -l' from the command line. More...
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...
void	cmdTopicEcho (const char *_topic, const double _duration)
	External hook to execute 'ign topic -e' from the command line. More...
void	cmdTopicInfo (const char *_topic)
	External hook to execute 'ign topic -i' from the command line. More...
void	cmdTopicList ()
	External hook to execute 'ign topic -l' from the command line. More...
void	cmdTopicPub (const char *_topic, const char *_msgType, const char *_msgData)
	External hook to execute 'ign topic -p' from the command line. More...
const char *	ignitionVersion ()
	External hook to read the library version. More...

Function Documentation

cmdServiceInfo()

void cmdServiceInfo

(

const char *

_service

)

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

Parameters

[in]

_service

Service name.

cmdServiceList()

void cmdServiceList

(

)

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

cmdServiceReq()

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]	_service	Service name.
[in]	_reqType	Message type used in the request.
[in]	_repType	Message type used in the response.
[in]	_timeout	The request will timeout after '_timeout' ms.
[in]	_reqData	Input 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"');

cmdTopicEcho()

void cmdTopicEcho	(	const char *	_topic,
		const double	_duration
	)

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

Parameters

[in]	_topic	Topic name.
[in]	_duration	Duration (seconds) to run.

cmdTopicInfo()

void cmdTopicInfo

(

const char *

_topic

)

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

Parameters

[in]

_topic

Topic name.

cmdTopicList()

void cmdTopicList

(

)

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

cmdTopicPub()

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

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

Parameters

[in]	_topic	Topic name.
[in]	_msgType	Message type.
[in]	_msgData	The format expected is the same used by Protobuf DebugString(). E.g.: cmdTopicPub("/foo", "ignition.msgs.StringMsg", "'data:\"Custom data"');

ignitionVersion()

const char* ignitionVersion

(

)

External hook to read the library version.

Returns

C-string representing the version. Ex.: 0.1.2