#include <actionsStd.hpp>

Inheritance diagram for server::ActionsStd:

Public Member Functions
	ActionsStd (boost::asio::io_context &ios, rad::SMAdapter &sm, rad::MsgReplier &msg_replier, DataContext &data)

void	notifyEvent (scxml4cpp::Event *event)

void	notifyStatus (std::list< scxml4cpp::State * > &status)

void	Status (scxml4cpp::Context *c)

void	Status2 (scxml4cpp::Context *c)

void	Stop (scxml4cpp::Context *c)

void	Init (scxml4cpp::Context *c)

void	Enable (scxml4cpp::Context *c)

void	Disable (scxml4cpp::Context *c)

void	Reset (scxml4cpp::Context *c)

void	Config (scxml4cpp::Context *c)

void	SetLogLevel (scxml4cpp::Context *c)

void	Exit (scxml4cpp::Context *c)

void	ExitNoReply (scxml4cpp::Context *c)

void	Pong (scxml4cpp::Context *c)

	ActionsStd (const ActionsStd &)=delete

ActionsStd &	operator= (const ActionsStd &)=delete
	Disable copy constructor.

Public Member Functions inherited from rad::ActionGroup
	ActionGroup (const std::string &id)

virtual	~ActionGroup ()

const std::string &	GetId () const

void	SetId (const std::string &id)

	ActionGroup (const ActionGroup &)=delete

ActionGroup &	operator= (const ActionGroup &)=delete
	Disable copy constructor.

Public Member Functions inherited from scxml4cpp::StatusListener
	StatusListener ()

virtual	~StatusListener ()

Public Member Functions inherited from scxml4cpp::EventListener
	EventListener ()

virtual	~EventListener ()

Detailed Description

This class contains the implementation of the actions dealing with the following "standard" commands:

ReqExit
ReqStatus
ReqReset
ReqStop
ReqInit
ReqConfig
ReqEnable
ReqDisable

and the following signals:

SIGINT
SIGTERM

In addition it implements the:

scxml4cpp::StatusListener interface to receive the notification of change of state from the State Machine engine.
rad::EventRejectListener interface to receive the notification of rejected event from the State Machine adapter.

Constructor & Destructor Documentation

◆ ActionsStd() [1/2]

server::ActionsStd::ActionsStd	(	boost::asio::io_context &	ios,
		rad::SMAdapter &	sm,
		rad::MsgReplier &	msg_replier,
		DataContext &	data )

Constructor.

Parameters

[in]	ios	Reference to the event loop.
[in]	sm	Reference to the SM adapter used to trigger events.
[in]	msg_replier	Helper class to reply to incoming requests.
[in]	data	Data shared within the application among actions and activities.

◆ ActionsStd() [2/2]

server::ActionsStd::ActionsStd ( const ActionsStd & )

delete

Member Function Documentation

◆ Config()

void server::ActionsStd::Config ( scxml4cpp::Context * c )

Implementation of the Config action. This action:

reload the application configuration file,
re-establish connection to the Runtime-DB,
replies back for the originator of the ReqConfig request.

Parameters

[in] event Last event received which should be a Config event (the Config event is triggered by a ReqConfig request).

◆ Disable()

void server::ActionsStd::Disable ( scxml4cpp::Context * c )

Implementation of the Disable action. This action:

replies back for the originator of the ReqDisable request.

Parameters

[in] event Last event received which should be a Stop event (the Disable event is triggered by a ReqDisable request).

◆ Enable()

void server::ActionsStd::Enable ( scxml4cpp::Context * c )

Implementation of the Enable action. This action:

replies back for the originator of the ReqEnable request.

Parameters

[in] event Last event received which should be a Stop event (the Enable event is triggered by a ReqEnable request).

◆ Exit()

void server::ActionsStd::Exit ( scxml4cpp::Context * c )

Implementation of the Exit action. This action:

replies back for the originator of the ReqExit request.
stops the event loop.

Parameters

