cosmos::SocketAddress Class Reference

Base class for all types of socket addresses. More...

#include <SocketAddress.hxx>

Inheritance diagram for cosmos::SocketAddress:

Public Member Functions
virtual SocketFamily	family () const =0
	Returns the concrete SocketFamily for the implementation address type.
virtual size_t	size () const =0
	Returns the size of the socket address in bytes found at basePtr().
virtual size_t	maxSize () const
	Returns the maximum number of bytes the socket address can hold.

Protected Member Functions
virtual sockaddr *	basePtr ()=0
	Returns a mutable pointer to the sockaddr* base structure.
virtual const sockaddr *	basePtr () const =0
	Returns a const pointer to the sockaddr* base structure.
void	clear ()
	Clears the complete address structure.
virtual void	update (size_t new_length)
	Update the address structure after it has been filled in by the kernel.

Friends
class	Socket
class	SendMessageHeader
class	ReceiveMessageHeader

Detailed Description

Base class for all types of socket addresses.

This is the equivalent of the raw sockaddr* type. It needs to be derived from to form a concrete address type. This type is used for passing to generic functions like Socket::bind and Socket::connect.

A couple of pure virtual functions need to be implemented by concrete address types. This is necessary to deal with system calls in a generic way.

When passed as an input parameter then size() determines the actual number of bytes used for the address. Some address types always have the same fixed size while some like UnixAddress can use dynamic sizes.

When passed as an output parameter then maxSize() determines the maximum number of bytes the kernel can use for writing address information to. After a system call has filled in the address structure update() will be called to allow the implementation to inspect the new data an possibly adjust further object state.

Definition at line 32 of file SocketAddress.hxx.

Constructor & Destructor Documentation

~SocketAddress()

virtual cosmos::SocketAddress::~SocketAddress ( )

inlinevirtual

Definition at line 38 of file SocketAddress.hxx.

{}

Member Function Documentation

basePtr() [1/2]

virtual const sockaddr * cosmos::SocketAddress::basePtr ( ) const

protectedpure virtual

Returns a const pointer to the sockaddr* base structure.

Implemented in cosmos::IP4Address, cosmos::IP6Address, cosmos::LinkLayerAddress, and cosmos::UnixAddress.

basePtr() [2/2]

virtual sockaddr * cosmos::SocketAddress::basePtr ( )

protectedpure virtual

Returns a mutable pointer to the sockaddr* base structure.

Implemented in cosmos::IP4Address, cosmos::IP6Address, cosmos::LinkLayerAddress, and cosmos::UnixAddress.

clear()

void cosmos::SocketAddress::clear ( )

protected

Clears the complete address structure.

After this call the complete address structure found at basePtr() will overwritten by zeroes, and the family field will be initialized with the value returned from family().

This uses the length information returned by maxSize() for zeroing out the structure..

Definition at line 14 of file SocketAddress.cxx.

                          {
        auto addr = basePtr();
        std::memset(addr, 0, maxSize());
        addr->sa_family = to_integral(family());
}

family()

virtual SocketFamily cosmos::SocketAddress::family ( ) const

pure virtual

Returns the concrete SocketFamily for the implementation address type.

Implemented in cosmos::IP4Address, cosmos::IP6Address, cosmos::LinkLayerAddress, and cosmos::UnixAddress.

maxSize()

virtual size_t cosmos::SocketAddress::maxSize ( ) const

inlinevirtual

Returns the maximum number of bytes the socket address can hold.

If the concrete socket address type can have dynamic size then this returns the maximum number of bytes the structure found at basePtr() can hold.

Reimplemented in cosmos::UnixAddress.

Definition at line 57 of file SocketAddress.hxx.

                                       {
                return size();
        }

size()

virtual size_t cosmos::SocketAddress::size ( ) const

pure virtual

Returns the size of the socket address in bytes found at basePtr().

This returns the number of bytes currently used in the socket address. Some implementations may have dynamic sizes in which case this can differ from maxSize().

Implemented in cosmos::IP4Address, cosmos::IP6Address, cosmos::LinkLayerAddress, and cosmos::UnixAddress.

update()

void cosmos::SocketAddress::update ( size_t new_length )

protectedvirtual

Update the address structure after it has been filled in by the kernel.

Some system calls update the address structure. The obtained number of bytes is found in new_length. Some address structures have dynamic sizes in which case the new length has to be accommodated for by overriding this function call.

The default implementation only performs a sanity check that the new length matches the old length (considering statically sized addresses).

Reimplemented in cosmos::UnixAddress.

Definition at line 8 of file SocketAddress.cxx.

                                            {
        if (new_length != this->size()) {
                cosmos_throw(RuntimeError("inconsistent socket address size on return"));
        }
}

Friends And Related Symbol Documentation

ReceiveMessageHeader

friend class ReceiveMessageHeader

friend

Definition at line 35 of file SocketAddress.hxx.

SendMessageHeader

friend class SendMessageHeader

friend

Definition at line 34 of file SocketAddress.hxx.

Socket

friend class Socket

friend

Definition at line 33 of file SocketAddress.hxx.

---

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

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