A link layer (network layer 2) socket address. More...

#include <LinkLayerAddress.hxx>

Inheritance diagram for cosmos::LinkLayerAddress:

Public Member Functions
	LinkLayerAddress (const sockaddr_ll &addr)

SocketFamily	family () const override
	Returns the concrete SocketFamily for the implementation address type.

size_t	size () const override
	Returns the size of the structure considering the currently set path length only.

EthernetProtocol	protocol () const
	Returns the ethernet protocol stored in the address.

void	setProtocol (const EthernetProtocol prot)
	Sets the ethernet protocol portion of the address.

InterfaceIndex	ifindex () const
	Return the network interface index portion of the address.

void	setIfindex (const InterfaceIndex index)
	Sets the network interface index portion of the address.

ARPType	arpType () const
	Returns the ARP hardware type portion of the address.

PacketType	packetType () const
	Returns the packet type portion of the address.

MACAddress	macAddress () const
	Returns the link layer MAC address stored in the address.

void	setMacAddress (const MACAddress mac)
	Sets the MAC address portion of the address.

Public Member Functions inherited from cosmos::SocketAddress
virtual size_t	maxSize () const
	Returns the maximum number of bytes the socket address can hold.

Protected Member Functions
sockaddr *	basePtr () override
	Returns a mutable pointer to the `sockaddr*` base structure.

const sockaddr *	basePtr () const override
	Returns a const pointer to the `sockaddr*` base structure.

Protected Member Functions inherited from cosmos::SocketAddress
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.

Protected Attributes
sockaddr_ll	m_addr

Detailed Description

A link layer (network layer 2) socket address.

This address type is used with packet sockets or for representing network device layer2 addresses (e.g. MAC address for ethernet devices).

Definition at line 139 of file LinkLayerAddress.hxx.

Constructor & Destructor Documentation

◆ LinkLayerAddress() [1/2]

cosmos::LinkLayerAddress::LinkLayerAddress ( )

inline

Definition at line 143 of file LinkLayerAddress.hxx.

                           {
                clear();
        }

◆ LinkLayerAddress() [2/2]

cosmos::LinkLayerAddress::LinkLayerAddress ( const sockaddr_ll & addr )

inlineexplicit

Definition at line 147 of file LinkLayerAddress.hxx.

                                                           {
                m_addr = addr;
        }

Member Function Documentation

◆ arpType()

ARPType cosmos::LinkLayerAddress::arpType ( ) const

inline

Returns the ARP hardware type portion of the address.

This datum is only valid on receiving, therefore there is no setter.

Definition at line 185 of file LinkLayerAddress.hxx.

                                {
                return ARPType{net::to_host_order(m_addr.sll_hatype)};
        }

◆ basePtr() [1/2]

const sockaddr * cosmos::LinkLayerAddress::basePtr ( ) const

inlineoverrideprotectedvirtual

Returns a const pointer to the sockaddr* base structure.

Implements cosmos::SocketAddress.

Definition at line 213 of file LinkLayerAddress.hxx.

                                                 {
                return reinterpret_cast<const sockaddr*>(&m_addr);
        }

◆ basePtr() [2/2]

sockaddr * cosmos::LinkLayerAddress::basePtr ( )

inlineoverrideprotectedvirtual

Returns a mutable pointer to the sockaddr* base structure.

Implements cosmos::SocketAddress.

Definition at line 209 of file LinkLayerAddress.hxx.

                                     {
                return reinterpret_cast<sockaddr*>(&m_addr);
        }

◆ family()

SocketFamily cosmos::LinkLayerAddress::family ( ) const

inlineoverridevirtual

Returns the concrete SocketFamily for the implementation address type.

Implements cosmos::SocketAddress.

Definition at line 151 of file LinkLayerAddress.hxx.

                                             {
                return SocketFamily::PACKET;
        }

◆ ifindex()

InterfaceIndex cosmos::LinkLayerAddress::ifindex ( ) const

inline

Return the network interface index portion of the address.

Definition at line 171 of file LinkLayerAddress.hxx.

                                       {
                return InterfaceIndex{m_addr.sll_ifindex};
        }

◆ macAddress()

MACAddress cosmos::LinkLayerAddress::macAddress ( ) const

Returns the link layer MAC address stored in the address.

Definition at line 7 of file LinkLayerAddress.cxx.

                                              {
        MACAddress ret;
        if (m_addr.sll_halen != ret.size()) {
                cosmos_throw(RuntimeError("LinkLayerAddress does not contain a MAC address"));
        }
 
        std::memcpy(ret.data(), m_addr.sll_addr, ret.size());
        return ret;
}

◆ packetType()

PacketType cosmos::LinkLayerAddress::packetType ( ) const

inline

Returns the packet type portion of the address.

This datum is only valid on receiving, therefore there is no setter.

Definition at line 194 of file LinkLayerAddress.hxx.

                                      {
                return PacketType{m_addr.sll_pkttype};
        }

◆ protocol()

EthernetProtocol cosmos::LinkLayerAddress::protocol ( ) const

inline

Returns the ethernet protocol stored in the address.

Definition at line 161 of file LinkLayerAddress.hxx.

                                          {
                return EthernetProtocol{net::to_host_order(m_addr.sll_protocol)};
        }

◆ setIfindex()

void cosmos::LinkLayerAddress::setIfindex ( const InterfaceIndex index )

inline

Sets the network interface index portion of the address.

Definition at line 176 of file LinkLayerAddress.hxx.

                                                    {
                m_addr.sll_ifindex = to_integral(index);
        }

◆ setMacAddress()

void cosmos::LinkLayerAddress::setMacAddress ( const MACAddress mac )

inline

Sets the MAC address portion of the address.

Definition at line 202 of file LinkLayerAddress.hxx.

                                                 {
                m_addr.sll_halen = mac.size();
                std::memcpy(m_addr.sll_addr, mac.data(), mac.size());
        }

◆ setProtocol()

void cosmos::LinkLayerAddress::setProtocol ( const EthernetProtocol prot )

inline

Sets the ethernet protocol portion of the address.

Definition at line 166 of file LinkLayerAddress.hxx.

                                                      {
                m_addr.sll_protocol = net::to_network_order(to_integral(prot));
        }

◆ size()

size_t cosmos::LinkLayerAddress::size ( ) const

inlineoverridevirtual

Returns the size of the structure considering the currently set path length only.

Implements cosmos::SocketAddress.

Definition at line 156 of file LinkLayerAddress.hxx.

                                     {
                return sizeof(m_addr);
        }

Member Data Documentation

◆ m_addr

sockaddr_ll cosmos::LinkLayerAddress::m_addr

protected

Definition at line 219 of file LinkLayerAddress.hxx.

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

include/net/LinkLayerAddress.hxx
src/net/LinkLayerAddress.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LinkLayerAddress() [1/2]

◆ LinkLayerAddress() [2/2]

Member Function Documentation

◆ arpType()

◆ basePtr() [1/2]

◆ basePtr() [2/2]

◆ family()

◆ ifindex()

◆ macAddress()

◆ packetType()

◆ protocol()

◆ setIfindex()

◆ setMacAddress()

◆ setProtocol()

◆ size()

Member Data Documentation

◆ m_addr