winss
Public Member Functions | List of all members
winss::OutboundPipeClientTmpl< TInstance > Class Template Reference

An outbound pipe client. More...

#include <pipe_client.hpp>

Inheritance diagram for winss::OutboundPipeClientTmpl< TInstance >:
Inheritance graph
[legend]
Collaboration diagram for winss::OutboundPipeClientTmpl< TInstance >:
Collaboration graph
[legend]

Public Member Functions

 OutboundPipeClientTmpl (const PipeClientConfig &config)
 Creates an outbound pipe client with the given config. More...
 
 OutboundPipeClientTmpl (const OutboundPipeClientTmpl &)=delete
 No copy. More...
 
 OutboundPipeClientTmpl (OutboundPipeClientTmpl &&)=delete
 No move. More...
 
virtual bool Send (const std::vector< char > &data)
 Sends the given list of bytes to the pipe server. More...
 
OutboundPipeClientTmploperator= (const OutboundPipeClientTmpl &)=delete
 No copy. More...
 
OutboundPipeClientTmploperator= (OutboundPipeClientTmpl &&)=delete
 No move. More...
 
- Public Member Functions inherited from winss::PipeClient< TInstance, PipeClientSendListener >
 PipeClient (const PipeClientConfig &config)
 Creates a pipe client with the given config. More...
 
 PipeClient (const PipeClient &)=delete
 No copy. More...
 
 PipeClient (PipeClient &&)=delete
 No move. More...
 
virtual void AddListener (winss::NotOwningPtr< PipeClientSendListener > listener)
 Add a listener to the client. More...
 
virtual bool IsStopping () const
 Gets if the pipe client is stopping. More...
 
virtual void Connect ()
 Start the connection process to the pipe server. More...
 
virtual void Stop ()
 Stop the pipe client. More...
 
PipeClientoperator= (const PipeClient &)=delete
 No copy. More...
 
PipeClientoperator= (PipeClient &&)=delete
 No move. More...
 
virtual ~PipeClient ()
 Close the pipe client and notify listeners. More...
 

Additional Inherited Members

- Protected Member Functions inherited from winss::PipeClient< TInstance, PipeClientSendListener >
void Triggered (const winss::HandleWrapper &handle)
 Event handler for the pipe client. More...
 
void TellAll (const std::function< bool(PipeClientSendListener &)> &func)
 Call a function against all listeners. More...
 
- Protected Attributes inherited from winss::PipeClient< TInstance, PipeClientSendListener >
bool stopping
 
TInstance instance
 Marked if stopping the client. More...
 
winss::PipeName pipe_name
 The pipe instance. More...
 
winss::NotOwningPtr< winss::WaitMultiplexermultiplexer
 The event multiplexer for the pipe client. More...
 
std::vector< winss::NotOwningPtr< PipeClientSendListener > > listeners
 Listeners for the pipe client. More...
 

Detailed Description

template<typename TInstance>
class winss::OutboundPipeClientTmpl< TInstance >

An outbound pipe client.

Template Parameters
TInstanceThe named pipe instance implementation.

Constructor & Destructor Documentation

template<typename TInstance >
winss::OutboundPipeClientTmpl< TInstance >::OutboundPipeClientTmpl ( const PipeClientConfig config)
inlineexplicit

Creates an outbound pipe client with the given config.

Parameters
configThe pipe client confog.
template<typename TInstance >
winss::OutboundPipeClientTmpl< TInstance >::OutboundPipeClientTmpl ( const OutboundPipeClientTmpl< TInstance > &  )
delete

No copy.

template<typename TInstance >
winss::OutboundPipeClientTmpl< TInstance >::OutboundPipeClientTmpl ( OutboundPipeClientTmpl< TInstance > &&  )
delete

No move.

Member Function Documentation

template<typename TInstance >
OutboundPipeClientTmpl& winss::OutboundPipeClientTmpl< TInstance >::operator= ( const OutboundPipeClientTmpl< TInstance > &  )
delete

No copy.

template<typename TInstance >
OutboundPipeClientTmpl& winss::OutboundPipeClientTmpl< TInstance >::operator= ( OutboundPipeClientTmpl< TInstance > &&  )
delete

No move.

template<typename TInstance >
virtual bool winss::OutboundPipeClientTmpl< TInstance >::Send ( const std::vector< char > &  data)
inlinevirtual

Sends the given list of bytes to the pipe server.

If the client is in the process of sending data then it will be queued until it is free to write.

Returns
True if the data was written otherwise false.

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