Template class for IPv4 and IPv6 based UDP datagram sockets. More...

#include <UDPSocket.hxx>

Inheritance diagram for cosmos::UDPSocketT< FAMILY >:

Public Types
using	IPAddress = typename IPSocketT<FAMILY>::IPAddress

Public Types inherited from cosmos::IPSocketT< FAMILY >
using	IPAddress = typename FamilyTraits<FAMILY>::Address

Public Types inherited from cosmos::Socket
enum class	Direction : int { READ = SHUT_RD , WRITE = SHUT_WR , READ_WRITE = SHUT_RDWR }
	Type used in Socket::shutdown(). More...

using	AddressFilledIn = NamedBool<struct addr_filled_in_t, false>
	Boolean flag used in receiveFrom() to signify if a peer address could be provided.

Public Types inherited from cosmos::StreamIO
enum class	SeekType : int { SET = SEEK_SET , CUR = SEEK_CUR , END = SEEK_END , DATA = SEEK_DATA , HOLE = SEEK_HOLE }
	Different methods for changing the file read/write position. More...

Public Member Functions
	UDPSocketT (const SocketFlags flags=SocketFlags{SocketFlag::CLOEXEC})

auto	udpOptions ()

auto	udpOptions () const

void	bind (const IPAddress &addr)
	Bind to the given IP address.

void	connect (const IPAddress &addr)
	Connect to the given IP address.

std::pair< size_t, std::optional< IPAddress > >	receiveFrom (void *buf, size_t length, const MessageFlags flags=MessageFlags{})
	Receive data and get the sender's IP address.

auto	sendTo (const void *buf, size_t length, const IPAddress &addr, const MessageFlags flags=MessageFlags{})
	Send data to a specific IP address.

auto	sendTo (const std::string_view data, const IPAddress &addr, const MessageFlags flags=MessageFlags{})

void	sendMessage (SendMessageHeader &header)

void	sendMessageTo (SendMessageHeader &header, const IPAddress &addr)

void	receiveMessage (ReceiveMessageHeader &header)

std::optional< IPAddress >	receiveMessageFrom (ReceiveMessageHeader &header)

size_t	send (const void *buf, size_t length, const MessageFlags flags=MessageFlags{})
	Send the given data over the socket, using specific send flags.

size_t	send (const std::string_view data, const MessageFlags flags=MessageFlags{})
	Variant of send() that takes a std::string_view container instead of a raw input buffer.

size_t	receive (void *buf, size_t length, const MessageFlags flags=MessageFlags{})
	Receive data from the socket, using specific receive flags.

Public Member Functions inherited from cosmos::IPSocketT< FAMILY >
auto	ipOptions ()

auto	ipOptions () const

void	getSockName (IPAddress &addr)
	Returns the current address that the socket is bound to, if any.

Public Member Functions inherited from cosmos::Socket
auto	sockOptions ()

auto	sockOptions () const

void	getSockName (SocketAddress &addr)
	Returns the current address that the socket is bound to, if any.

void	shutdown (const Direction dir)
	Shutdown part or all of the connection on protocol level.

Public Member Functions inherited from cosmos::FDFile
	FDFile (const FileDescriptor fd, const AutoCloseFD auto_close)
	Wrap the given file descriptor applying the specified auto-close behaviour.

	FDFile (FDFile &&other) noexcept

FDFile &	operator= (FDFile &&other) noexcept

void	open (const FileDescriptor fd, const AutoCloseFD auto_close)
	Takes the already open file descriptor fd and operates on it.

void	close () override
	Close the current file object.

Public Member Functions inherited from cosmos::FileBase
	FileBase (const FileBase &)=delete

FileBase &	operator= (const FileBase &)=delete

bool	isOpen () const
	Returns whether currently a FileDescriptor is opened.

FileDescriptor	fd () const
	Allows access to the underlying fd with const semantics.

void	truncate (const off_t length)

Public Member Functions inherited from cosmos::StreamIO
	StreamIO (FileDescriptor &fd)

	StreamIO (const StreamIO &)=delete

StreamIO &	operator= (const StreamIO &)=delete

StreamIO &	operator= (StreamIO &&) noexcept

size_t	read (void *buf, size_t length)
	Read up to `length` bytes from the file into `buf`.

