winss
Public Member Functions | List of all members
winss::InboundControlItem Class Reference

Inbound control item. More...

#include <control.hpp>

Inheritance diagram for winss::InboundControlItem:
Inheritance graph
[legend]
Collaboration diagram for winss::InboundControlItem:
Collaboration graph
[legend]

Public Member Functions

 InboundControlItem (winss::NotOwningPtr< WaitMultiplexer > multiplexer, winss::NotOwningPtr< Control > control, winss::NotOwningPtr< winss::InboundPipeClient > client, winss::NotOwningPtr< InboundControlItemListener > listener, std::string name)
 
 InboundControlItem (const InboundControlItem &)=delete
 No copy. More...
 
 InboundControlItem (InboundControlItem &&)=delete
 No move. More...
 
void Init ()
 Initializes the inbound control item. More...
 
void Start ()
 Start waiting for inbound events. More...
 
bool Completed () const
 Gets of the control item has completed reading the state/events. More...
 
bool Connected ()
 Handler for pipe connected. More...
 
bool Received (const std::vector< char > &message)
 Handler for pipe connected. More...
 
bool Disconnected ()
 Handler for pipe disconnected. More...
 
InboundControlItemoperator= (const InboundControlItem &)=delete
 No copy. More...
 
InboundControlItemoperator= (InboundControlItem &&)=delete
 No move. More...
 
- Public Member Functions inherited from winss::ControlItem
virtual const std::string & GetName () const
 Gets the name of the control item. More...
 
virtual ~ControlItem ()
 Default destructor. More...
 
- Public Member Functions inherited from winss::PipeClientReceiveListener
virtual ~PipeClientReceiveListener ()
 Default destructor. More...
 
- Public Member Functions inherited from winss::PipeClientConnectionListener
virtual ~PipeClientConnectionListener ()
 Default destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from winss::ControlItem
 ControlItem (std::string name)
 Constructs a control item with the given name. More...
 
- Protected Attributes inherited from winss::ControlItem
const std::string name
 The name of the control item. More...
 

Detailed Description

Inbound control item.

Will wait for the condition on the remote pipe server is met.

Constructor & Destructor Documentation

winss::InboundControlItem::InboundControlItem ( winss::NotOwningPtr< WaitMultiplexer multiplexer,
winss::NotOwningPtr< Control control,
winss::NotOwningPtr< winss::InboundPipeClient client,
winss::NotOwningPtr< InboundControlItemListener listener,
std::string  name 
)
winss::InboundControlItem::InboundControlItem ( const InboundControlItem )
delete

No copy.

winss::InboundControlItem::InboundControlItem ( InboundControlItem &&  )
delete

No move.

Member Function Documentation

bool winss::InboundControlItem::Completed ( ) const
virtual

Gets of the control item has completed reading the state/events.

Returns
True if completed otherwise false.

Implements winss::ControlItem.

bool winss::InboundControlItem::Connected ( )
virtual

Handler for pipe connected.

Returns
True always.

Implements winss::PipeClientConnectionListener.

References winss::ControlItem::name.

bool winss::InboundControlItem::Disconnected ( )
virtual

Handler for pipe disconnected.

Returns
True always.

Implements winss::PipeClientConnectionListener.

References winss::ControlItem::name.

void winss::InboundControlItem::Init ( )
virtual

Initializes the inbound control item.

Reimplemented from winss::ControlItem.

InboundControlItem& winss::InboundControlItem::operator= ( const InboundControlItem )
delete

No copy.

InboundControlItem& winss::InboundControlItem::operator= ( InboundControlItem &&  )
delete

No move.

bool winss::InboundControlItem::Received ( const std::vector< char > &  message)
virtual

Handler for pipe connected.

Returns
True if the handler has finished otherwise false.

Implements winss::PipeClientReceiveListener.

void winss::InboundControlItem::Start ( )
virtual

Start waiting for inbound events.

Reimplemented from winss::ControlItem.


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