rad Namespace Reference

Namespaces
	cii
	core
	detail
	services
	utils

Classes
class	ActionCallback
class	ActionGroup
class	ActionMgr
class	AnyEvent
class	CoroActivity
class	DbAdapter
class	DbAdapterRedis
class	ErrorCategory
struct	EventInfo
class	EventT
class	Exception
	Base class for the exceptions thrown by RAD and its users. More...
class	ExecutorActivity
class	GuardCallback
class	Helper
struct	IncorrectEventType
class	Logger
class	LogInitializer
class	MsgHandler
class	MsgReplier
class	MsgRequest
class	MsgRequestor
struct	MsgRequestor2
class	MsgRequestorRaw
struct	MsgRequestorRaw2
class	PthreadActivity
class	Signal
class	SMAdapter
class	SMEvent
class	SMRequestor
class	SMRequestorRaw
class	SMSubscriber
class	StopSource
class	StopToken
class	ThreadActivity
class	ThreadBaseActivity
class	Timer
class	TopicHandler
class	TopicPub
class	TopicSub
class	TrsHealth
	Adapter for ptpmond's TRS Health status to the state machine. More...
struct	TrsHealthBadEventTrait
struct	TrsHealthGoodEventTrait
class	Utils

Typedefs
using	SharedEvent = std::shared_ptr< const AnyEvent >
using	UniqueEvent = std::unique_ptr< AnyEvent >
typedef std::list< scxml4cpp::Action * >	ActionList
typedef std::list< rad::ActionGroup * >	ActionGroupList
typedef std::list< scxml4cpp::Activity * >	ActivityList
using	TrsHealthBadEvent = rad::EventT< TrsHealthBadEventTrait >
using	TrsHealthGoodEvent = rad::EventT< TrsHealthGoodEventTrait >

Enumerations
enum	ErrorCodes { ErrorCodes::CANCELLED = 0, ErrorCodes::REPLY_TIMEOUT, ErrorCodes::DESERIALIZATION_ERR, ErrorCodes::UNKNOWN }
enum	LogLevel {   LOG_LEVEL_UNKNOWN = -1, LOG_LEVEL_ERROR = 0, LOG_LEVEL_WARNING, LOG_LEVEL_STATE,   LOG_LEVEL_EVENT, LOG_LEVEL_GUARD, LOG_LEVEL_ACTION, LOG_LEVEL_INFO,   LOG_LEVEL_DEBUG, LOG_LEVEL_DEBUG1, LOG_LEVEL_DEBUG2, LOG_LEVEL_DEBUG3,   LOG_LEVEL_DEBUG4, LOG_LEVEL_TRACE }

Functions
void	Assert (bool condition, const char *filename, const char *functionname, int linenumber)
std::ostream &	operator<< (std::ostream &os, const rad::Exception &e)
const ErrorCategory &	GetErrorCategory ()
std::error_code	make_error_code (rad::ErrorCodes e)
std::map< std::string, std::string >	GetDefaultLogProperties (const std::string &logsink_filename, const std::string &log_level="ERROR")
log4cplus::Logger &	GetLogger ()
log4cplus::Logger &	GetSmLogger ()
void	LogInitialize ()
void	LogConfigure (const std::string &filename="")
void	LogTraceFunction (const LogLevel level, const char *filename, const char *funcname, const int linenum)
void	LogFunction (const LogLevel level, const char *funcname, const std::string &a)
void	LogStateFunction (const std::string &a, const std::string &b)
void	LogEventFunction (const std::string &a)
template<typename EVENT >
EVENT::payload_t &	GetPayload (AnyEvent &ev)
template<typename EVENT >
EVENT::payload_t const &	GetPayload (AnyEvent const &ev)
template<typename EVENT >
EVENT::payload_t *	GetPayloadNothrow (AnyEvent &ev)
template<typename EVENT >
EVENT::payload_t const *	GetPayloadNothrow (AnyEvent const &ev)
template<typename EventType >
EventType	ParseRequestAndCreateEvent (const std::string &identity, const std::string &request_name, const void *msg, size_t msg_size)
template<typename EventType >
EventType	ParseTopicAndCreateEvent (const std::string &topic_name, const void *msg, size_t msg_size)
template<class T , class... Args>
std::shared_ptr< T >	MakeSharedFromTuple (std::tuple< Args... > &args)
template<typename T >
void	DefaultRequestRejectHandler (const rad::AnyEvent &event, const std::string &state)
template<typename EventType >
std::function< void(const std::string &, const std::string &, const void *, size_t)>	ReqProcessEvent (SMAdapter &sm)
template<typename EventType >
std::function< void(const std::string &, const void *, size_t)>	TopicProcessEvent (SMAdapter &sm)
template<typename EVENT >
const EVENT &	GetLastEvent (scxml4cpp::Context *c)
const rad::AnyEvent &	GetLastAnyEvent (scxml4cpp::Context *c)
template<typename EVENT >
EVENT::payload_t &	GetLastEventPayload (scxml4cpp::Context *c)
template<typename EVENT >
EVENT::payload_t const *	GetLastEventPayloadNothrow (scxml4cpp::Context *c)