size_t	write (const void *buf, size_t length)
	Write up to `length` bytes from `buf` into the underlying file.

size_t	write (const std::string_view data)
	string_view wrapper around write(const void*, size_t).

void	readAll (void *buf, size_t length)
	Read all `length` bytes from the underlying file.

void	readAll (std::string &s, size_t length)
	Like readAll(void*, size_t) using an STL string.

void	writeAll (const void *buf, size_t length)
	Write all `length` bytes into the underlying file.

void	writeAll (const std::string_view data)
	string_view wrapper around writeAll(const void*, size_t).

bool	read (ReadIOVector &iovec)
	Read data from file into a vector of data regions.

bool	write (WriteIOVector &iovec)
	Write data to file from a vector of data regions.

void	readAll (ReadIOVector &iovec)
	Read into all data regions specified in `iovec`.

void	writeAll (WriteIOVector &iovec)
	Write all data regions specified in `iovec`.

off_t	seek (const SeekType type, off_t off)
	Seek to the given offset based on the given offset `type`.

off_t	seekFromStart (off_t off)
	Seek to the given offset relative to the start of the file.

off_t	seekFromCurrent (off_t off)
	Seek to the given offset relative to the current file position.

off_t	seekFromEnd (off_t off)
	Seek to the given offset relative to the end of the file.

Static Public Attributes
static constexpr auto	TYPE = SocketType::DGRAM

Additional Inherited Members
Protected Member Functions inherited from cosmos::IPSocketT< FAMILY >
	IPSocketT (const SocketType type, const SocketFlags flags=SocketFlags{SocketFlag::CLOEXEC}, const SocketProtocol protocol=SocketProtocol::DEFAULT)

	IPSocketT (FileDescriptor fd, const AutoCloseFD auto_close)

Protected Member Functions inherited from cosmos::Socket
	Socket (const SocketFamily family, const SocketType type, const SocketFlags flags=SocketFlags{SocketFlag::CLOEXEC}, const SocketProtocol protocol=SocketProtocol::DEFAULT)
	Creates a new socket using the given properties.

	Socket (FileDescriptor fd, const AutoCloseFD auto_close)
	Creates a new socket from the given existing file descriptor.

void	bind (const SocketAddress &addr)
	Bind the socket to the given local address.

void	connect (const SocketAddress &addr)
	Establish a new connection using the given destination address.

void	listen (const size_t backlog)
	Enter into a passive listen state, allowing new connections.

FileDescriptor	accept (SocketAddress *addr)
	Accept a new connection on the socket.

size_t	send (const void *buf, size_t length, const MessageFlags flags=MessageFlags{})
	Send the given data over the socket, using specific send flags.

size_t	send (const std::string_view data, const MessageFlags flags=MessageFlags{})
	Variant of send() that takes a std::string_view container instead of a raw input buffer.

size_t	sendTo (const void *buf, size_t length, const SocketAddress &addr, const MessageFlags flags=MessageFlags{})
	Send a packet to a specific destination address.

size_t	sendTo (const std::string_view data, const SocketAddress &addr, const MessageFlags flags=MessageFlags{})
	Variant of sendTo() that takes a std::string_view container instead of a raw input buffer.

void	sendMessage (SendMessageHeader &header, const SocketAddress *addr=nullptr)
	Sends a message over the socket using extended SendMessageHeader data.

size_t	receive (void *buf, size_t length, const MessageFlags flags=MessageFlags{})
	Receive data from the socket, using specific receive flags.

std::pair< size_t, AddressFilledIn >	receiveFrom (void *buf, size_t length, SocketAddress &addr, const MessageFlags flags=MessageFlags{})
	Receive a packet, filling in the sender's address.

AddressFilledIn	receiveMessage (ReceiveMessageHeader &header, SocketAddress *addr=nullptr)
	Receives a message from the socket using extended ReceiveMessageHeader data.

Protected Member Functions inherited from cosmos::FileBase
	FileBase (const FileDescriptor fd=FileDescriptor{})

	FileBase (FileBase &&other) noexcept

FileBase &	operator= (FileBase &&other) noexcept

Protected Attributes inherited from cosmos::FDFile
AutoCloseFD	m_auto_close

Protected Attributes inherited from cosmos::FileBase
FileDescriptor	m_fd

