#include <array>
#include <net/if.h>
#include <linux/if_arp.h>
#include <netdb.h>
#include <netinet/in.h>
#include <netinet/ip.h>
#include <sys/socket.h>
#include <cosmos/BitMask.hxx>
#include <cosmos/net/byte_order.hxx>

Classes
class	cosmos::IPPort
	A 16-bit IP port in network byte order. More...

class	cosmos::IP4RawAddress
	A 32-bit IPv4 binary address in network byte order. More...

struct	cosmos::IP6RawAddress
	A 128-bit IPv6 address. More...

struct	cosmos::MACAddress
	A 48-bit ethernet 802.3 MAC address. More...

Typedefs
using	cosmos::SocketFlags = BitMask<SocketFlag>
	Collection of SocketFlag used for creating sockets.

using	cosmos::MessageFlags = BitMask<MessageFlag>

Enumerations
enum class	cosmos::SocketFamily : int { UNSPEC = AF_UNSPEC , INET = AF_INET , INET6 = AF_INET6 , UNIX = AF_UNIX , NETLINK = AF_NETLINK , PACKET = AF_PACKET }
	A socket's family setting. More...

enum class	cosmos::SocketType : int { ANY = 0 , STREAM = SOCK_STREAM , DGRAM = SOCK_DGRAM , RAW = SOCK_RAW , SEQPACKET = SOCK_SEQPACKET , RDM = SOCK_RDM }
	A socket's type setting. More...

enum class	cosmos::SocketProtocol : int { DEFAULT = 0 }
	Specific protocol to use on a socket. More...

enum class	cosmos::SocketFlag : int { CLOEXEC = SOCK_CLOEXEC , NONBLOCK = SOCK_NONBLOCK }
	Additional socket settings used during socket creation. More...

enum class	cosmos::OptLevel : int { SOCKET = SOL_SOCKET , IP = IPPROTO_IP , IPV6 = IPPROTO_IPV6 , TCP = IPPROTO_TCP , UDP = IPPROTO_UDP }
	Representation of socket option levels. More...

enum class	cosmos::OptName : int
	Representation of socket option names. More...

enum class	cosmos::InterfaceIndex : int { INVALID = 0 , ANY = 0 }
	A network device interface index. More...

enum class	cosmos::MessageFlag : int { CONFIRM = MSG_CONFIRM , DONT_ROUTE = MSG_DONTROUTE , DONT_WAIT = MSG_DONTWAIT , END_OF_RECORD = MSG_EOR , MORE_DATA = MSG_MORE , NO_SIGNAL = MSG_NOSIGNAL , OUT_OF_BAND = MSG_OOB , FASTOPEN = MSG_FASTOPEN , CLOEXEC = MSG_CMSG_CLOEXEC , ERRQUEUE = MSG_ERRQUEUE , PEEK = MSG_PEEK , TRUNCATE = MSG_TRUNC , CTL_WAS_TRUNCATED = MSG_CTRUNC , WAIT_ALL = MSG_WAITALL , WAIT_FOR_ONE = MSG_WAITFORONE , ZEROCOPY = MSG_ZEROCOPY }
	Flags available for the send() and recv() family of socket I/O functions. More...

enum class	cosmos::UnixMessage : int { RIGHTS = SCM_RIGHTS , CREDENTIALS = SCM_CREDENTIALS }
	Ancillary message types available for UNIX domain sockets. More...

enum class	cosmos::IP4Message : int { RECVERR = IP_RECVERR , PKTINFO = IP_PKTINFO , ORIGDSTADDR = IP_ORIGDSTADDR , TOS = IP_TOS , TTL = IP_TTL }
	Ancillary message types available for IPv4 based sockets. More...

enum class	cosmos::IP6Message : int { RECVERR = IPV6_RECVERR , PKTINFO = IPV6_PKTINFO }
	Ancillary message types available for IPv6 based sockets. More...

Variables
constexpr size_t	cosmos::MAX_NET_INTERFACE_NAME = IFNAMSIZ
	Maximum length of a network device name in bytes.

constexpr size_t	cosmos::MAX_HOSTNAME = NI_MAXHOST
	Maximum length of a DNS hostname.

constexpr size_t	cosmos::MAX_SERVICE = NI_MAXSERV
	Maximum length of a port service name (from /etc/services).

constexpr net::HostInt32	cosmos::IP4_LOOPBACK_ADDR {INADDR_LOOPBACK}
	The loopback IPv4 address referring to the localhost.

