A mocked Sock alternative that returns a statically contained data upon read and succeeds and ignores all writes. More...

#include <net.h>

Inheritance diagram for StaticContentsSock:

[legend]

Collaboration diagram for StaticContentsSock:

[legend]

Public Member Functions
	StaticContentsSock (const std::string &contents)

	~StaticContentsSock () override

StaticContentsSock &	operator= (Sock &&other) override
	Move assignment operator, grab the socket from another object and close ours (if set). More...

void	Reset () override
	Close if non-empty. More...

ssize_t	Send (const void *, size_t len, int) const override
	send(2) wrapper. More...

ssize_t	Recv (void *buf, size_t len, int flags) const override
	recv(2) wrapper. More...

int	Connect (const sockaddr *, socklen_t) const override
	connect(2) wrapper. More...

std::unique_ptr< Sock >	Accept (sockaddr addr, socklen_t addr_len) const override
	accept(2) wrapper. More...

int	GetSockOpt (int level, int opt_name, void opt_val, socklen_t opt_len) const override
	getsockopt(2) wrapper. More...

bool	Wait (std::chrono::milliseconds timeout, Event requested, Event *occurred=nullptr) const override
	Wait for readiness for input (recv) or output (send). More...

Public Member Functions inherited from Sock
	Sock ()
	Default constructor, creates an empty object that does nothing when destroyed. More...

	Sock (SOCKET s)
	Take ownership of an existent socket. More...

	Sock (const Sock &)=delete
	Copy constructor, disabled because closing the same socket twice is undesirable. More...

	Sock (Sock &&other)
	Move constructor, grab the socket from another object and close ours (if set). More...

virtual	~Sock ()
	Destructor, close the socket or do nothing if empty. More...

Sock &	operator= (const Sock &)=delete
	Copy assignment operator, disabled because closing the same socket twice is undesirable. More...

virtual SOCKET	Get () const
	Get the value of the contained socket. More...

virtual SOCKET	Release ()
	Get the value of the contained socket and drop ownership. More...

virtual void	SendComplete (const std::string &data, std::chrono::milliseconds timeout, CThreadInterrupt &interrupt) const
	Send the given data, retrying on transient errors. More...

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. More...

virtual bool	IsConnected (std::string &errmsg) const
	Check if still connected. More...

Private Attributes
const std::string	m_contents

size_t	m_consumed

Additional Inherited Members
Public Types inherited from Sock
using	Event = uint8_t

Static Public Attributes inherited from Sock
static constexpr Event	RECV = 0b01
	If passed to `Wait()`, then it will wait for readiness to read from the socket. More...

static constexpr Event	SEND = 0b10
	If passed to `Wait()`, then it will wait for readiness to send to the socket. More...

Protected Attributes inherited from Sock
SOCKET	m_socket
	Contained socket. More...

Detailed Description

A mocked Sock alternative that returns a statically contained data upon read and succeeds and ignores all writes.

The data to be returned is given to the constructor and when it is exhausted an EOF is returned by further reads.

Definition at line 94 of file net.h.

Constructor & Destructor Documentation

◆ StaticContentsSock()

StaticContentsSock::StaticContentsSock ( const std::string & contents )

inlineexplicit

Definition at line 97 of file net.h.

◆ ~StaticContentsSock()

StaticContentsSock::~StaticContentsSock ( )

inlineoverride

Definition at line 103 of file net.h.

Here is the call graph for this function:

Member Function Documentation

◆ Accept()

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

inlineoverridevirtual

accept(2) wrapper.

Equivalent to std::make_unique<Sock>(accept(this->Get(), 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 130 of file net.h.

◆ Connect()

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

inlineoverridevirtual

connect(2) wrapper.

Equivalent to connect(this->Get(), 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 128 of file net.h.

◆ GetSockOpt()

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

inlineoverridevirtual

getsockopt(2) wrapper.

Equivalent to getsockopt(this->Get(), 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 147 of file net.h.

◆ operator=()

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

inlineoverridevirtual

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

Reimplemented from Sock.

Definition at line 105 of file net.h.

Here is the call graph for this function:

◆ Recv()

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

inlineoverridevirtual

recv(2) wrapper.

Equivalent to recv(this->Get(), 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 118 of file net.h.

◆ Reset()

void StaticContentsSock::Reset ( )

inlineoverridevirtual

Close if non-empty.

Reimplemented from Sock.

Definition at line 111 of file net.h.

Here is the caller graph for this function:

◆ Send()

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

inlineoverridevirtual

send(2) wrapper.

Equivalent to send(this->Get(), 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 116 of file net.h.

◆ Wait()

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

inlineoverridevirtual

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 `true` is returned, then upon return this indicates which of the requested events occurred. A timeout is indicated by return value of `true` and `occurred` being set to 0.

Returns: true on success and false otherwise

Reimplemented from Sock.

Definition at line 153 of file net.h.

Member Data Documentation

◆ m_consumed

size_t StaticContentsSock::m_consumed

mutableprivate

Definition at line 165 of file net.h.

◆ m_contents

const std::string StaticContentsSock::m_contents

private

Definition at line 164 of file net.h.

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

src/test/util/net.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StaticContentsSock()

◆ ~StaticContentsSock()

Member Function Documentation

◆ Accept()

◆ Connect()

◆ GetSockOpt()

◆ operator=()

◆ Recv()

◆ Reset()

◆ Send()

◆ Wait()

Member Data Documentation

◆ m_consumed

◆ m_contents