winss::InboundControlItemListener Class Reference

A listener for inbound control item events. More...

#include <control.hpp>

Inheritance diagram for winss::InboundControlItemListener:

Public Member Functions
virtual bool	IsEnabled ()=0
	Gets if the listener is enabled. More...
virtual bool	CanStart ()=0
	Gets if the listener can start. More...
virtual void	HandleConnected ()
	Call back for connected event. More...
virtual bool	HandleReceived (const std::vector< char > &message)=0
	Call back for when a message is received. More...
virtual	~InboundControlItemListener ()
	Default destructor. More...

Detailed Description

A listener for inbound control item events.

Constructor & Destructor Documentation

virtual winss::InboundControlItemListener::~InboundControlItemListener ( )

inlinevirtual

Default destructor.

Member Function Documentation

virtual bool winss::InboundControlItemListener::CanStart ( )

pure virtual

Gets if the listener can start.

Returns

True if the listener can start otherwise false.

Implemented in winss::SuperviseStateListener.

virtual void winss::InboundControlItemListener::HandleConnected ( )

inlinevirtual

Call back for connected event.

Reimplemented in winss::SuperviseStateListener.

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

pure virtual

Call back for when a message is received.

Returns

True if still waiting on messages otherwise false.

Implemented in winss::SuperviseStateListener.

virtual bool winss::InboundControlItemListener::IsEnabled ( )

pure virtual

Gets if the listener is enabled.

Returns

True if enabled otherwise false.

Implemented in winss::SuperviseStateListener.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/stable/lib/winss/control.hpp