cosmos::UDPOptions Class Reference

UDP level socket option setter/getter helper. More...

#include <UDPOptions.hxx>

Inheritance diagram for cosmos::UDPOptions:

Public Member Functions
void	setCork (const bool on_off)
	Accumulate output data in kernel until the option is disabled again.
void	pushCork ()
void	popCork ()
void	setSendOffload (const uint16_t segment_size)
	Configure segmentation (send) offload on this socket using the given segment_size in bytes.
void	setReceiveOffload (const bool on_off)
	Configure GRO (receive) offload on this socket.

Protected Member Functions
	SockOptBase (FileDescriptor fd)
	Perform socket options on the given file descriptor.
	SockOptBase (const SockOptBase &)=delete
Protected Member Functions inherited from cosmos::SockOptBase< OptLevel::UDP >
	SockOptBase (FileDescriptor fd)
	Perform socket options on the given file descriptor.
	SockOptBase (const SockOptBase &)=delete
bool	getBoolOption (const OptName name) const
	Return a boolean style option.
void	setBoolOption (const OptName name, const bool val)
	Set a boolean style option.
int	getIntOption (const OptName name) const
	Return an integer option.
void	setIntOption (const OptName name, const int val)
	Set an integer option.
std::string	getStringOption (const OptName name, size_t max_len) const
	Return a null terminated string option.
void	setStringOption (const OptName name, const SysString str)
	Set a null terminated string option.
std::string	getPeerSec () const
	Returns the labeled IPSEC or NetLabel of the peer.
SockOptBase &	operator= (const SockOptBase &)=delete

Friends
template<SocketFamily family>
class	UDPSocketT

Additional Inherited Members
Protected Attributes inherited from cosmos::SockOptBase< OptLevel::UDP >
FileDescriptor	m_sock
	The socket file descriptor to operate on.
Static Protected Attributes inherited from cosmos::SockOptBase< OptLevel::UDP >
static constexpr OptLevel	M_LEVEL
	The option level to operate on.

Detailed Description

UDP level socket option setter/getter helper.

Definition at line 16 of file UDPOptions.hxx.

Member Function Documentation

popCork()

void cosmos::UDPOptions::popCork ( )

inline

Definition at line 39 of file UDPOptions.hxx.

                       {
                setCork(false);
        }

pushCork()

void cosmos::UDPOptions::pushCork ( )

inline

Definition at line 35 of file UDPOptions.hxx.

                        {
                setCork(true);
        }

setCork()

void cosmos::UDPOptions::setCork ( const bool on_off )

inline

Accumulate output data in kernel until the option is disabled again.

This can be used to accumulate multiple send() calls into a single datagram. Userspace is responsible for managing this cork i.e. disabling the option at the appropriate time again.

pushCork() and popCork() are descriptive wrapper functions that help with this task.

Definition at line 31 of file UDPOptions.hxx.

                                        {
                setBoolOption(OptName{UDP_CORK}, on_off);
        }

setReceiveOffload()

void cosmos::UDPOptions::setReceiveOffload ( const bool on_off )

inline

Configure GRO (receive) offload on this socket.

This is the reverse of setSendOffload(), for the receiving path of a UDP socket. The socket can then receive multiple datagrams in one recv() system call.

The segment size of each datagram will be reported via a control message provided via the recvmsg() system call. You need to pass a four byte control message buffer with cmsg_type == UDP_GRO to receive it.

Definition at line 75 of file UDPOptions.hxx.

                                                  {
                setBoolOption(OptName{UDP_GRO}, on_off);
        }

setSendOffload()

void cosmos::UDPOptions::setSendOffload ( const uint16_t segment_size )

inline

Configure segmentation (send) offload on this socket using the given segment_size in bytes.

This feature allows to pass a single buffer containing multiple UDP datagrams to the kernel. The kernel will pass the large chunk of data in one piece as long as possible until it will be split up into individual datagrams (segments) either in software before passing it on to the hardware, or even in the hardware itself, it it supports that.

The segment_size defines the size of each individual segment. When sending data over the socket then it is considered to contain a multiple of this segment_size, where the last segment can be shorter. This size needs to be smaller than the MTU and no more than 64 segments can be sent in a single send() call this way.

Set this to zero to disable the feature.

Definition at line 60 of file UDPOptions.hxx.

                                                         {
                setIntOption(OptName{UDP_SEGMENT}, static_cast<int>(segment_size));
        }

SockOptBase()

cosmos::SockOptBase< LEVEL >::SockOptBase ( FileDescriptor fd )

inlineexplicitprotected

Perform socket options on the given file descriptor.

Definition at line 22 of file SockOptBase.hxx.

                                                :
                m_sock{fd} {}

Friends And Related Symbol Documentation

UDPSocketT

template<SocketFamily family>

friend class UDPSocketT

friend

Definition at line 19 of file UDPOptions.hxx.

---

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

• include/net/UDPOptions.hxx