winss
Public Member Functions | List of all members
winss::InboundPipeServerTmpl< TPipeInstance > Class Template Reference

An inbound pipe server. More...

#include <pipe_server.hpp>

Inheritance diagram for winss::InboundPipeServerTmpl< TPipeInstance >:
Inheritance graph
[legend]
Collaboration diagram for winss::InboundPipeServerTmpl< TPipeInstance >:
Collaboration graph
[legend]

Public Member Functions

 InboundPipeServerTmpl (const PipeServerConfig &config)
 
 InboundPipeServerTmpl (const InboundPipeServerTmpl &)=delete
 No copy. More...
 
 InboundPipeServerTmpl (InboundPipeServerTmpl &&)=delete
 No move. More...
 
virtual void AddListener (winss::NotOwningPtr< PipeServerReceiveListener > listener)
 Add a listener to the pipe server for receive events. More...
 
InboundPipeServerTmploperator= (const InboundPipeServerTmpl &)=delete
 No copy. More...
 
InboundPipeServerTmploperator= (InboundPipeServerTmpl &&)=delete
 No move. More...
 
- Public Member Functions inherited from winss::PipeServer< TPipeInstance >
 PipeServer (const PipeServerConfig &config)
 Create a new pipe instance with the given config. More...
 
 PipeServer (const PipeServer &)=delete
 No copy. More...
 
 PipeServer (PipeServer &&)=delete
 No move. More...
 
virtual bool IsAccepting () const
 Gets if the pipe server is accepting a new connection. More...
 
virtual bool IsStopping () const
 Gets if the pipe server is stopping. More...
 
virtual size_t InstanceCount () const
 Gets the current instance count. More...
 
PipeServeroperator= (const PipeServer &)=delete
 No copy. More...
 
PipeServeroperator= (PipeServer &&)=delete
 No move. More...
 
virtual ~PipeServer ()
 Disconnect all clients and close all connections. More...
 

Additional Inherited Members

- Protected Member Functions inherited from winss::PipeServer< TPipeInstance >
void StartClient ()
 Open a new named pipe for a new client to connect to. More...
 
void Stop ()
 Stop the pipe server. More...
 
void Triggered (const winss::HandleWrapper &handle)
 The event handler for the pipe server. More...
 
- Protected Attributes inherited from winss::PipeServer< TPipeInstance >
bool stopping = false
 Flag if the server is stopping. More...
 
bool open = false
 Flag if the server is open for connections. More...
 
std::map< winss::HandleWrapper, TPipeInstance > instances
 A mapping of handles to instances. More...
 
winss::NotOwningPtr< winss::WaitMultiplexermultiplexer
 The event multiplexer for the named pipe server. More...
 
winss::PipeName pipe_name
 The name of the pipe. More...
 

Detailed Description

template<typename TPipeInstance>
class winss::InboundPipeServerTmpl< TPipeInstance >

An inbound pipe server.

Template Parameters
TPipeInstanceThe named pipe instance implementation.

Constructor & Destructor Documentation

template<typename TPipeInstance >
winss::InboundPipeServerTmpl< TPipeInstance >::InboundPipeServerTmpl ( const PipeServerConfig config)
inlineexplicit
template<typename TPipeInstance >
winss::InboundPipeServerTmpl< TPipeInstance >::InboundPipeServerTmpl ( const InboundPipeServerTmpl< TPipeInstance > &  )
delete

No copy.

template<typename TPipeInstance >
winss::InboundPipeServerTmpl< TPipeInstance >::InboundPipeServerTmpl ( InboundPipeServerTmpl< TPipeInstance > &&  )
delete

No move.

Member Function Documentation

template<typename TPipeInstance >
virtual void winss::InboundPipeServerTmpl< TPipeInstance >::AddListener ( winss::NotOwningPtr< PipeServerReceiveListener listener)
inlinevirtual

Add a listener to the pipe server for receive events.

Referenced by winss::SuperviseController::SuperviseController(), and winss::SvScanController::SvScanController().

template<typename TPipeInstance >
InboundPipeServerTmpl& winss::InboundPipeServerTmpl< TPipeInstance >::operator= ( const InboundPipeServerTmpl< TPipeInstance > &  )
delete

No copy.

template<typename TPipeInstance >
InboundPipeServerTmpl& winss::InboundPipeServerTmpl< TPipeInstance >::operator= ( InboundPipeServerTmpl< TPipeInstance > &&  )
delete

No move.


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