A datagram-oriented network communication endpoint for bidirectional byte transmission. More...

#include <udp_datagram_socket.hpp>

Inheritance diagram for caf::net::udp_datagram_socket:

Public Types
using	super = datagram_socket

Public Types inherited from caf::net::datagram_socket
using	super = network_socket

Public Types inherited from caf::net::network_socket
using	super = socket

Related Symbols
(Note that these are not member symbols.)
expected< udp_datagram_socket > CAF_NET_EXPORT	make_udp_datagram_socket (ip_endpoint ep, bool reuse_addr=true)
	Creates a `udp_datagram_socket` bound to given port.

ptrdiff_t CAF_NET_EXPORT	read (udp_datagram_socket x, byte_span buf, ip_endpoint *src=nullptr)
	Receives the next datagram on socket `x`.

ptrdiff_t CAF_NET_EXPORT	write (udp_datagram_socket x, const_byte_span buf, ip_endpoint ep)
	Sends the content of `buf` as a datagram to the endpoint `ep` on socket `x`.

Related Symbols inherited from caf::net::datagram_socket
error CAF_NET_EXPORT	allow_connreset (datagram_socket x, bool new_value)
	Enables or disables `SIO_UDP_CONNRESET` error on `x`.

std::variant< size_t, sec > CAF_NET_EXPORT	check_datagram_socket_io_res (std::make_signed_t< size_t > res)
	Converts the result from I/O operation on a datagram_socket to either an error code or a integer greater or equal to zero.

Related Symbols inherited from caf::net::network_socket
error CAF_NET_EXPORT	allow_sigpipe (network_socket x, bool new_value)
	Enables or disables `SIGPIPE` events from `x`.

error CAF_NET_EXPORT	allow_udp_connreset (network_socket x, bool new_value)
	Enables or disables `SIO_UDP_CONNRESET`error on `x`.

expected< size_t > CAF_NET_EXPORT	send_buffer_size (network_socket x)
	Get the socket buffer size for `x`.

error CAF_NET_EXPORT	send_buffer_size (network_socket x, size_t capacity)
	Set the socket buffer size for `x`.

expected< uint16_t > CAF_NET_EXPORT	local_port (network_socket x)
	Returns the locally assigned port of `x`.

expected< std::string > CAF_NET_EXPORT	local_addr (network_socket x)
	Returns the locally assigned address of `x`.

expected< uint16_t > CAF_NET_EXPORT	remote_port (network_socket x)
	Returns the port used by the remote host of `x`.

expected< std::string > CAF_NET_EXPORT	remote_addr (network_socket x)
	Returns the remote host address of `x`.

error CAF_NET_EXPORT	keepalive (stream_socket x, bool new_value)
	Enables or disables keepalive on `x`.

Related Symbols inherited from caf::net::socket
using	socket_id = int
	Platform-specific representation of a socket.

using	signed_socket_id = std::make_signed_t<socket_id>
	Signed counterpart of `socket_id`.

template<class Inspector >
bool	inspect (Inspector &f, socket &x)

void CAF_NET_EXPORT	close (socket x)
	Closes socket `x`.

std::errc CAF_NET_EXPORT	last_socket_error ()
	Returns the last socket error in this thread as an integer.

bool CAF_NET_EXPORT	last_socket_error_is_temporary ()
	Checks whether `last_socket_error()` would return an error code that indicates a temporary error.

std::string CAF_NET_EXPORT	last_socket_error_as_string ()
	Returns the last socket error as human-readable string.

bool CAF_NET_EXPORT	probe (socket x)
	Queries whether `x` is a valid and connected socket by reading the socket option `SO_ERROR`.

error CAF_NET_EXPORT	child_process_inherit (socket x, bool new_value)
	Sets x to be inherited by child processes if `new_value == true` or not if `new_value == false`.

error CAF_NET_EXPORT	nonblocking (socket x, bool new_value)
	Enables or disables nonblocking I/O on `x`.

error CAF_NET_EXPORT	shutdown_read (socket x)
	Disallows further reads from the socket.

error CAF_NET_EXPORT	shutdown_write (socket x)
	Disallows further writes to the socket.

Additional Inherited Members
Public Member Functions inherited from caf::net::socket
constexpr	socket (socket_id id) noexcept

constexpr	socket (const socket &other) noexcept=default

socket &	operator= (const socket &other) noexcept=default

constexpr signed_socket_id	compare (socket other) const noexcept

constexpr	operator bool () const noexcept

constexpr bool	operator! () const noexcept

constexpr socket	fd () const noexcept

Public Attributes inherited from caf::net::socket
socket_id	id

Detailed Description

A datagram-oriented network communication endpoint for bidirectional byte transmission.

Friends And Related Symbol Documentation

◆ make_udp_datagram_socket()

expected< udp_datagram_socket > CAF_NET_EXPORT make_udp_datagram_socket	(	ip_endpoint	ep,
		bool	reuse_addr = true )

Parameters

ep	ip_endpoint that contains the port to bind to. Pass port '0' to bind to any unused port - The endpoint will be updated with the specific port that was bound.

Returns: The connected socket or an error.

◆ read()

ptrdiff_t CAF_NET_EXPORT read	(	udp_datagram_socket	x,
		byte_span	buf,
		ip_endpoint *	src = nullptr )

Parameters

x	The UDP socket for receiving datagrams.
buf	Writable output buffer.
src	If non-null, CAF optionally stores the address of the sender for the datagram.

Returns: The number of received bytes on success, 0 if the socket is closed, or -1 in case of an error.

Postcondition: buf was modified and the resulting integer represents the length of the received datagram, even if it did not fit into the given buffer.

◆ write()

ptrdiff_t CAF_NET_EXPORT write	(	udp_datagram_socket	x,
		const_byte_span	buf,
		ip_endpoint	ep )

Parameters

x	The UDP socket for sending datagrams.
buf	The buffer to send.
ep	The endpoint to send the datagram to.

Returns: The number of written bytes on success, otherwise an error code.

The documentation for this struct was generated from the following file:

libcaf_net/caf/net/udp_datagram_socket.hpp

Public Types

Related Symbols

Additional Inherited Members

Detailed Description

Friends And Related Symbol Documentation

◆ make_udp_datagram_socket()

◆ read()

◆ write()