cosmos::SockOptBase< LEVEL > Class Template Reference

Base class for Socket option helpers for different OptLevels. More...

#include <SockOptBase.hxx>

Inheritance diagram for cosmos::SockOptBase< LEVEL >:

Protected Member Functions
	SockOptBase (FileDescriptor fd)
	Perform socket options on the given file descriptor.
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 (const SockOptBase &)=delete
SockOptBase &	operator= (const SockOptBase &)=delete

Protected Attributes
FileDescriptor	m_sock
	The socket file descriptor to operate on.

Static Protected Attributes
static constexpr OptLevel	M_LEVEL = LEVEL
	The option level to operate on.

Detailed Description

template<OptLevel LEVEL>
class cosmos::SockOptBase< LEVEL >

Base class for Socket option helpers for different OptLevels.

This base class offers some common infrastructure for dealing with socket options. Implementations of this class need to specify the OptLevel they cover as template argument to this class.

Definition at line 18 of file SockOptBase.hxx.

Constructor & Destructor Documentation

SockOptBase()

template<OptLevel LEVEL>

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} {}

Member Function Documentation

getBoolOption()

template<OptLevel LEVEL>

bool cosmos::SockOptBase< LEVEL >::getBoolOption ( const OptName name ) const

protected

Return a boolean style option.

Definition at line 9 of file SockOptBase.cxx.

                                                               {
        const auto val = getsockopt<int>(m_sock, M_LEVEL, name);
        return val != 0;
}

getIntOption()

template<OptLevel LEVEL>

int cosmos::SockOptBase< LEVEL >::getIntOption ( const OptName name ) const

protected

Return an integer option.

Definition at line 20 of file SockOptBase.cxx.

                                                             {
        return getsockopt<int>(m_sock, M_LEVEL, name);
}

getPeerSec()

template<OptLevel LEVEL>

std::string cosmos::SockOptBase< LEVEL >::getPeerSec ( ) const

protected

Returns the labeled IPSEC or NetLabel of the peer.

This only works if IPSEC or NetLabel is configured on both the sending and receiving hosts. This option is supported for TCP and SCTP sockets on IP level or for UNIX domain sockets.

The returned string will have the proper length and null termination. The encoding of the returned string is unspecified though. In particular it is not guaranteed to be ASCII or UTF-8.

Definition at line 43 of file SockOptBase.cxx.

                                               {
        std::string ret;
        ret.resize(cosmos::max::NAME);
 
        socklen_t length;
 
        while (true) {
                try {
                        length = getsockopt(m_sock, M_LEVEL, OptName{SO_PEERSEC}, ret.data(), ret.size());
 
                        if (ret[length-1] == '\0')
                                // it is not guaranteed that the string is
                                // null terminated, thus check this
                                length--;
 
                        ret.resize(length);
                        return ret;
                } catch (const RangeError &ex) {
                        if (!ex.requiredLengthKnown() || ex.requiredLength() < ret.size()) {
                                throw;
                        }
 
                        // retry with larger size
                        ret.resize(ret.size());
                }
        }
}

getStringOption()

template<OptLevel LEVEL>

std::string cosmos::SockOptBase< LEVEL >::getStringOption ( const OptName name, size_t max_len ) const

protected

Return a null terminated string option.

Definition at line 30 of file SockOptBase.cxx.

                                                                                      {
        std::string ret(max_len, '\0');
        max_len = getsockopt(m_sock, M_LEVEL, name, ret.data(), ret.size());
        ret.resize(max_len - 1);
        return ret;
}

setBoolOption()

template<OptLevel LEVEL>

void cosmos::SockOptBase< LEVEL >::setBoolOption ( const OptName name, const bool val )

protected

Set a boolean style option.

Definition at line 15 of file SockOptBase.cxx.

                                                                         {
        setIntOption(name, int{val ? 1 : 0});
}

setIntOption()

template<OptLevel LEVEL>

void cosmos::SockOptBase< LEVEL >::setIntOption ( const OptName name, const int val )

protected

Set an integer option.

Definition at line 25 of file SockOptBase.cxx.

                                                                       {
        setsockopt(m_sock, M_LEVEL, name, val);
}

setStringOption()

template<OptLevel LEVEL>

void cosmos::SockOptBase< LEVEL >::setStringOption ( const OptName name, const SysString str )

protected

Set a null terminated string option.

Definition at line 38 of file SockOptBase.cxx.

                                                                                {
        setsockopt(m_sock, M_LEVEL, name, str.raw(), str.length());
}

Member Data Documentation

M_LEVEL

template<OptLevel LEVEL>

OptLevel cosmos::SockOptBase< LEVEL >::M_LEVEL = LEVEL

staticconstexprprotected

The option level to operate on.

Definition at line 60 of file SockOptBase.hxx.

m_sock

template<OptLevel LEVEL>

FileDescriptor cosmos::SockOptBase< LEVEL >::m_sock

protected

The socket file descriptor to operate on.

Definition at line 61 of file SockOptBase.hxx.

---

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

• include/net/SockOptBase.hxx
• src/net/SockOptBase.cxx