ZeroSock Class Reference

A mocked Sock alternative that succeeds on all operations. More...

#include <net.h>

Inheritance diagram for ZeroSock:

Collaboration diagram for ZeroSock:

Public Member Functions
	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
ZeroSock &	operator= (Sock &&other) override
	Move assignment operator, grab the socket from another object and close ours (if set).

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 succeeds on all operations.

Returns infinite amount of 0x0 bytes on reads.

Definition at line 167 of file net.h.

Constructor & Destructor Documentation

ZeroSock()

ZeroSock::ZeroSock

(

)

Definition at line 166 of file net.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

~ZeroSock()

ZeroSock::~ZeroSock ( )

override

Definition at line 169 of file net.cpp.

Member Function Documentation

Accept()

std::unique_ptr< Sock > ZeroSock::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 185 of file net.cpp.

Here is the caller graph for this function:

Bind()

int ZeroSock::Bind ( const sockaddr * addr, socklen_t addr_len ) const

overridevirtual

bind(2) wrapper.

Equivalent to bind(m_socket, addr, addr_len). 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 181 of file net.cpp.

Connect()

int ZeroSock::Connect ( const sockaddr * addr, socklen_t addr_len ) const

overridevirtual

connect(2) wrapper.

Equivalent to connect(m_socket, addr, addrlen). 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 179 of file net.cpp.

GetSockName()

int ZeroSock::GetSockName ( sockaddr * name, socklen_t * name_len ) const

overridevirtual

getsockname(2) wrapper.

Equivalent to getsockname(m_socket, name, name_len). 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 210 of file net.cpp.

GetSockOpt()

int ZeroSock::GetSockOpt ( int level, int opt_name, void * opt_val, socklen_t * opt_len ) const

overridevirtual

getsockopt(2) wrapper.

Equivalent to getsockopt(m_socket, level, opt_name, opt_val, opt_len). 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 202 of file net.cpp.

IsSelectable()

bool ZeroSock::IsSelectable ( ) const

overridevirtual

Check if the underlying socket can be used for select(2) (or the Wait() method).

Returns

true if selectable

Reimplemented from Sock.

Definition at line 218 of file net.cpp.

Listen()

int ZeroSock::Listen ( int backlog ) const

overridevirtual

listen(2) wrapper.

Equivalent to listen(m_socket, backlog). 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 183 of file net.cpp.

operator=()

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

overrideprivatevirtual

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

Reimplemented from Sock.

Definition at line 237 of file net.cpp.

Here is the call graph for this function:

Recv()

ssize_t ZeroSock::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 173 of file net.cpp.

Send()

ssize_t ZeroSock::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 171 of file net.cpp.

SetNonBlocking()

bool ZeroSock::SetNonBlocking ( ) const

overridevirtual

Set the non-blocking option on the socket.

Returns

true if set successfully

Reimplemented from Sock.

Definition at line 216 of file net.cpp.

SetSockOpt()

int ZeroSock::SetSockOpt ( int level, int opt_name, const void * opt_val, socklen_t opt_len ) const

overridevirtual

setsockopt(2) wrapper.

Equivalent to setsockopt(m_socket, level, opt_name, opt_val, opt_len). 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 208 of file net.cpp.

Wait()

bool ZeroSock::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 220 of file net.cpp.

WaitMany()

bool ZeroSock::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 228 of file net.cpp.

---

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

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