Protected Attributes inherited from cosmos::StreamIO
FileDescriptor &	m_stream_fd

Detailed Description

template<SocketFamily FAMILY>
class cosmos::UDPSocketT< FAMILY >

Template class for IPv4 and IPv6 based UDP datagram sockets.

Use cosmos::UDP4Socket for the IPv4 variant and cosmos::UDP6Socket for the IPv6 variant of this type. This type offers access to UDP socket specific socket options. Furthermore it makes the bind() and connect() functions accessible for their respective IP address type.

The send and receive I/O functions are also available to send and receive datagrams using specific MessageFlags.

Definition at line 24 of file UDPSocket.hxx.

Member Typedef Documentation

◆ IPAddress

template<SocketFamily FAMILY>

using cosmos::UDPSocketT< FAMILY >::IPAddress = typename IPSocketT<FAMILY>::IPAddress

Definition at line 28 of file UDPSocket.hxx.

Constructor & Destructor Documentation

◆ UDPSocketT()

template<SocketFamily FAMILY>

cosmos::UDPSocketT< FAMILY >::UDPSocketT ( const SocketFlags flags = SocketFlags{SocketFlag::CLOEXEC} )

inlineexplicit

Definition at line 33 of file UDPSocket.hxx.

                                                                 {SocketFlag::CLOEXEC}) :
                        IPSocketT<FAMILY>{TYPE, flags} {
        }

Member Function Documentation

◆ bind()

template<SocketFamily FAMILY>

void cosmos::UDPSocketT< FAMILY >::bind ( const IPAddress & addr )

inline

Bind to the given IP address.

To receive packets, the UDP socket can be bound to a local address and port. If this is not done then the kernel with bind to IP4_ANY_ADDR and a free local port from the ip_local_port_range found in /proc.

See also: Socket::bind

Definition at line 54 of file UDPSocket.hxx.

                                         {
                return Socket::bind(addr);
        }

◆ connect()

template<SocketFamily FAMILY>

void cosmos::UDPSocketT< FAMILY >::connect ( const IPAddress & addr )

inline

Connect to the given IP address.

By connecting a UDP socket a default destination is configured. After this is done a regular write() or send() can be used to send to this default destination.

The sendTo() method can still be used to send to a specific address.

See also: Socket::connect

Definition at line 69 of file UDPSocket.hxx.

                                            {
                return Socket::connect(addr);
        }

◆ receive()

template<SocketFamily FAMILY>

size_t cosmos::Socket::receive	(	void *	buf,
		size_t	length,
		const MessageFlags	flags = MessageFlags{} )

Receive data from the socket, using specific receive flags.

This is like a regular read() call but allows to specify socket specific MessageFlags to adjust various behaviour.

Definition at line 204 of file Socket.cxx.

                                                                         {
        const auto res = ::recv(to_integral(m_fd.raw()), buf, length, flags.raw());
        if (res < 0) {
                cosmos_throw(ApiError("recv()"));
        }
 
        return static_cast<size_t>(res);
}

◆ receiveFrom()

template<SocketFamily FAMILY>

std::pair< size_t, std::optional< IPAddress > > cosmos::UDPSocketT< FAMILY >::receiveFrom	(	void *	buf,
		size_t	length,
		const MessageFlags	flags = MessageFlags{} )

inline

Receive data and get the sender's IP address.

If possible the senders IP address will be returned. This may not be possible in which case std::nullopt will be returned instead.

See also: Socket::receiveFrom().

Definition at line 80 of file UDPSocket.hxx.

                                                                                         {}) {
                IPAddress addr;
                auto [len, filled] = Socket::receiveFrom(buf, length, addr, flags);
 
                return {len, filled ? std::optional<IPAddress>{addr} : std::nullopt};
        }

◆ receiveMessage()

template<SocketFamily FAMILY>

void cosmos::UDPSocketT< FAMILY >::receiveMessage ( ReceiveMessageHeader & header )

inline

Definition at line 111 of file UDPSocket.hxx.

                                                          {
                (void)Socket::receiveMessage(header);
        }

◆ receiveMessageFrom()

template<SocketFamily FAMILY>

std::optional< IPAddress > cosmos::UDPSocketT< FAMILY >::receiveMessageFrom ( ReceiveMessageHeader & header )

inline