Variables
const std::string	LOGGER_NAME = "rad"
const std::string	SM_LOGGER_NAME = "rad.sm"
const int	LOG_MAX_LEVEL = LOG_LEVEL_TRACE
const int	LOG_MAX_LEN = 2048
const int	LOG_TIMESTAMP_MAXLEN = 100

Typedef Documentation

ActionGroupList

typedef std::list<rad::ActionGroup*> rad::ActionGroupList

ActionList

typedef std::list<scxml4cpp::Action*> rad::ActionList

ActivityList

typedef std::list<scxml4cpp::Activity*> rad::ActivityList

SharedEvent

using rad::SharedEvent = typedef std::shared_ptr<const AnyEvent>

TrsHealthBadEvent

using rad::TrsHealthBadEvent = typedef rad::EventT<TrsHealthBadEventTrait>

TrsHealthGoodEvent

using rad::TrsHealthGoodEvent = typedef rad::EventT<TrsHealthGoodEventTrait>

UniqueEvent

using rad::UniqueEvent = typedef std::unique_ptr<AnyEvent>

Enumeration Type Documentation

ErrorCodes

enum rad::ErrorCodes

strong

Enumerator
CANCELLED
REPLY_TIMEOUT
DESERIALIZATION_ERR
UNKNOWN

LogLevel

enum rad::LogLevel

Enumerator
LOG_LEVEL_UNKNOWN
LOG_LEVEL_ERROR
LOG_LEVEL_WARNING
LOG_LEVEL_STATE
LOG_LEVEL_EVENT
LOG_LEVEL_GUARD
LOG_LEVEL_ACTION
LOG_LEVEL_INFO
LOG_LEVEL_DEBUG
LOG_LEVEL_DEBUG1
LOG_LEVEL_DEBUG2
LOG_LEVEL_DEBUG3
LOG_LEVEL_DEBUG4
LOG_LEVEL_TRACE

Function Documentation

Assert()

void rad::Assert	(	bool	condition,
		const char *	filename,
		const char *	functionname,
		int	linenumber
	)

This function logs a failed assertion when the condition parameter is false.

Parameters

[in]	condition	Condition to verify.
[in]	filename	Assertion's filename.
[in]	functionname	Assetions's function name.
[in]	linenumber	Assetions's line.

DefaultRequestRejectHandler()

template<typename T >

void rad::DefaultRequestRejectHandler	(	const rad::AnyEvent &	event,
		const std::string &	state
	)

This function can be used to send a "reject" reply to the originator of a request that cannot be handled in the current state.

Parameters

event	Event related to the incoming request.
state	Current state retrieved from the SM engine.

GetDefaultLogProperties()

std::map< std::string, std::string > rad::GetDefaultLogProperties	(	const std::string &	logsink_filename,
		const std::string &	log_level = "ERROR"
	)

Parameters

logsink_filename	Filename for the logsink appender.
log_level	Log level for the root logger, default is "ERROR" (possible values are "TRACE", "DEBUG", "INFO", "WARN", "ERROR").

Returns

The default log properties to be used by the application at start-up for configuration.

GetErrorCategory()

const ErrorCategory& rad::GetErrorCategory ( )

inline

GetLastAnyEvent()

const rad::AnyEvent & rad::GetLastAnyEvent

(

scxml4cpp::Context *

c

)

GetLastEvent()

template<typename EVENT >

const EVENT& rad::GetLastEvent

(

scxml4cpp::Context *

c

)

GetLastEventPayload()

template<typename EVENT >

EVENT::payload_t& rad::GetLastEventPayload

(

scxml4cpp::Context *

c

)

GetLastEventPayloadNothrow()

template<typename EVENT >

EVENT::payload_t const* rad::GetLastEventPayloadNothrow

