server::ActionsStd Class Reference

#include <actionsStd.hpp>

Inheritance diagram for server::ActionsStd:

Public Member Functions
	ActionsStd (boost::asio::io_service &ios, rad::Dispatcher &dispatcher, rad::MsgReplier &msg_replier, DataContext &data)
void	notifyEvent (scxml4cpp::Event *event)
void	notifyStatus (std::set< scxml4cpp::State * > &status)
void	Status (const rad::AnyEvent &last_event)
void	Stop (const rad::AnyEvent &last_event)
void	Init (const rad::AnyEvent &last_event)
void	Enable (const rad::AnyEvent &last_event)
void	Disable (const rad::AnyEvent &last_event)
void	Reset (const rad::AnyEvent &last_event)
void	Config (const rad::AnyEvent &last_event)
void	SetLog (const rad::AnyEvent &last_event)
void	Exit (const rad::AnyEvent &last_event)
void	ExitNoReply (const rad::AnyEvent &last_event)
	ActionsStd (const ActionsStd &)=delete
ActionsStd &	operator= (const ActionsStd &)=delete
	Disable copy constructor. More...
	ActionsStd (boost::asio::io_service &ios, rad::Dispatcher &dispatcher, rad::MsgReplier &msgReplier, DataContext &data)
void	notifyEvent (scxml4cpp::Event *event)
void	notifyStatus (std::set< scxml4cpp::State * > &status)
void	Status (rad::AnyEvent const &lastEvent)
void	Stop (rad::AnyEvent const &lastEvent)
void	Init (rad::AnyEvent const &lastEvent)
void	Enable (rad::AnyEvent const &lastEvent)
void	Disable (rad::AnyEvent const &lastEvent)
void	Reset (rad::AnyEvent const &lastEvent)
void	Config (rad::AnyEvent const &lastEvent)
void	SetLog (rad::AnyEvent const &lastEvent)
void	Exit (rad::AnyEvent const &lastEvent)
void	ExitNoReply (rad::AnyEvent const &lastEvent)
void	Pong (rad::AnyEvent const &lastEvent)
	ActionsStd (const ActionsStd &)=delete
ActionsStd &	operator= (const ActionsStd &)=delete
	Disable copy constructor. More...
	ActionsStd (boost::asio::io_service &ios, rad::Dispatcher &dispatcher, rad::MsgReplier &msg_replier, DataContext &data)
void	notifyEvent (scxml4cpp::Event *event)
void	notifyStatus (std::set< scxml4cpp::State * > &status)
void	Status (const rad::AnyEvent &last_event)
void	Stop (const rad::AnyEvent &last_event)
void	Init (const rad::AnyEvent &last_event)
void	Enable (const rad::AnyEvent &last_event)
void	Disable (const rad::AnyEvent &last_event)
void	Reset (const rad::AnyEvent &last_event)
void	Config (const rad::AnyEvent &last_event)
void	SetLog (const rad::AnyEvent &last_event)
void	Exit (const rad::AnyEvent &last_event)
void	ExitNoReply (const rad::AnyEvent &last_event)
	ActionsStd (const ActionsStd &)=delete
ActionsStd &	operator= (const ActionsStd &)=delete
	Disable copy constructor. More...
	ActionsStd (boost::asio::io_service &ios, rad::Dispatcher &dispatcher, rad::MsgReplier &msgReplier, DataContext &data)
void	notifyEvent (scxml4cpp::Event *event)
void	notifyStatus (std::set< scxml4cpp::State * > &status)
void	Status (rad::AnyEvent const &lastEvent)
void	Stop (rad::AnyEvent const &lastEvent)
void	Init (rad::AnyEvent const &lastEvent)
void	Enable (rad::AnyEvent const &lastEvent)
void	Disable (rad::AnyEvent const &lastEvent)
void	Reset (rad::AnyEvent const &lastEvent)
void	Config (rad::AnyEvent const &lastEvent)
void	SetLog (rad::AnyEvent const &lastEvent)
void	Exit (rad::AnyEvent const &lastEvent)
void	ExitNoReply (rad::AnyEvent const &lastEvent)
void	Pong (rad::AnyEvent const &lastEvent)
	ActionsStd (const ActionsStd &)=delete