[in] event Last event received which should be an Exit event (the Exit event is triggered by a ReqExit request).

◆ ExitNoReply()

void server::ActionsStd::ExitNoReply ( scxml4cpp::Context * c )

Implementation of the ExitNoReply action. This action:

stops the event loop.

Parameters

[in] event Last event received which should be an ExitNoReply event (the ExitNoReply event is triggered by a SIGTERM, SIGINT signals).

◆ Init()

void server::ActionsStd::Init ( scxml4cpp::Context * c )

Implementation of the Init action. This action:

re-initialize the application run-time data,
replies back for the originator of the ReqInit request.

Parameters

[in] event Last event received which should be a Init event (the Init event is triggered by a ReqInit request).

◆ notifyEvent()

void server::ActionsStd::notifyEvent ( scxml4cpp::Event * event )

virtual

Implementation of the scxml4cpp::EventListener interface to know when an event has been rejected/ignored/processed. It can be used to implement the event reject policy.

Parameters

[in] event Rejected event.

Implements scxml4cpp::EventListener.

◆ notifyStatus()

void server::ActionsStd::notifyStatus ( std::list< scxml4cpp::State * > & status )

virtual

Implementation of the scxml4cpp::StatusListener interface to receive the change of state notification.

Parameters

[in] status Current State Machine active states configuration.

Implements scxml4cpp::StatusListener.

◆ operator=()

ActionsStd & server::ActionsStd::operator= ( const ActionsStd & )

delete

Disable copy constructor.

◆ Pong()

void server::ActionsStd::Pong ( scxml4cpp::Context * c )

Implementation of the Pong action. This action:

replies back for the originator of the ReqTest request with the pong message.

Parameters

[in] event Last event received which should be a Ping event (the Ping event is triggered by a ReqTest request).

◆ Reset()

void server::ActionsStd::Reset ( scxml4cpp::Context * c )

Implementation of the Reset action. This action:

replies back for the originator of the ReqReset request.

Parameters

[in] event Last event received which should be a Stop event (the Disable event is triggered by a ReqReset request).

◆ SetLogLevel()

void server::ActionsStd::SetLogLevel ( scxml4cpp::Context * c )

Implementation of the SetLogLevel action. This action:

changes the log level,
replies back for the originator of the ReqSetLogLevel request.

Parameters

[in] event Last event received which should be a SetLogLevel event (the SetLogLevel event is triggered by a ReqSetLogLevel request).

◆ Status()

void server::ActionsStd::Status ( scxml4cpp::Context * c )

Implementation of the Status action. This action:

replies back for the originator of the ReqStatus request with the current State Machine active state configuration.

Parameters

[in] event Last event received which should be a Status event (the Status event is triggered by a ReqStatus request).

◆ Status2()

void server::ActionsStd::Status2 ( scxml4cpp::Context * c )

Implementation of the Status2 action. This action:

replies back for the originator of the ReqStatus request with a dummy text to differentiate from the original Status action.

Parameters

[in] event Last event received which should be a Status2 event (the Status2 event is triggered by a ReqStatus2 request).

◆ Stop()

void server::ActionsStd::Stop ( scxml4cpp::Context * c )

Implementation of the Stop action. This action:

replies back for the originator of the ReqStop request.

Parameters

[in] event Last event received which should be a Stop event (the Stop event is triggered by a ReqStop request).

The documentation for this class was generated from the following files:

rad/cpp/_examples/server/src/actionsStd.hpp
rad/cpp/_examples/server/src/actionsStd.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ActionsStd() [1/2]

◆ ActionsStd() [2/2]

Member Function Documentation

◆ Config()

◆ Disable()

◆ Enable()

◆ Exit()

◆ ExitNoReply()

◆ Init()

◆ notifyEvent()

◆ notifyStatus()

◆ operator=()

◆ Pong()

◆ Reset()

◆ SetLogLevel()

◆ Status()

◆ Status2()

◆ Stop()