(

scxml4cpp::Context *

c

)

GetLogger()

log4cplus::Logger & rad::GetLogger

(

)

Returns

the main RAD library logger ("rad").

GetPayload() [1/2]

template<typename EVENT >

EVENT::payload_t& rad::GetPayload

(

AnyEvent &

ev

)

Access the payload in a type-safe manner.

Returns

A reference to the payload if the EVENT matches the contained event.

Exceptions

IncorrectEventType

if EVENT does not match the contained event.

Example:

auto ev = make_event<MyEvent>(new std::string("hello world"));
auto& payload = ev.getPayload<MyEvent>();

GetPayload() [2/2]

template<typename EVENT >

EVENT::payload_t const& rad::GetPayload

(

AnyEvent const &

ev

)

Const version of getPayload();

GetPayloadNothrow() [1/2]

template<typename EVENT >

EVENT::payload_t* rad::GetPayloadNothrow

(

AnyEvent &

ev

)

Access the payload in a type-safe manner.

Returns

A pointer to the payload if the EVENT matches the contained event and nullptr otherwise.

Example:

auto ev = make_event<MyEvent>(new std::string("hello world"));
auto payload = ev.GetPayload<MyEvent>();

GetPayloadNothrow() [2/2]

template<typename EVENT >

EVENT::payload_t const* rad::GetPayloadNothrow

(

AnyEvent const &

ev

)

Const version of GetPayloadNothrow()

GetSmLogger()

log4cplus::Logger & rad::GetSmLogger

(

)

Returns

the RAD library logger specialized for the State Machine adapter ("rad.sm").

LogConfigure()

void rad::LogConfigure

(

const std::string &

filename = ""

)

LogEventFunction()

void rad::LogEventFunction ( const std::string &  a )

inline

LogFunction()

void rad::LogFunction ( const LogLevel  level, const char *  funcname, const std::string &  a  )

inline

LogInitialize()

void rad::LogInitialize

(

)

LogStateFunction()

void rad::LogStateFunction ( const std::string &  a, const std::string &  b  )

inline

LogTraceFunction()

void rad::LogTraceFunction ( const LogLevel  level, const char *  filename, const char *  funcname, const int  linenum  )

inline

make_error_code()

std::error_code rad::make_error_code ( rad::ErrorCodes  e )

inline

Overload the global make_error_code() free function with our custom enum.

MakeSharedFromTuple()

template<class T , class... Args>

std::shared_ptr<T> rad::MakeSharedFromTuple

(

std::tuple< Args... > &

args

)

operator<<()

std::ostream & rad::operator<<	(	std::ostream &	os,
		const rad::Exception &	e
	)

ParseRequestAndCreateEvent()

template<typename EventType >

EventType rad::ParseRequestAndCreateEvent	(	const std::string &	identity,
		const std::string &	request_name,
		const void *	msg,
		size_t	msg_size
	)

Parses a request and create the corresponding event.

Parameters

[in]	identity	Request identity.
[in]	request_name	Request name.
[in]	msg	Pointer to the payload.
[in]	msg_size	Size of the payload.

ParseTopicAndCreateEvent()

template<typename EventType >

EventType rad::ParseTopicAndCreateEvent	(	const std::string &	topic_name,
		const void *	msg,
		size_t	msg_size
	)

Parses a topic and create the corresponding event.

Parameters

[in]	topic_name	Topic name.
[in]	msg	Pointer to the payload.
[in]	msg_size	Size of the payload.

ReqProcessEvent()

template<typename EventType >

std::function<void(const std::string&, const std::string&, const void*, size_t)> rad::ReqProcessEvent

(

SMAdapter &

sm

)

Function that creates a request handler to forward events to the SM

TopicProcessEvent()

template<typename EventType >

std::function<void(const std::string&, const void*, size_t)> rad::TopicProcessEvent

(

SMAdapter &

sm

)

Function that creates a topic handler to forward events to the SM

Variable Documentation

LOG_MAX_LEN

const int rad::LOG_MAX_LEN = 2048

LOG_MAX_LEVEL

const int rad::LOG_MAX_LEVEL = LOG_LEVEL_TRACE

LOG_TIMESTAMP_MAXLEN

const int rad::LOG_TIMESTAMP_MAXLEN = 100

LOGGER_NAME

const std::string rad::LOGGER_NAME = "rad"

SM_LOGGER_NAME

const std::string rad::SM_LOGGER_NAME = "rad.sm"