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

Outbound control item. More...

#include <control.hpp>

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

Public Member Functions

 OutboundControlItem (winss::NotOwningPtr< WaitMultiplexer > multiplexer, winss::NotOwningPtr< Control > control, winss::NotOwningPtr< winss::OutboundPipeClient > client, const std::vector< char > &commands, std::string name)
 
 OutboundControlItem (const OutboundControlItem &)=delete
 No copy. More...
 
 OutboundControlItem (OutboundControlItem &&)=delete
 No move. More...
 
void Init ()
 Initializes the outbound control item. More...
 
void Start ()
 Send the control sequence. More...
 
bool Completed () const
 Gets of the control item has completed sending the control sequence. More...
 
bool Connected ()
 Handler for pipe connected. More...
 
bool WriteComplete ()
 Handler for pipe write complete. More...
 
bool Disconnected ()
 Handler for pipe disconnected. More...
 
OutboundControlItemoperator= (const OutboundControlItem &)=delete
 No copy. More...
 
OutboundControlItemoperator= (OutboundControlItem &&)=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::PipeClientSendListener
virtual ~PipeClientSendListener ()
 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

Outbound control item.

Will send a control sequence over a pipe.

Constructor & Destructor Documentation

winss::OutboundControlItem::OutboundControlItem ( winss::NotOwningPtr< WaitMultiplexer multiplexer,
winss::NotOwningPtr< Control control,
winss::NotOwningPtr< winss::OutboundPipeClient client,
const std::vector< char > &  commands,
std::string  name 
)
winss::OutboundControlItem::OutboundControlItem ( const OutboundControlItem )
delete

No copy.

winss::OutboundControlItem::OutboundControlItem ( OutboundControlItem &&  )
delete

No move.

Member Function Documentation

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

Gets of the control item has completed sending the control sequence.

Returns
True if completed otherwise false.

Implements winss::ControlItem.

bool winss::OutboundControlItem::Connected ( )
virtual

Handler for pipe connected.

Returns
True always.

Implements winss::PipeClientConnectionListener.

References winss::ControlItem::name.

bool winss::OutboundControlItem::Disconnected ( )
virtual

Handler for pipe disconnected.

Returns
True always.

Implements winss::PipeClientConnectionListener.

References winss::ControlItem::name.

void winss::OutboundControlItem::Init ( )
virtual

Initializes the outbound control item.

Reimplemented from winss::ControlItem.

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

No copy.

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

No move.

void winss::OutboundControlItem::Start ( )
virtual

Send the control sequence.

Reimplemented from winss::ControlItem.

bool winss::OutboundControlItem::WriteComplete ( )
virtual

Handler for pipe write complete.

Returns
True always.

Implements winss::PipeClientSendListener.


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