Ocean::Network::PackagedSocket Class Reference

This class is the base class for all packaged sockets. More...

#include <PackagedSocket.h>

Inheritance diagram for Ocean::Network::PackagedSocket:

Data Structures
class	MemoryBlock
	This class implements a memory block. More...
class	PackageHeader
	Definition of a package header. More...

Public Types
using	MessageId = uint32_t
	Definition of a message id.
Public Types inherited from Ocean::Network::Socket
enum	SocketResult { SR_SUCCEEDED = 0 , SR_FAILED , SR_BUSY , SR_NOT_CONNECTED }
	Definition of individual result values. More...
using	SocketId = SOCKET
	Definition of a socket id.
using	SocketId = int
	Definition of a socket id.
using	Buffer = std::vector< uint8_t >
	Definition of a vector holding 8 bit values.

Static Public Member Functions
static constexpr MessageId	invalidMessageId ()
	Returns an invalid message id.
static constexpr size_t	packageManagmentHeaderSize ()
	Returns the size of the package management header in bytes.
static constexpr size_t	maximalPackagedMessageSize ()
	Returns the maximal size of a packaged message.
Static Public Member Functions inherited from Ocean::Network::Socket
static constexpr SocketId	invalidSocketId ()
	Returns an invalid socket id.
static bool	setBlockingMode (const SocketId socketId, const bool blocking)
	Sets the blocking mode of a socket.

Protected Types
using	MemoryBlockQueue = std::queue< MemoryBlock >
	Definition of a queue holding memory blocks.

Protected Member Functions
	PackagedSocket ()
	Creates a new packaged socket.
Protected Member Functions inherited from Ocean::Network::Socket
	Socket ()
	Creates a new socket object.
	Socket (const Socket &object)=delete
	Disabled copy constructor.
bool	setBlockingMode (const bool blocking)
	Sets the blocking mode of this socket.
size_t	maximalMessageSize (const size_t defaultSize=65536)
	Returns the maximal message size in bytes.
bool	releaseSocket ()
	Releases the socket.
virtual bool	onScheduler ()
	The scheduler event function.
Socket &	operator= (const Socket &object)=delete
	Disabled copy operator.

Static Protected Member Functions
static bool	extractNextPackage (MemoryBlockQueue &sourceQueue, MemoryBlock &targetMemory)
	Extracts a memory block from a queue with memory block.

Additional Inherited Members
Public Member Functions inherited from Ocean::Network::Socket
virtual	~Socket ()
	Destructs a socket object.
SocketId	id () const
	Returns the socket id.
Address4	address () const
	Returns the own address of this socket.
Port	port () const
	Returns the own port of this socket.
virtual bool	setAddress (const Address4 &address)
	Sets the own address of this socket.
virtual bool	setPort (const Port &port)
	Sets the own port of this socket.
	operator bool () const
	Returns whether this socket is valid.
Protected Attributes inherited from Ocean::Network::Socket
SocketId	socketId_ = invalidSocketId()
	Socket id.
Lock	lock_
	Socket lock.
NetworkResource	networkResource_
	The network resource object.

Detailed Description

This class is the base class for all packaged sockets.

Member Typedef Documentation

MemoryBlockQueue

using Ocean::Network::PackagedSocket::MemoryBlockQueue = std::queue<MemoryBlock>

protected

Definition of a queue holding memory blocks.

MessageId

using Ocean::Network::PackagedSocket::MessageId = uint32_t

Definition of a message id.

Constructor & Destructor Documentation

PackagedSocket()

Ocean::Network::PackagedSocket::PackagedSocket ( )

protected

Creates a new packaged socket.

Member Function Documentation

extractNextPackage()

static bool Ocean::Network::PackagedSocket::extractNextPackage ( MemoryBlockQueue &  sourceQueue, MemoryBlock &  targetMemory  )

staticprotected

Extracts a memory block from a queue with memory block.

Parameters

sourceQueue	The queue from which the memory will be extracted
targetMemory	The target memory block to be filled, must be valid, must have remaining bytes

Returns

True, if the target memory block has been filled and no byte is remaining anymore

invalidMessageId()

constexpr PackagedSocket::MessageId Ocean::Network::PackagedSocket::invalidMessageId ( )

staticconstexpr

Returns an invalid message id.

Returns

Invalid message id

maximalPackagedMessageSize()

constexpr size_t Ocean::Network::PackagedSocket::maximalPackagedMessageSize ( )

staticconstexpr

Returns the maximal size of a packaged message.

Returns

The maximal size of a packaged message in bytes

packageManagmentHeaderSize()

constexpr size_t Ocean::Network::PackagedSocket::packageManagmentHeaderSize ( )

staticconstexpr

Returns the size of the package management header in bytes.

Returns

The header's size in bytes

---

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

• PackagedSocket.h