ActionsStd &	operator= (const ActionsStd &)=delete
	Disable copy constructor. More...
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. More...
	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. More...
	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. More...
Public Member Functions inherited from scxml4cpp::StatusListener
	StatusListener ()
virtual	~StatusListener ()
	StatusListener ()
virtual	~StatusListener ()
	StatusListener ()
virtual	~StatusListener ()
Public Member Functions inherited from scxml4cpp::EventListener
	EventListener ()
virtual	~EventListener ()
	EventListener ()
virtual	~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

server::ActionsStd::ActionsStd	(	boost::asio::io_service &	ios,
		rad::Dispatcher &	dispatcher,
		rad::MsgReplier &	msgReplier,
		DataContext &	data
	)

Constructor.

Parameters

[in]	ios	Reference to the event loop.
[in]	dispatcher	Reference to the event dispatcher.
[in]	msgReplier	Helper class to reply to incoming requests.
[in]	data	Data shared within the application among actions and activities.

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

delete

server::ActionsStd::ActionsStd	(	boost::asio::io_service &	ios,
		rad::Dispatcher &	dispatcher,
		rad::MsgReplier &	msgReplier,
		DataContext &	data
	)

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

delete

server::ActionsStd::ActionsStd	(	boost::asio::io_service &	ios,
		rad::Dispatcher &	dispatcher,
		rad::MsgReplier &	msg_replier,
		DataContext &	data
	)

Constructor.

Parameters

[in]	ios	Reference to the event loop.
[in]	dispatcher	Reference to the event dispatcher.
[in]	msgReplier	Helper class to reply to incoming requests.
[in]	data	Data shared within the application among actions and activities.

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

delete

server::ActionsStd::ActionsStd	(	boost::asio::io_service &	ios,
		rad::Dispatcher &	dispatcher,
		rad::MsgReplier &	msgReplier,
		DataContext &	data
	)

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

delete

Member Function Documentation

void server::ActionsStd::Config

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Config

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Config

(

const rad::AnyEvent &

last_event

)

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]

lastEvent

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

void server::ActionsStd::Config

(

const rad::AnyEvent &

last_event

)

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]

lastEvent

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

void server::ActionsStd::Disable

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Disable

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Disable

(

const rad::AnyEvent &

last_event

)

Implementation of the Disable action. This action:

• replies back for the originator of the ReqDisable request.

Parameters

[in]

lastEvent

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

void server::ActionsStd::Disable

(

const rad::AnyEvent &

last_event

)

Implementation of the Disable action. This action:

• replies back for the originator of the ReqDisable request.

Parameters

[in]

lastEvent

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

void server::ActionsStd::Enable

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Enable

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Enable

(

const rad::AnyEvent &

last_event

)

Implementation of the Enable action. This action:

• replies back for the originator of the ReqEnable request.

Parameters

[in]

lastEvent

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

void server::ActionsStd::Enable

(

const rad::AnyEvent &

last_event

)

Implementation of the Enable action. This action:

• replies back for the originator of the ReqEnable request.

Parameters

[in]

lastEvent

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

void server::ActionsStd::Exit

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Exit

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Exit

(

const rad::AnyEvent &

last_event

)

Implementation of the Exit action. This action:

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

Parameters

[in]

lastEvent

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

void server::ActionsStd::Exit

(

const rad::AnyEvent &

last_event

)

Implementation of the Exit action. This action:

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

Parameters

[in]

lastEvent

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

void server::ActionsStd::ExitNoReply

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::ExitNoReply

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::ExitNoReply

(

const rad::AnyEvent &

last_event

)

Implementation of the ExitNoReply action. This action:

• stops the event loop.

Parameters

[in]

lastEvent

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

void server::ActionsStd::ExitNoReply