constexpr net::HostInt32	cosmos::IP4_ANY_ADDR {INADDR_ANY}
	The any IPv4 address specifying all possible addresses or a "don't care" address for automatic assignment, depending on context.

constexpr net::HostInt32	cosmos::IP4_BROADCAST_ADDR {INADDR_BROADCAST}
	The IPv4 broadcast address to reach all hosts in the neighborhood.

constexpr IP6RawAddress	cosmos::IP6_LOOPBACK {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1}
	The binary loopback IPv6 address `::1` referring to the localhost.

constexpr IP6RawAddress	cosmos::IP6_ANY_ADDR {}
	The binary IPv6 "any" address `::` specifying all possible addresses or a "don't care" address for automatic assignment, depending on context.

Detailed Description

Basic types used in networking APIs.

Definition in file types.hxx.

Typedef Documentation

◆ MessageFlags

using cosmos::MessageFlags = BitMask<MessageFlag>

Definition at line 254 of file types.hxx.

◆ SocketFlags

using cosmos::SocketFlags = BitMask<SocketFlag>

Collection of SocketFlag used for creating sockets.

Definition at line 82 of file types.hxx.

Enumeration Type Documentation

◆ InterfaceIndex

enum class cosmos::InterfaceIndex : int

strong

A network device interface index.

Linux APIs are somewhat inconsistent about the type of this. E.g. in the sockaddr_in6 structure it is an uint32_t while in netdevice it is an int. So the signedness is unclear. In LinkLayerAddress it is also an int.

Enumerator
ANY	zero is in some contexts used for invalid (non-existing) devices.

Definition at line 119 of file types.hxx.

                          : int {
        INVALID = 0, 
        ANY     = 0, 
};

◆ IP4Message

enum class cosmos::IP4Message : int

strong

Ancillary message types available for IPv4 based sockets.

Enumerator
RECVERR	See also IPOptions::setReceiveErrors().
PKTINFO	See also IPOptions::setReceivePktInfo().
ORIGDSTADDR	See also IPOptions::setReceiveOrigDestAddr().
TOS	See also IPOptions::setReceiveTOS().
TTL	See also IPOptions::setReceiveTTL().

Definition at line 266 of file types.hxx.

                      : int {
        RECVERR = IP_RECVERR,
        PKTINFO = IP_PKTINFO,
        ORIGDSTADDR = IP_ORIGDSTADDR,
        TOS = IP_TOS,
        TTL = IP_TTL,
};

◆ IP6Message

enum class cosmos::IP6Message : int

strong

Ancillary message types available for IPv6 based sockets.

Definition at line 280 of file types.hxx.

                      : int {
        RECVERR = IPV6_RECVERR,
        PKTINFO = IPV6_PKTINFO
};

◆ MessageFlag

enum class cosmos::MessageFlag : int

strong

Flags available for the send() and recv() family of socket I/O functions.

Enumerator
CONFIRM	Inform the link layer that a successful reply was received from the other side. If this is not received then the link layer will probe the peer using ARP. This flag is only supported for SocketType::DGRAM and SocketType::RAW on SocketFamily::INET and SocketFamily::INET6.
DONT_ROUTE	Don't use a gateway to send out the packet, send only to directly connected networks. This is only supported for protocol families that route. It is typically used for routing protocols or diagnostic programs.
DONT_WAIT	Use non-blocking semantics for the I/O call. This is similar to setting OpenFlag::NONBLOCK on the file descriptor, but only affects a single I/O call as opposed to all calls referring to the same open file description.
END_OF_RECORD	Terminates a record. This is only for socket types that support it like SocketType::SEQPACKET.
MORE_DATA	Indicate that more data to send is to follow. This is supported for UDP and TCP sockets. Data from multiple `send()` calls will be merged until a call without this flag set occurs. For UDP sockets the data will be combined into a single datagram.
NO_SIGNAL	Don't send a SIGPIPE signal if a stream oriented connection is closed.
OUT_OF_BAND	Send or receive out of band data on protocols that support this.
FASTOPEN	Attempt a TCP fast-open and send data in the SYNC like a combined connect() and write().
CLOEXEC	For SocketFamily::UNIX this requests for received file descriptors to carry the CLOEXEC flag.
ERRQUEUE	Request extended error messages to be received as ancillary messages.
PEEK	Return data from the beginning of the receive queue, without removing it from the queue.
TRUNCATE	Return the real length of a packet or datagram, even if longer than the supplied buffer. Warning For TCP sockets this has a different meaning: The received data will be discarded in the kernel and not be returned to the caller.
CTL_WAS_TRUNCATED	In recvmsg() `msg_flags` this indicates that some control data was discarded due to lack of space in the ancillary data buffer.
WAIT_ALL	Block on receiving until all requested data has been received. This may still return with (short, or empty) reads if a signal is caught, an error or disconnect occurs or the next data is of a different type. This has no effect on datagram sockets.
WAIT_FOR_ONE	Only for recvmsg(): Turn on DONT_WAIT after the first message has been received.
ZEROCOPY	Operate in zerocopy I/O mode. In this mode the call will return immediately and the kernel will use the userspace buffer while the process continues to run. This of course opens the possibility for buffer corruption while the kernel still uses it. Kernel stability will not be affected, but the processed network data can suffer from this, naturally. This is currently only supported for TCP. See Linux kernel documentation `msg_zerocopy.rst`. When the kernel has finished transferring the data then an extended socket error message will be sent that can be obtained via `recvmsg()`. To use this flag socket SocketOptions::setZeroCopy() needs to be set on the socket.

