caf::net::network_socket Struct Reference

A bidirectional network communication endpoint. More...

#include <network_socket.hpp>

Inheritance diagram for caf::net::network_socket:

Public Types
using	super = socket

Related Functions
(Note that these are not member functions.)
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_CONNRESETerror 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.
void CAF_NET_EXPORT	shutdown_read (network_socket x)
	Closes the read channel for a socket.
void CAF_NET_EXPORT	shutdown_write (network_socket x)
	Closes the write channel for a socket.
void CAF_NET_EXPORT	shutdown (network_socket x)
	Closes the both read and write channel for a socket.
error CAF_NET_EXPORT	keepalive (stream_socket x, bool new_value)
	Enables or disables keepalive on x.
Related Functions inherited from caf::net::socket
using	socket_id = int
	Platform-specific representation of a socket.
using	signed_socket_id = std::make_signed< socket_id >::type
	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 bidirectional network communication endpoint.

Friends And Related Function Documentation

send_buffer_size()

expected< size_t > CAF_NET_EXPORT send_buffer_size ( network_socket  x )

related

Get the socket buffer size for x.

Precondition

x != invalid_socket

---

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

• libcaf_net/caf/net/network_socket.hpp
• libcaf_net/caf/net/stream_socket.hpp