(

const rad::AnyEvent &

last_event

)

Implementation of the ExitNoReply action. This action:

• stops the event loop.

Parameters

[in]

lastEvent

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

void server::ActionsStd::Init

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Init

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Init

(

const rad::AnyEvent &

last_event

)

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]

lastEvent

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

void server::ActionsStd::Init

(

const rad::AnyEvent &

last_event

)

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]

lastEvent

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

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

virtual

Implements scxml4cpp::EventListener.

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

virtual

Implements scxml4cpp::EventListener.

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

virtual

Implementation of the rad::EventRejectListener interface to know when an event has been rejected (i.e. does not trigger any transition). It is used to implement the event reject policy.

Parameters

[in]

event

Rejected event.

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.

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

virtual

Implementation of the rad::EventRejectListener interface to know when an event has been rejected (i.e. does not trigger any transition). It is used to implement the event reject policy.

Parameters

[in]

event

Rejected event.

Implements scxml4cpp::EventListener.

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

virtual

Implements scxml4cpp::StatusListener.

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

virtual

Implements scxml4cpp::StatusListener.

void server::ActionsStd::notifyStatus ( std::set< 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.

void server::ActionsStd::notifyStatus ( std::set< 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.

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

delete

Disable copy constructor.

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

delete

Disable copy constructor.

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

delete

Disable copy constructor.

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

delete

Disable copy constructor.

void server::ActionsStd::Pong

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Pong

(

rad::AnyEvent const &

lastEvent

)

Implementation of the Pong action. This action:

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

Parameters

[in]

lastEvent

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

void server::ActionsStd::Reset

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Reset

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Reset

(

const rad::AnyEvent &

last_event

)

Implementation of the Reset action. This action:

• replies back for the originator of the ReqReset request.

Parameters

[in]

lastEvent

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

void server::ActionsStd::Reset

(

const rad::AnyEvent &

last_event

)

Implementation of the Reset action. This action:

• replies back for the originator of the ReqReset request.

Parameters

[in]

lastEvent

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

void server::ActionsStd::SetLog

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::SetLog

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::SetLog

(

const rad::AnyEvent &

last_event

)

Implementation of the SetLog action. This action:

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

Parameters

[in]

lastEvent

Last event received which should be a SetLog event (the SetLog event is triggered by a ReqSetLog request).

void server::ActionsStd::SetLog

(

const rad::AnyEvent &

last_event

)

Implementation of the SetLog action. This action:

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

Parameters

[in]

lastEvent

Last event received which should be a SetLog event (the SetLog event is triggered by a ReqSetLog request).

void server::ActionsStd::Status

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Status

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Status

(

const rad::AnyEvent &

last_event

)

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]

lastEvent

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

void server::ActionsStd::Status

(

const rad::AnyEvent &

last_event

)

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]

lastEvent

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

void server::ActionsStd::Stop

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Stop

(

rad::AnyEvent const &

lastEvent

)

void server::ActionsStd::Stop

(

const rad::AnyEvent &

last_event

)

Implementation of the Stop action. This action:

• replies back for the originator of the ReqStop request.

Parameters

[in]

lastEvent

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

void server::ActionsStd::Stop

(

const rad::AnyEvent &

last_event

)

Implementation of the Stop action. This action:

• replies back for the originator of the ReqStop request.

Parameters

[in]

lastEvent

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:

• INTROOT/sources/ocf/ocm/server/src/actionsStd.hpp
• INTROOT/sources/tools/rad/cpp/_examples/server/src/ActionsStd.hpp
• ocf/ocm/server/src/actionsStd.hpp
• tools/rad/cpp/_examples/server/src/ActionsStd.hpp
• INTROOT/sources/ocf/ocm/server/src/actionsStd.cpp
• INTROOT/sources/tools/rad/cpp/_examples/server/src/ActionsStd.cpp
• ocf/ocm/server/src/actionsStd.cpp
• tools/rad/cpp/_examples/server/src/ActionsStd.cpp