Definition at line 168 of file types.hxx.

                       : int {
 
        CONFIRM = MSG_CONFIRM,
 
        DONT_ROUTE = MSG_DONTROUTE,
 
        DONT_WAIT = MSG_DONTWAIT,
 
        END_OF_RECORD = MSG_EOR,
 
        MORE_DATA = MSG_MORE,
        NO_SIGNAL = MSG_NOSIGNAL,
        OUT_OF_BAND = MSG_OOB,
        FASTOPEN = MSG_FASTOPEN,
        CLOEXEC = MSG_CMSG_CLOEXEC,
        ERRQUEUE = MSG_ERRQUEUE,
        PEEK = MSG_PEEK,
 
        TRUNCATE = MSG_TRUNC,
        CTL_WAS_TRUNCATED = MSG_CTRUNC,
 
        WAIT_ALL = MSG_WAITALL,
        WAIT_FOR_ONE = MSG_WAITFORONE,
 
        ZEROCOPY = MSG_ZEROCOPY
};

◆ OptLevel

enum class cosmos::OptLevel : int

strong

Representation of socket option levels.

These levels are used in the different socket options available for sockets. It is an ioctl like API that differentiates the available controls based on this option level.

Enumerator
SOCKET	used for generic socket options and UNIX domain sockets

Definition at line 90 of file types.hxx.

                    : int {
        SOCKET = SOL_SOCKET, 
        IP     = IPPROTO_IP,
        IPV6   = IPPROTO_IPV6,
        TCP    = IPPROTO_TCP,
        UDP    = IPPROTO_UDP
};

◆ OptName

enum class cosmos::OptName : int

strong

Representation of socket option names.

The constants for options are many and widespread, we just use this type for readability currently and don't model every possible value here.

Definition at line 103 of file types.hxx.

103: int {};

◆ SocketFamily

enum class cosmos::SocketFamily : int

strong

A socket's family setting.

The socket family determines the basic underlying mechanism used for the socket.

Note: The integer used for family is an int at the socket() call but an unsigned short int (sa_family_t) within sockaddr structures.

Enumerator
UNSPEC	Unknown / not specified.
INET	IPv4.
INET6	IPv6.
UNIX	UNIX domain sockets.
NETLINK	Netlink sockets talking to the kernel.
PACKET	Network device level packets (raw).

Definition at line 37 of file types.hxx.

                        : int {
        UNSPEC  = AF_UNSPEC,  
        INET    = AF_INET,    
        INET6   = AF_INET6,   
        UNIX    = AF_UNIX,    
        NETLINK = AF_NETLINK, 
        PACKET  = AF_PACKET,  
};

◆ SocketFlag

enum class cosmos::SocketFlag : int

strong

Additional socket settings used during socket creation.

Enumerator
CLOEXEC	the new socket fd will be automatically closed on exec().
NONBLOCK	the socket will be operating in non-blocking mode.

Definition at line 76 of file types.hxx.

                      : int {
        CLOEXEC   = SOCK_CLOEXEC,  
        NONBLOCK  = SOCK_NONBLOCK, 
};

◆ SocketProtocol

enum class cosmos::SocketProtocol : int

strong

Specific protocol to use on a socket.

This is usually specified as zero (DEFAULT) but some special sockets may offer different options.

For IP these numbers correspond to the protocols found in /etc/protocols.

For packet sockets these numbers correspond to the ethernet 802.3 ethernet protocol ID.

Enumerator
DEFAULT	if used on a packet socket then no packets will be received (until bind).

