caf::net::tcp_accept_socket Struct Reference

Represents a TCP acceptor in listening mode. More...

#include <tcp_accept_socket.hpp>

Inheritance diagram for caf::net::tcp_accept_socket:

Public Types
using	super = network_socket
	The parent type.
using	transport_type = octet_stream::transport
	The default transport for exchanging raw bytes over accepted sockets.
Public Types inherited from caf::net::network_socket
using	super = socket

Related Symbols
(Note that these are not member symbols.)
expected< tcp_accept_socket > CAF_NET_EXPORT	make_tcp_accept_socket (ip_endpoint node, bool reuse_addr=true)
	Creates a new TCP socket to accept connections on a given port.
expected< tcp_accept_socket > CAF_NET_EXPORT	make_tcp_accept_socket (const uri::authority_type &node, bool reuse_addr=true)
	Creates a new TCP socket to accept connections on a given port.
expected< tcp_accept_socket > CAF_NET_EXPORT	make_tcp_accept_socket (uint16_t port, std::string addr="0.0.0.0", bool reuse_addr=true)
	Creates a new TCP socket to accept connections on a given port.
expected< tcp_stream_socket > CAF_NET_EXPORT	accept (tcp_accept_socket x)
	Accepts a connection on x.
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_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.
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

Represents a TCP acceptor in listening mode.

Friends And Related Symbol Documentation

accept()

expected< tcp_stream_socket > CAF_NET_EXPORT accept ( tcp_accept_socket x )

related

Accepts a connection on x.

Parameters

x	Listening endpoint.

Returns

The socket that handles the accepted connection on success, an error otherwise.

make_tcp_accept_socket() [1/3]

expected< tcp_accept_socket > CAF_NET_EXPORT make_tcp_accept_socket ( const uri::authority_type & node, bool reuse_addr = true )

related

Creates a new TCP socket to accept connections on a given port.

Parameters

node	The endpoint to listen on and the filter for incoming addresses. Passing the address 0.0.0.0 will accept incoming connection from any host. Passing port 0 lets the OS choose the port.
reuse_addr	Optionally sets the SO_REUSEADDR option on the socket.

make_tcp_accept_socket() [2/3]

expected< tcp_accept_socket > CAF_NET_EXPORT make_tcp_accept_socket ( ip_endpoint node, bool reuse_addr = true )

related

Creates a new TCP socket to accept connections on a given port.

Parameters

node	The endpoint to listen on and the filter for incoming addresses. Passing the address 0.0.0.0 will accept incoming connection from any host. Passing port 0 lets the OS choose the port.

make_tcp_accept_socket() [3/3]

expected< tcp_accept_socket > CAF_NET_EXPORT make_tcp_accept_socket ( uint16_t port, std::string addr = "0.0.0.0", bool reuse_addr = true )

related

Creates a new TCP socket to accept connections on a given port.

Parameters

port	The port for listening to incoming connection. Passing 0 lets the OS choose a port.
addr	The filter for incoming addresses. Passing the address 0.0.0.0 will accept incoming connection from any host.
reuse_addr	Optionally sets the SO_REUSEADDR option on the socket.

---

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

• libcaf_net/caf/net/tcp_accept_socket.hpp