winss::InboundPipeClientTmpl< TInstance > Class Template Reference

An inbound pipe client. More...

#include <pipe_client.hpp>

Inheritance diagram for winss::InboundPipeClientTmpl< TInstance >:

Collaboration diagram for winss::InboundPipeClientTmpl< TInstance >:

Public Member Functions
	InboundPipeClientTmpl (const PipeClientConfig &config)
	Creates an inbound pipe client with the given config. More...
	InboundPipeClientTmpl (const InboundPipeClientTmpl &)=delete
	No copy. More...
	InboundPipeClientTmpl (InboundPipeClientTmpl &&)=delete
	No move. More...
InboundPipeClientTmpl &	operator= (const InboundPipeClientTmpl &)=delete
	No copy. More...
InboundPipeClientTmpl &	operator= (InboundPipeClientTmpl &&)=delete
	No move. More...
Public Member Functions inherited from winss::PipeClient< TInstance, PipeClientReceiveListener >
	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< PipeClientReceiveListener > 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...
PipeClient &	operator= (const PipeClient &)=delete
	No copy. More...
PipeClient &	operator= (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, PipeClientReceiveListener >
void	Triggered (const winss::HandleWrapper &handle)
	Event handler for the pipe client. More...
void	TellAll (const std::function< bool(PipeClientReceiveListener &)> &func)
	Call a function against all listeners. More...
Protected Attributes inherited from winss::PipeClient< TInstance, PipeClientReceiveListener >
bool	stopping
TInstance	instance
	Marked if stopping the client. More...
winss::PipeName	pipe_name
	The pipe instance. More...
winss::NotOwningPtr< winss::WaitMultiplexer >	multiplexer
	The event multiplexer for the pipe client. More...
std::vector< winss::NotOwningPtr< PipeClientReceiveListener > >	listeners
	Listeners for the pipe client. More...

Detailed Description

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

An inbound pipe client.

The client will connect to the server and wait for a \0 before starting to read data. This is because there are no connected events for reading and might miss some data.

Template Parameters

TInstance

The named pipe instance implementation.

Constructor & Destructor Documentation

template<typename TInstance >

winss::InboundPipeClientTmpl< TInstance >::InboundPipeClientTmpl ( const PipeClientConfig &  config )

inlineexplicit

Creates an inbound pipe client with the given config.

Parameters

config

The pipe client confog.

template<typename TInstance >

winss::InboundPipeClientTmpl< TInstance >::InboundPipeClientTmpl ( const InboundPipeClientTmpl< TInstance > &  )

delete

No copy.

template<typename TInstance >

winss::InboundPipeClientTmpl< TInstance >::InboundPipeClientTmpl ( InboundPipeClientTmpl< TInstance > &&  )

delete

No move.

Member Function Documentation

template<typename TInstance >

InboundPipeClientTmpl& winss::InboundPipeClientTmpl< TInstance >::operator= ( const InboundPipeClientTmpl< TInstance > &  )

delete

No copy.

template<typename TInstance >

InboundPipeClientTmpl& winss::InboundPipeClientTmpl< TInstance >::operator= ( InboundPipeClientTmpl< TInstance > &&  )

delete

No move.

---

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

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