A mocked Sock alternative that allows providing the data to be returned by Recv() and inspecting the data that has been supplied to Send(). More...

#include <net.h>

Inheritance diagram for DynSock:

[legend]

Collaboration diagram for DynSock:

[legend]

Classes
class	Pipe
	Unidirectional bytes or CNetMessage queue (FIFO). More...
struct	Pipes
class	Queue
	A basic thread-safe queue, used for queuing sockets to be returned by Accept(). More...

Public Member Functions
	DynSock (std::shared_ptr< Pipes > pipes, std::shared_ptr< Queue > accept_sockets)
	Create a new mocked sock.
	~DynSock ()
ssize_t	Recv (void *buf, size_t len, int flags) const override
	recv(2) wrapper.
ssize_t	Send (const void *buf, size_t len, int) const override
	send(2) wrapper.
std::unique_ptr< Sock >	Accept (sockaddr addr, socklen_t addr_len) const override
	accept(2) wrapper.
bool	Wait (std::chrono::milliseconds timeout, Event requested, Event *occurred=nullptr) const override
	Wait for readiness for input (recv) or output (send).
bool	WaitMany (std::chrono::milliseconds timeout, EventsPerSock &events_per_sock) const override
	Same as Wait(), but wait on many sockets within the same timeout.
Public Member Functions inherited from ZeroSock
	ZeroSock ()
	~ZeroSock () override
ssize_t	Send (const void *, size_t len, int) const override
	send(2) wrapper.
ssize_t	Recv (void *buf, size_t len, int flags) const override
	recv(2) wrapper.
int	Connect (const sockaddr *, socklen_t) const override
	connect(2) wrapper.
int	Bind (const sockaddr *, socklen_t) const override
	bind(2) wrapper.
int	Listen (int) const override
	listen(2) wrapper.
std::unique_ptr< Sock >	Accept (sockaddr addr, socklen_t addr_len) const override
	accept(2) wrapper.
int	GetSockOpt (int level, int opt_name, void opt_val, socklen_t opt_len) const override
	getsockopt(2) wrapper.
int	SetSockOpt (int, int, const void *, socklen_t) const override
	setsockopt(2) wrapper.
int	GetSockName (sockaddr name, socklen_t name_len) const override
	getsockname(2) wrapper.
bool	SetNonBlocking () const override
	Set the non-blocking option on the socket.
bool	IsSelectable () const override
	Check if the underlying socket can be used for select(2) (or the Wait() method).
bool	Wait (std::chrono::milliseconds timeout, Event requested, Event *occurred=nullptr) const override
	Wait for readiness for input (recv) or output (send).
bool	WaitMany (std::chrono::milliseconds timeout, EventsPerSock &events_per_sock) const override
	Same as Wait(), but wait on many sockets within the same timeout.
Public Member Functions inherited from Sock
	Sock ()=delete
	Sock (SOCKET s)
	Take ownership of an existent socket.
	Sock (const Sock &)=delete
	Copy constructor, disabled because closing the same socket twice is undesirable.
	Sock (Sock &&other)
	Move constructor, grab the socket from another object and close ours (if set).
virtual	~Sock ()
	Destructor, close the socket or do nothing if empty.
Sock &	operator= (const Sock &)=delete
	Copy assignment operator, disabled because closing the same socket twice is undesirable.
virtual void	SendComplete (std::span< const unsigned char > data, std::chrono::milliseconds timeout, CThreadInterrupt &interrupt) const
	Send the given data, retrying on transient errors.
virtual void	SendComplete (std::span< const char > data, std::chrono::milliseconds timeout, CThreadInterrupt &interrupt) const
	Convenience method, equivalent to SendComplete(MakeUCharSpan(data), timeout, interrupt).
virtual std::string	RecvUntilTerminator (uint8_t terminator, std::chrono::milliseconds timeout, CThreadInterrupt &interrupt, size_t max_data) const
	Read from socket until a terminator character is encountered.
virtual bool	IsConnected (std::string &errmsg) const
	Check if still connected.
bool	operator== (SOCKET s) const
	Check if the internal socket is equal to s.

Private Member Functions
DynSock &	operator= (Sock &&) override
	Move assignment operator, grab the socket from another object and close ours (if set).

Private Attributes
std::shared_ptr< Pipes >	m_pipes
std::shared_ptr< Queue >	m_accept_sockets

Additional Inherited Members
Public Types inherited from Sock
using	Event = uint8_t
using	EventsPerSock = std::unordered_map<std::shared_ptr<const Sock>, Events, HashSharedPtrSock, EqualSharedPtrSock>
	On which socket to wait for what events in WaitMany().
