wpi::uv::NetworkStream Class Reference

Network stream handle. More...

#include <wpinet/uv/NetworkStream.h>

Inheritance diagram for wpi::uv::NetworkStream:

Public Member Functions
std::shared_ptr< NetworkStream >	shared_from_this ()
std::shared_ptr< const NetworkStream >	shared_from_this () const
void	Listen (int backlog=kDefaultBacklog)
	Start listening for incoming connections.
void	Listen (std::function< void()> callback, int backlog=kDefaultBacklog)
	Start listening for incoming connections.
std::shared_ptr< NetworkStream >	Accept ()
	Accept incoming connection.
bool	Accept (const std::shared_ptr< NetworkStream > &client)
	Accept incoming connection.
Public Member Functions inherited from wpi::uv::Stream
std::shared_ptr< Stream >	shared_from_this ()
std::shared_ptr< const Stream >	shared_from_this () const
void	Shutdown (const std::shared_ptr< ShutdownReq > &req)
	Shutdown the outgoing (write) side of a duplex stream.
void	Shutdown (std::function< void()> callback=nullptr)
	Shutdown the outgoing (write) side of a duplex stream.
void	StartRead ()
	Start reading data from an incoming stream.
void	StopRead ()
	Stop reading data from the stream.
void	Write (std::span< const Buffer > bufs, const std::shared_ptr< WriteReq > &req)
	Write data to the stream.
void	Write (std::initializer_list< Buffer > bufs, const std::shared_ptr< WriteReq > &req)
	Write data to the stream.
void	Write (std::span< const Buffer > bufs, std::function< void(std::span< Buffer >, Error)> callback)
	Write data to the stream.
void	Write (std::initializer_list< Buffer > bufs, std::function< void(std::span< Buffer >, Error)> callback)
	Write data to the stream.
int	TryWrite (std::span< const Buffer > bufs)
	Queue a write request if it can be completed immediately.
int	TryWrite (std::initializer_list< Buffer > bufs)
	Queue a write request if it can be completed immediately.
int	TryWrite2 (std::span< const Buffer > bufs, Stream &send)
	Same as TryWrite() and extended write function for sending handles over a pipe.
int	TryWrite2 (std::initializer_list< Buffer > bufs, Stream &send)
	Same as TryWrite() and extended write function for sending handles over a pipe.
bool	IsReadable () const noexcept
	Check if the stream is readable.
bool	IsWritable () const noexcept
	Checks if the stream is writable.
bool	SetBlocking (bool enable) noexcept
	Enable or disable blocking mode for a stream.
size_t	GetWriteQueueSize () const noexcept
	Gets the amount of queued bytes waiting to be sent.
uv_stream_t *	GetRawStream () const noexcept
	Get the underlying stream data structure.
Public Member Functions inherited from wpi::uv::Handle
	Handle (const Handle &)=delete
	Handle (Handle &&)=delete
Handle &	operator= (const Handle &)=delete
Handle &	operator= (Handle &&)=delete
virtual	~Handle () noexcept
Type	GetType () const noexcept
	Get the type of the handle.
std::string_view	GetTypeName () const noexcept
	Get the name of the type of the handle.
std::shared_ptr< Loop >	GetLoop () const noexcept
	Get the loop where this handle runs.
Loop &	GetLoopRef () const noexcept
	Get the loop where this handle runs.
bool	IsActive () const noexcept
	Check if the handle is active.
bool	IsClosing () const noexcept
	Check if a handle is closing or closed.
void	Close () noexcept
	Request handle to be closed.
void	SetLoopClosing (bool loopClosing) noexcept
	Set if the loop is closing.
bool	IsLoopClosing () const noexcept
	Get the loop closing status.
void	Reference () noexcept
	Reference the given handle.
void	Unreference () noexcept
	Unreference the given handle.
bool	HasReference () const noexcept
	Check if the given handle is referenced.
size_t	RawSize () const noexcept
	Return the size of the underlying handle type.
uv_handle_t *	GetRawHandle () const noexcept
	Get the underlying handle data structure.
void	SetBufferAllocator (std::function< Buffer(size_t)> alloc, std::function< void(Buffer &)> dealloc)
	Set the functions used for allocating and releasing buffers.
void	FreeBuf (Buffer &buf) const noexcept
	Free a buffer.
template<typename T = void>
std::shared_ptr< T >	GetData () const
	Gets user-defined data.
