sup::syssup::common::ActionsStd Class Reference

#include <actionsStd.hpp>

Inheritance diagram for sup::syssup::common::ActionsStd:

Public Member Functions
	ActionsStd (boost::asio::io_service &ios, rad::SMAdapter &sm, DataContext &data, SubsysFacade &subsys_facade)
void	notifyEvent (scxml4cpp::Event *e)
void	notifyStatus (std::list< scxml4cpp::State * > &status)
void	GetState (scxml4cpp::Context *c)
	ActionsStd. More...
void	GetStatus (scxml4cpp::Context *c)
void	GetVersion (scxml4cpp::Context *c)
void	SubsysStatus (scxml4cpp::Context *c)
void	SubsysNames (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	GetConfig (scxml4cpp::Context *c)
void	SetConfig (scxml4cpp::Context *c)
void	SetObMode (scxml4cpp::Context *c)
void	SetOpMode (scxml4cpp::Context *c)
void	Setup (scxml4cpp::Context *c)
void	SetLogLevel (scxml4cpp::Context *c)
void	Exit (scxml4cpp::Context *c)
void	ExitNoReply (scxml4cpp::Context *c)
void	SignalUsr1 (scxml4cpp::Context *c)
void	Ignore (scxml4cpp::Context *c)
	Implementation of the Ignore action. More...
void	StopIgn (scxml4cpp::Context *c)
void	SubsysReset (scxml4cpp::Context *c)
void	SubsysInit (scxml4cpp::Context *c)
void	SubsysEnable (scxml4cpp::Context *c)
void	SubsysDisable (scxml4cpp::Context *c)
	ActionsStd (const ActionsStd &)=delete
ActionsStd &	operator= (const ActionsStd &)=delete
	Disable copy constructor. More...

Detailed Description

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

• ReqExit
• ReqStatus
• ReqGetSubsysNames
• 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]

sup::syssup::common::ActionsStd::ActionsStd	(	boost::asio::io_service &	ios,
		rad::SMAdapter &	sm,
		DataContext &	data,
		SubsysFacade &	subsys_facade
	)

Constructor.

Parameters

[in]	ios	Reference to the event loop.
[in]	sm	State machine reference
[in]	data	Data shared within the application among actions and activities.
[in]	subsys_facade	Subsys facade reference

ActionsStd() [2/2]

sup::syssup::common::ActionsStd::ActionsStd ( const ActionsStd &  )

delete

Member Function Documentation

Config()

void sup::syssup::common::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]

c

Last event received which should be a Config event

Disable()

void sup::syssup::common::ActionsStd::Disable

(

scxml4cpp::Context *

c

)

Implementation of the Disable action. This action:

• replies back for the originator of the ReqDisable request.

Parameters

[in]

c

Last event received which should be a Stop event

Enable()

void sup::syssup::common::ActionsStd::Enable

(

scxml4cpp::Context *

c

)

Implementation of the Enable action. This action:

• replies back for the originator of the ReqEnable request.

Parameters

[in]

c

Last event received which should be a Stop event

Exit()

void sup::syssup::common::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]

c

Last event received which should be an Exit event

ExitNoReply()

void sup::syssup::common::ActionsStd::ExitNoReply

(

scxml4cpp::Context *

c

)

Implementation of the ExitNoReply action. This action:

• stops the event loop.

Parameters

[in]

c

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

GetConfig()

void sup::syssup::common::ActionsStd::GetConfig

(

scxml4cpp::Context *

c

)

Parameters

[in]

c

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

GetState()

void sup::syssup::common::ActionsStd::GetState

(

scxml4cpp::Context *

c

)

ActionsStd.

Returns

The last status notified by the State Machine. Implementation of the State action. This action:

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

Parameters

[in]

c

Last event received which should be a State event

GetStatus()

void sup::syssup::common::ActionsStd::GetStatus

(

scxml4cpp::Context *

c

)

GetVersion()

void sup::syssup::common::ActionsStd::GetVersion

(

scxml4cpp::Context *

c

)

Ignore()

void sup::syssup::common::ActionsStd::Ignore

(

scxml4cpp::Context *

c

)

Implementation of the Ignore action.

Parameters

[in]

c

Last event received which should be a Ignore event

Ignore from the configuration one or more subsyss managed by the server. When a subsys is ignored, it will not forward commands to its controller and the server will ignore its state.

