rad::cii Namespace Reference

Classes
class	CancellationToken
class	OldbAdapter
class	Publisher
class	Replier
class	Request
class	Request< REP_TYPE, void >
class	RequestAmi
class	RequestAmi< REP_TYPE, void >
class	Requestor
class	Subscriber

Typedefs
typedef std::vector< std::int8_t >	VecInt8Type
typedef std::vector< std::int16_t >	VecInt16Type
typedef std::vector< std::int32_t >	VecInt32Type
typedef std::vector< std::int64_t >	VecInt64Type
typedef std::vector< std::uint8_t >	VecUint8Type
typedef std::vector< std::uint16_t >	VecUint16Type
typedef std::vector< std::uint32_t >	VecUint32Type
typedef std::vector< std::uint64_t >	VecUint64Type
typedef std::vector< bool >	VecBoolType
typedef std::vector< float >	VecFloatType
typedef std::vector< double >	VecDoubleType
typedef std::variant< std::int8_t, std::int16_t, std::int32_t, std::int64_t, std::uint8_t, std::uint16_t, std::uint32_t, std::uint64_t, bool, float, double, std::string, VecInt8Type, VecInt16Type, VecInt32Type, VecInt64Type, VecUint8Type, VecUint16Type, VecUint32Type, VecUint64Type, VecBoolType, VecFloatType, VecDoubleType >	OldbType

Functions
template<class EVENT , class T >
void	RoutePartialReply (std::shared_ptr<::elt::mal::rr::Ami< T > > ami, rad::SMAdapter &sm)
template<class EVENT , class FUT >
CancellationToken	RouteReply (FUT &&rep_future, rad::SMAdapter &sm)
template<class EVENT , class EVENT_ERR , class FUT >
CancellationToken	RouteReply (FUT &&rep_future, rad::SMAdapter &sm)
template<class EVENT , class EVENT_TIMEOUT , class EVENT_ERR , class FUT >
CancellationToken	RouteReplyWithTimeout (FUT &&rep_future, rad::SMAdapter &sm)
void	LoadMiddlewares (const std::vector< std::string > &mal_types)
void	LoadMiddlewares (const std::vector< std::pair< std::string, elt::mal::Mal::Properties > > &mal_specs)

Typedef Documentation

OldbType

typedef std::variant<std::int8_t, std::int16_t, std::int32_t, std::int64_t, std::uint8_t, std::uint16_t, std::uint32_t, std::uint64_t, bool, float, double, std::string, VecInt8Type, VecInt16Type, VecInt32Type, VecInt64Type, VecUint8Type, VecUint16Type, VecUint32Type, VecUint64Type, VecBoolType, VecFloatType, VecDoubleType> rad::cii::OldbType

VecBoolType

typedef std::vector<bool> rad::cii::VecBoolType

VecDoubleType

typedef std::vector<double> rad::cii::VecDoubleType

VecFloatType

typedef std::vector<float> rad::cii::VecFloatType

VecInt16Type

typedef std::vector<std::int16_t> rad::cii::VecInt16Type

VecInt32Type

typedef std::vector<std::int32_t> rad::cii::VecInt32Type

VecInt64Type

typedef std::vector<std::int64_t> rad::cii::VecInt64Type

VecInt8Type

typedef std::vector<std::int8_t> rad::cii::VecInt8Type

VecUint16Type

typedef std::vector<std::uint16_t> rad::cii::VecUint16Type

VecUint32Type

typedef std::vector<std::uint32_t> rad::cii::VecUint32Type

VecUint64Type

typedef std::vector<std::uint64_t> rad::cii::VecUint64Type

VecUint8Type

typedef std::vector<std::uint8_t> rad::cii::VecUint8Type

Function Documentation

LoadMiddlewares() [1/2]

void rad::cii::LoadMiddlewares

(

const std::vector< std::pair< std::string, elt::mal::Mal::Properties > > &

mal_specs

)

This helper function loads given MAL middlewares and configures them with the provided QoS properties.

The properties will apply to all publishers, etc. of the middleware.

Parameters

mal_specs

A list of (middleware name, middleware properties) pairs

Usage: LoadMiddlewares({ {"zpb",{}}, {"opcua",{}} });

LoadMiddlewares() [2/2]

void rad::cii::LoadMiddlewares ( const std::vector< std::string > & mal_types )

inline

This helper function loads given MAL middlewares and configure them with default QoS properties.

For specifying MAL properties, see the overloaded variant of this method.

Parameters

mal_types

A list of supported middlewares (e.g. zpb, opcua, ...)

Usage: LoadMiddlewares({"zpb", "opcua"});

RoutePartialReply()

template<class EVENT , class T >

void rad::cii::RoutePartialReply	(	std::shared_ptr<::elt::mal::rr::Ami< T > >	ami,
		rad::SMAdapter &	sm )

This function can be use to configure the injection of an event, associated to a partial reply, into a given State Machine engine. There is no special handling for error replies (exceptions).

Template Parameters

EVENT	Type of event to trigger when a partial reply is received.
T	Type associated to the partial replies.

Parameters

ami	Object associated to the partial replies and returned by MAL Client interface invocation.
sm	Reference to a State Machine adapter.

RouteReply() [1/2]

template<class EVENT , class FUT >

CancellationToken rad::cii::RouteReply	(	FUT &&	rep_future,
		rad::SMAdapter &	sm )

This function can be use to configure the injection of an event, associated to a reply, into a given State Machine engine. There is no special handling for error replies (exceptions).

Template Parameters

EVENT	Type of event to trigger when the reply is received.
FUT	Type of future for the reply.

Parameters

rep_future	Future associated to the reply and returned by MAL Client interface invocation.
sm	Reference to a State Machine adapter.

Returns

A token that can be used to check whether the request has been aborted or not.

RouteReply() [2/2]

template<class EVENT , class EVENT_ERR , class FUT >

CancellationToken rad::cii::RouteReply	(	FUT &&	rep_future,
		rad::SMAdapter &	sm )

This function can be use to configure the injection of an OK event (associated to a normal reply), or an ERROR event (associated to an error reply/exception), into a given State Machine engine.

Template Parameters

EVENT	Type of OK event to trigger in case of OK reply.
EVENT_ERR	Type of ERROR event to trigger in case of ERROR reply.
FUT	Type of future for the reply.

Parameters

rep_future	Future associated to the reply and returned by MAL Client interface invocation.
sm	Reference to a State Machine adapter.

Returns

A token that can be used to check whether the request has been aborted or not.

RouteReplyWithTimeout()

template<class EVENT , class EVENT_TIMEOUT , class EVENT_ERR , class FUT >

CancellationToken rad::cii::RouteReplyWithTimeout	(	FUT &&	rep_future,
		rad::SMAdapter &	sm )

This function can be use to configure the injection of an OK event (associated to a normal reply), or an ERROR event (associated to an error reply/exception), or a TIMEOUT event (associated to the expiration of a timer associated with a request) into a given State Machine engine.

Template Parameters

EVENT	Type of OK event to trigger in case of OK reply.
EVENT_TIMEOUT	Type of TIMEOUT event to trigger in case of request time-out.
EVENT_ERR	Type of ERROR event to trigger in case of ERROR reply.
FUT	Type of future for the reply.

Parameters

rep_future	Future associated to the reply and returned by MAL Client interface invocation.
sm	Reference to a State Machine adapter.

Returns

A token that can be used to check whether the request has been aborted or not.