Definition at line 71 of file types.hxx.

                          : int {
        DEFAULT = 0, 
};

◆ SocketType

enum class cosmos::SocketType : int

strong

A socket's type setting.

The socket type defines a socket's properties in more detail beyond what the SocketFamily already does. In particular it defines the kind of guarantees that the network communication using this socket will offer.

Enumerator
ANY	can be used in AddressHints to return any socket types.
STREAM	connection oriented, reliable, in-order, but no record boundaries.
DGRAM	connection-less, unreliable, unordered with length limitation, keeps message boundaries.
RAW	raw packets as seen on network device level.
SEQPACKET	connection oriented, in-order, reliable with length limitation, keeps message boundaries.
RDM	reliably delivered messages, datagrams without ordering, keeps boundaries.

Definition at line 52 of file types.hxx.

                      : int {
        ANY       = 0,                
        STREAM    = SOCK_STREAM,      
        DGRAM     = SOCK_DGRAM,       
        RAW       = SOCK_RAW,         
        SEQPACKET = SOCK_SEQPACKET,   
        RDM       = SOCK_RDM,         
};

◆ UnixMessage

enum class cosmos::UnixMessage : int

strong

Ancillary message types available for UNIX domain sockets.

Enumerator
RIGHTS	file descriptor passing.

Definition at line 259 of file types.hxx.

                       : int {
        RIGHTS = SCM_RIGHTS, 
        CREDENTIALS = SCM_CREDENTIALS
        //SECURITY = SCM_SECURITY // the define for this seems to be missing?
};

Variable Documentation

◆ IP4_ANY_ADDR

net::HostInt32 cosmos::IP4_ANY_ADDR {INADDR_ANY}

constexpr

The any IPv4 address specifying all possible addresses or a "don't care" address for automatic assignment, depending on context.

Definition at line 137 of file types.hxx.

137{INADDR_ANY};

◆ IP4_BROADCAST_ADDR

net::HostInt32 cosmos::IP4_BROADCAST_ADDR {INADDR_BROADCAST}

constexpr

The IPv4 broadcast address to reach all hosts in the neighborhood.

Definition at line 139 of file types.hxx.

139{INADDR_BROADCAST};

◆ IP4_LOOPBACK_ADDR

net::HostInt32 cosmos::IP4_LOOPBACK_ADDR {INADDR_LOOPBACK}

constexpr

The loopback IPv4 address referring to the localhost.

Definition at line 135 of file types.hxx.

135{INADDR_LOOPBACK};

◆ IP6_ANY_ADDR

IP6RawAddress cosmos::IP6_ANY_ADDR {}

constexpr

The binary IPv6 "any" address :: specifying all possible addresses or a "don't care" address for automatic assignment, depending on context.

Definition at line 160 of file types.hxx.

160{};

◆ IP6_LOOPBACK

IP6RawAddress cosmos::IP6_LOOPBACK {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1}

constexpr

The binary loopback IPv6 address ::1 referring to the localhost.

Definition at line 158 of file types.hxx.

158{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1};

◆ MAX_HOSTNAME

size_t cosmos::MAX_HOSTNAME = NI_MAXHOST

constexpr

Maximum length of a DNS hostname.

Definition at line 109 of file types.hxx.

◆ MAX_NET_INTERFACE_NAME

size_t cosmos::MAX_NET_INTERFACE_NAME = IFNAMSIZ

constexpr

Maximum length of a network device name in bytes.

Definition at line 106 of file types.hxx.

◆ MAX_SERVICE

size_t cosmos::MAX_SERVICE = NI_MAXSERV

constexpr

Maximum length of a port service name (from /etc/services).

Definition at line 111 of file types.hxx.

Classes

Typedefs

Enumerations

Variables

Detailed Description

Typedef Documentation

◆ MessageFlags

◆ SocketFlags

Enumeration Type Documentation

◆ InterfaceIndex

◆ IP4Message

◆ IP6Message

◆ MessageFlag

◆ OptLevel

◆ OptName

◆ SocketFamily

◆ SocketFlag

◆ SocketProtocol

◆ SocketType

◆ UnixMessage

Variable Documentation

◆ IP4_ANY_ADDR

◆ IP4_BROADCAST_ADDR

◆ IP4_LOOPBACK_ADDR

◆ IP6_ANY_ADDR

◆ IP6_LOOPBACK

◆ MAX_HOSTNAME

◆ MAX_NET_INTERFACE_NAME

◆ MAX_SERVICE