Init()

void sup::syssup::common::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]

c

Last event received which should be a Init event

notifyEvent()

void sup::syssup::common::ActionsStd::notifyEvent

(

scxml4cpp::Event *

e

)

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]

e

Received event.

notifyStatus()

void sup::syssup::common::ActionsStd::notifyStatus

(

std::list< scxml4cpp::State * > &

status

)

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

Parameters

[in]

status

Current State Machine active states configuration.

operator=()

ActionsStd& sup::syssup::common::ActionsStd::operator= ( const ActionsStd &  )

delete

Disable copy constructor.

Reset()

void sup::syssup::common::ActionsStd::Reset

(

scxml4cpp::Context *

c

)

Implementation of the Reset action. This action:

• replies back for the originator of the ReqReset request.

Parameters

[in]

c

Last event received which should be a Stop event

SetConfig()

void sup::syssup::common::ActionsStd::SetConfig

(

scxml4cpp::Context *

c

)

Parameters

[in]

c

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

SetLogLevel()

void sup::syssup::common::ActionsStd::SetLogLevel

(

scxml4cpp::Context *

c

)

Implementation of the SetLog action. This action:

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

Parameters

[in]

c

Last event received which should be a SetLog event

SetObMode()

void sup::syssup::common::ActionsStd::SetObMode

(

scxml4cpp::Context *

c

)

Parameters

[in]

c

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

SetOpMode()

void sup::syssup::common::ActionsStd::SetOpMode

(

scxml4cpp::Context *

c

)

Parameters

[in]

c

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

Setup()

void sup::syssup::common::ActionsStd::Setup

(

scxml4cpp::Context *

c

)

Implementation of the Setup action.

Parameters

[in]

c

Last event received which should be a Setup event

SignalUsr1()

void sup::syssup::common::ActionsStd::SignalUsr1

(

scxml4cpp::Context *

c

)

Implementation of the SignalUsr1 action.

Parameters

[in]

c

Last event received which should be an ExitNoReply event (the SignalUsr1 event is triggered by a SIGUSR1 signal).

Stop()

void sup::syssup::common::ActionsStd::Stop

(

scxml4cpp::Context *

c

)

Implementation of the Stop action. This action:

• replies back for the originator of the ReqStop request.

Parameters

[in]

c

Last event received which should be a Stop event

StopIgn()

void sup::syssup::common::ActionsStd::StopIgn

(

scxml4cpp::Context *

c

)

Implementation of the StopIgn action.

Parameters

[in]

c

Last event received which should be a StopIgn event

SubsysDisable()

void sup::syssup::common::ActionsStd::SubsysDisable

(

scxml4cpp::Context *

c

)

Implementation of the SubsysDisable action. This action triggers a disable of a set of subsystems.

Parameters

[in]

c

Last event received.

SubsysEnable()

void sup::syssup::common::ActionsStd::SubsysEnable

(

scxml4cpp::Context *

c

)

Implementation of the SubsysEnable action. This action triggers a enable of a set of subsystems.

Parameters

[in]

c

Last event received.

SubsysInit()

void sup::syssup::common::ActionsStd::SubsysInit

(

scxml4cpp::Context *

c

)

Implementation of the SubsysInit action. This action triggers a init of a set of subsystems.

Parameters

[in]

c

Last event received.

SubsysNames()

void sup::syssup::common::ActionsStd::SubsysNames

(

scxml4cpp::Context *

c

)

Implementation of the DevNames action. This action:

• replies back for the originator of the request with the list of subsyss managed by the server.

Parameters

[in]

c

Last event received which should be a DevNames event

SubsysReset()

void sup::syssup::common::ActionsStd::SubsysReset

(

scxml4cpp::Context *

c

)

Implementation of the SubsysReset action. This action triggers a reset of a set of subsystems.

Parameters

[in]

c

Last event received.

SubsysStatus()

void sup::syssup::common::ActionsStd::SubsysStatus

(

scxml4cpp::Context *

c

)

Implementation of the Status action. This action:

• replies back for the originator of the request with the status of each subsys requested.

Parameters

[in]

c

Last event received which should be a Status event

---

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

• syssup/common/src/include/ifw/sup/syssup/common/actionsStd.hpp
• syssup/common/src/actionsStd.cpp