winss::SuperviseStateListener Class Reference

A supervisor state listener which is race-condition free. More...

#include <state_listener.hpp>

Inheritance diagram for winss::SuperviseStateListener:

Collaboration diagram for winss::SuperviseStateListener:

Public Member Functions
	SuperviseStateListener (const winss::SuperviseStateFile &state_file, SuperviseStateListenerAction action)
	Supervise state listener constructor. More...
	SuperviseStateListener (const SuperviseStateListener &)=delete
	No copy. More...
	SuperviseStateListener (SuperviseStateListener &&)=delete
	No move. More...
bool	IsEnabled ()
	Gets if the listener is enabled. More...
bool	CanStart ()
	Gets if the listener can start. More...
void	HandleConnected ()
	Handle the connected event. More...
bool	HandleReceived (const std::vector< char > &message)
	Handle the received event. More...
SuperviseStateListener &	operator= (const SuperviseStateListener &)=delete
	No copy. More...
SuperviseStateListener &	operator= (SuperviseStateListener &&)=delete
	No move. More...
Public Member Functions inherited from winss::InboundControlItemListener
virtual	~InboundControlItemListener ()
	Default destructor. More...

Detailed Description

A supervisor state listener which is race-condition free.

Constructor & Destructor Documentation

winss::SuperviseStateListener::SuperviseStateListener	(	const winss::SuperviseStateFile &	state_file,
		winss::SuperviseStateListenerAction	action
	)

Supervise state listener constructor.

Parameters

state_file	The state file.
action	The action to listen for.

winss::SuperviseStateListener::SuperviseStateListener ( const SuperviseStateListener &  )

delete

No copy.

winss::SuperviseStateListener::SuperviseStateListener ( SuperviseStateListener &&  )

delete

No move.

Member Function Documentation

bool winss::SuperviseStateListener::CanStart ( )

virtual

Gets if the listener can start.

Returns

True if can start otherwise false.

Implements winss::InboundControlItemListener.

void winss::SuperviseStateListener::HandleConnected ( )

virtual

Handle the connected event.

Reimplemented from winss::InboundControlItemListener.

References winss::END, winss::FINISHED, winss::SuperviseStateFile::Read(), winss::RUN, winss::WAIT_DOWN, winss::WAIT_FINISHED, winss::WAIT_RESTART, and winss::WAIT_UP.

bool winss::SuperviseStateListener::HandleReceived ( const std::vector< char > &  message )

virtual

Handle the received event.

Parameters

[in]

message

The message that was received as a list of chars.

Implements winss::InboundControlItemListener.

References winss::SuperviseController::GetNotification().

bool winss::SuperviseStateListener::IsEnabled ( )

virtual

Gets if the listener is enabled.

Returns

True if enabled otherwise false.

Implements winss::InboundControlItemListener.

References winss::NO_WAIT.

SuperviseStateListener& winss::SuperviseStateListener::operator= ( const SuperviseStateListener &  )

delete

No copy.

SuperviseStateListener& winss::SuperviseStateListener::operator= ( SuperviseStateListener &&  )

delete

No move.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/stable/lib/winss/supervise/state_listener.hpp
• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/stable/lib/winss/supervise/state_listener.cpp