Definition at line 115 of file UDPSocket.hxx.

                                                                                {
                IPAddress addr;
                auto filled = Socket::receiveMessage(header, &addr);
 
                return filled ? std::optional<IPAddress>{addr} : std::nullopt;
        }

◆ send() [1/2]

template<SocketFamily FAMILY>

size_t cosmos::Socket::send	(	const std::string_view	data,
		const MessageFlags	flags = MessageFlags{} )

inline

Variant of send() that takes a std::string_view container instead of a raw input buffer.

Definition at line 153 of file Socket.hxx.

                                                                                      {}) {
                return send(data.data(), data.size(), flags);
        }

◆ send() [2/2]

template<SocketFamily FAMILY>

size_t cosmos::Socket::send	(	const void *	buf,
		size_t	length,
		const MessageFlags	flags = MessageFlags{} )

Send the given data over the socket, using specific send flags.

This is like a regular write() call but allows to specify socket specific MessageFlags to adjust various behaviour.

Definition at line 150 of file Socket.cxx.

                                                                            {
        const auto res = ::send(to_integral(m_fd.raw()), buf, length, flags.raw());
        if (res < 0) {
                cosmos_throw(ApiError("send()"));
        }
 
        return static_cast<size_t>(res);
}

◆ sendMessage()

template<SocketFamily FAMILY>

void cosmos::UDPSocketT< FAMILY >::sendMessage ( SendMessageHeader & header )

inline

Definition at line 103 of file UDPSocket.hxx.

                                                    {
                return Socket::sendMessage(header);
        }

◆ sendMessageTo()

template<SocketFamily FAMILY>

void cosmos::UDPSocketT< FAMILY >::sendMessageTo	(	SendMessageHeader &	header,
		const IPAddress &	addr )

inline

Definition at line 107 of file UDPSocket.hxx.

                                                                             {
                return Socket::sendMessage(header, &addr);
        }

◆ sendTo() [1/2]

template<SocketFamily FAMILY>

auto cosmos::UDPSocketT< FAMILY >::sendTo	(	const std::string_view	data,
		const IPAddress &	addr,
		const MessageFlags	flags = MessageFlags{} )

inline

Definition at line 96 of file UDPSocket.hxx.

                                                                                                             {}) {
                return sendTo(data.data(), data.size(), addr, flags);
        }

◆ sendTo() [2/2]

template<SocketFamily FAMILY>

auto cosmos::UDPSocketT< FAMILY >::sendTo	(	const void *	buf,
		size_t	length,
		const IPAddress &	addr,
		const MessageFlags	flags = MessageFlags{} )

inline

Send data to a specific IP address.

See also: Socket::sendTo().

Definition at line 92 of file UDPSocket.hxx.

                                                                                                                  {}) {
                return Socket::sendTo(buf, length, addr, flags);
        }

◆ udpOptions() [1/2]

template<SocketFamily FAMILY>

auto cosmos::UDPSocketT< FAMILY >::udpOptions ( )

inline

Definition at line 37 of file UDPSocket.hxx.

                          {
                return UDPOptions{this->m_fd};
        }

◆ udpOptions() [2/2]

template<SocketFamily FAMILY>

auto cosmos::UDPSocketT< FAMILY >::udpOptions ( ) const

inline

Definition at line 41 of file UDPSocket.hxx.

                                {
                return UDPOptions{this->m_fd};
        }

Member Data Documentation

◆ TYPE

template<SocketFamily FAMILY>

auto cosmos::UDPSocketT< FAMILY >::TYPE = SocketType::DGRAM

inlinestaticconstexpr

Definition at line 29 of file UDPSocket.hxx.

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

include/net/UDPOptions.hxx
include/net/UDPSocket.hxx

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ IPAddress

Constructor & Destructor Documentation

◆ UDPSocketT()

Member Function Documentation

◆ bind()

◆ connect()

◆ receive()

◆ receiveFrom()

◆ receiveMessage()

◆ receiveMessageFrom()

◆ send() [1/2]

◆ send() [2/2]

◆ sendMessage()

◆ sendMessageTo()

◆ sendTo() [1/2]

◆ sendTo() [2/2]

◆ udpOptions() [1/2]

◆ udpOptions() [2/2]

Member Data Documentation

◆ TYPE