void	SetData (std::shared_ptr< void > data)
	Sets user-defined data.
void	SetLogger (Logger *logger)
	Sets logger.
Logger *	GetLogger () const
	Gets logger.
void	ReportError (int err) const
	Report an error.

Public Attributes
sig::Signal	connection
	Signal generated when an incoming connection is received.
Public Attributes inherited from wpi::uv::Stream
sig::Signal< Buffer &, size_t >	data
	Signal generated when data was read on a stream.
sig::Signal	end
	Signal generated when no more read data is available.
Public Attributes inherited from wpi::uv::Handle
sig::Signal< Error >	error
	Error signal.
sig::Signal	closed
	Closed signal.

Static Public Attributes
static constexpr int	kDefaultBacklog = 128

Protected Member Functions
	NetworkStream (uv_stream_t *uv_stream)
virtual NetworkStream *	DoAccept ()=0
Protected Member Functions inherited from wpi::uv::Stream
	Stream (uv_stream_t *uv_stream)
Protected Member Functions inherited from wpi::uv::Handle
	Handle (uv_handle_t *uv_handle)
void	Keep () noexcept
void	Release () noexcept
void	ForceClosed () noexcept
template<typename F , typename... Args>
bool	Invoke (F &&f, Args &&... args) const

Additional Inherited Members
Public Types inherited from wpi::uv::Handle
using	Type = uv_handle_type
Static Protected Member Functions inherited from wpi::uv::Handle
static void	AllocBuf (uv_handle_t *handle, size_t size, uv_buf_t *buf)
static void	DefaultFreeBuf (Buffer &buf)

Detailed Description

Network stream handle.

This is an abstract type; there are two network stream implementations (Tcp and Pipe).

Constructor & Destructor Documentation

NetworkStream()

wpi::uv::NetworkStream::NetworkStream ( uv_stream_t * uv_stream )

inlineexplicitprotected

Member Function Documentation

Accept() [1/2]

std::shared_ptr< NetworkStream > wpi::uv::NetworkStream::Accept ( )

inline

Accept incoming connection.

This call is used in conjunction with Listen() to accept incoming connections. Call this function after receiving a ListenEvent event to accept the connection. An error signal will be emitted in case of errors.

When the connection signal is emitted it is guaranteed that this function will complete successfully the first time. If you attempt to use it more than once, it may fail. It is suggested to only call this function once per connection signal.

Returns

The stream handle for the accepted connection, or nullptr on error.

Accept() [2/2]

bool wpi::uv::NetworkStream::Accept ( const std::shared_ptr< NetworkStream > & client )

inline

Accept incoming connection.

This call is used in conjunction with Listen() to accept incoming connections. Call this function after receiving a connection signal to accept the connection. An error signal will be emitted in case of errors.

When the connection signal is emitted it is guaranteed that this function will complete successfully the first time. If you attempt to use it more than once, it may fail. It is suggested to only call this function once per connection signal.

Parameters

client

Client stream object.

Returns

False on error.

DoAccept()

virtual NetworkStream * wpi::uv::NetworkStream::DoAccept ( )

protectedpure virtual

Listen() [1/2]

void wpi::uv::NetworkStream::Listen

(

int

backlog = kDefaultBacklog

)

Start listening for incoming connections.

When a new incoming connection is received the connection signal is generated.

Parameters

backlog

the number of connections the kernel might queue, same as listen(2).

Listen() [2/2]

void wpi::uv::NetworkStream::Listen	(	std::function< void()>	callback,
		int	backlog = kDefaultBacklog )

Start listening for incoming connections.

This is a convenience wrapper around Listen(int) that also connects a callback to the connection signal. When a new incoming connection is received the connection signal is generated (and the callback is called).

Parameters

callback	the callback to call when a connection is received. Accept() should be called from this callback.
backlog	the number of connections the kernel might queue, same as listen(2).

shared_from_this() [1/2]

std::shared_ptr< NetworkStream > wpi::uv::NetworkStream::shared_from_this ( )

inline

shared_from_this() [2/2]

std::shared_ptr< const NetworkStream > wpi::uv::NetworkStream::shared_from_this ( ) const

inline

Member Data Documentation

connection

sig::Signal wpi::uv::NetworkStream::connection

Signal generated when an incoming connection is received.

kDefaultBacklog

int wpi::uv::NetworkStream::kDefaultBacklog = 128

staticconstexpr

---

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

• wpinet/uv/NetworkStream.h