Static Public Attributes inherited from Sock
static constexpr Event	RECV = 0b001
	If passed to Wait(), then it will wait for readiness to read from the socket.
static constexpr Event	SEND = 0b010
	If passed to Wait(), then it will wait for readiness to send to the socket.
static constexpr Event	ERR = 0b100
	Ignored if passed to Wait(), but could be set in the occurred events if an exceptional condition has occurred on the socket or if it has been disconnected.
Protected Attributes inherited from Sock
SOCKET	m_socket
	Contained socket.

Detailed Description

A mocked Sock alternative that allows providing the data to be returned by Recv() and inspecting the data that has been supplied to Send().

Definition at line 238 of file net.h.

Constructor & Destructor Documentation

◆ DynSock()

DynSock::DynSock	(	std::shared_ptr< Pipes >	pipes,
		std::shared_ptr< Queue >	accept_sockets )

explicit

Create a new mocked sock.

Parameters

[in]	pipes	Send/recv pipes used by the Send() and Recv() methods.
[in]	accept_sockets	Sockets to return by the Accept() method.

Definition at line 349 of file net.cpp.

Here is the caller graph for this function:

◆ ~DynSock()

DynSock::~DynSock ( )

Definition at line 354 of file net.cpp.

Member Function Documentation

◆ Accept()

std::unique_ptr< Sock > DynSock::Accept	(	sockaddr *	addr,
		socklen_t *	addr_len ) const

overridevirtual

accept(2) wrapper.

Equivalent to std::make_unique<Sock>(accept(m_socket, addr, addr_len)). Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation. The returned unique_ptr is empty if accept() failed in which case errno will be set.

Reimplemented from Sock.

Definition at line 370 of file net.cpp.

Here is the call graph for this function:

◆ operator=()

DynSock & DynSock::operator= ( Sock && other )

overrideprivatevirtual

Move assignment operator, grab the socket from another object and close ours (if set).

Reimplemented from Sock.

Definition at line 423 of file net.cpp.

Here is the call graph for this function:

◆ Recv()

ssize_t DynSock::Recv	(	void *	buf,
		size_t	len,
		int	flags ) const

overridevirtual

recv(2) wrapper.

Equivalent to recv(m_socket, buf, len, flags);. Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 359 of file net.cpp.

◆ Send()

ssize_t DynSock::Send	(	const void *	data,
		size_t	len,
		int	flags ) const

overridevirtual

send(2) wrapper.

Equivalent to send(m_socket, data, len, flags);. Code that uses this wrapper can be unit tested if this method is overridden by a mock Sock implementation.

Reimplemented from Sock.

Definition at line 364 of file net.cpp.

◆ Wait()

bool DynSock::Wait	(	std::chrono::milliseconds	timeout,
		Event	requested,
		Event *	occurred = nullptr ) const

overridevirtual

Wait for readiness for input (recv) or output (send).

Parameters

[in]	timeout	Wait this much for at least one of the requested events to occur.
[in]	requested	Wait for those events, bitwise-or of RECV and SEND.
[out]	occurred	If not nullptr and the function returns true, then this indicates which of the requested events occurred (ERR will be added, even if not requested, if an exceptional event occurs on the socket). A timeout is indicated by return value of true and occurred being set to 0.

Returns: true on success (or timeout, if occurred of 0 is returned), false otherwise

Reimplemented from Sock.

Definition at line 376 of file net.cpp.

Here is the call graph for this function:

◆ WaitMany()

bool DynSock::WaitMany	(	std::chrono::milliseconds	timeout,
		EventsPerSock &	events_per_sock ) const

overridevirtual

Same as Wait(), but wait on many sockets within the same timeout.

Parameters

[in]	timeout	Wait this long for at least one of the requested events to occur.
[in,out]	events_per_sock	Wait for the requested events on these sockets and set occurred for the events that actually occurred.

Returns: true on success (or timeout, if all what[].occurred are returned as 0), false otherwise

Reimplemented from Sock.

Definition at line 389 of file net.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_accept_sockets

std::shared_ptr<Queue> DynSock::m_accept_sockets

private

Definition at line 359 of file net.h.

◆ m_pipes

std::shared_ptr<Pipes> DynSock::m_pipes

private

Definition at line 358 of file net.h.

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

src/test/util/net.h
src/test/util/net.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DynSock()

◆ ~DynSock()

Member Function Documentation

◆ Accept()

◆ operator=()

◆ Recv()

◆ Send()

◆ Wait()

◆ WaitMany()

Member Data Documentation

◆ m_accept_sockets

◆ m_pipes