Represents a TCP connection. More...

#include <tcp_stream_socket.hpp>

Inheritance diagram for caf::net::tcp_stream_socket:

Public Types
using	super = stream_socket

Public Types inherited from caf::net::stream_socket
using	super = network_socket
	The parent type.

using	transport_type = octet_stream::transport
	The default transport for exchanging raw bytes over a stream socket.

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

Related Symbols
(Note that these are not member symbols.)
expected< tcp_stream_socket > CAF_NET_EXPORT	make_connected_tcp_stream_socket (ip_endpoint node, timespan timeout=infinite)
	Creates a `tcp_stream_socket` connected to given remote node.

expected< tcp_stream_socket > CAF_NET_EXPORT	make_connected_tcp_stream_socket (const uri::authority_type &auth, timespan timeout=infinite)
	Creates a `tcp_stream_socket` connected to `auth`.

expected< tcp_stream_socket > CAF_NET_EXPORT	make_connected_tcp_stream_socket (std::string host, uint16_t port, timespan timeout=infinite)
	Creates a `tcp_stream_socket` connected to given `host` and `port`.

Related Symbols inherited from caf::net::stream_socket
expected< std::pair< stream_socket, stream_socket > > CAF_NET_EXPORT	make_stream_socket_pair ()
	Creates two connected sockets to mimic network communication (usually for testing purposes).

error CAF_NET_EXPORT	nodelay (stream_socket x, bool new_value)
	Enables or disables Nagle's algorithm on `x`.

ptrdiff_t CAF_NET_EXPORT	read (stream_socket x, byte_span buf)
	Receives data from `x`.

ptrdiff_t CAF_NET_EXPORT	write (stream_socket x, const_byte_span buf)
	Sends data to `x`.

ptrdiff_t CAF_NET_EXPORT	write (stream_socket x, std::initializer_list< const_byte_span > bufs)
	Transmits data from `x` to its peer.

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::stream_socket
constexpr stream_socket	fd () const noexcept

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 connection.

Friends And Related Symbol Documentation

◆ make_connected_tcp_stream_socket() [1/3]

expected< tcp_stream_socket > CAF_NET_EXPORT make_connected_tcp_stream_socket	(	const uri::authority_type &	auth,
		timespan	timeout = infinite )

Parameters

auth	Host and port of the remote node.
timeout	Maximum waiting time on the connection before canceling it.

Returns: The connected socket or an error.

Note: The timeout applies to a single connection attempt. If the DNS lookup for auth returns more than one possible IP address then the timeout applies to each connection attempt individually. For example, passing a timeout of one second with a DNS result of five entries would mean this function can block up to five seconds if all attempts time out.

◆ make_connected_tcp_stream_socket() [2/3]

expected< tcp_stream_socket > CAF_NET_EXPORT make_connected_tcp_stream_socket	(	ip_endpoint	node,
		timespan	timeout = infinite )

Parameters

node	Host and port of the remote node.
timeout	Maximum waiting time on the connection before canceling it.

Returns: The connected socket or an error.

◆ make_connected_tcp_stream_socket() [3/3]

expected< tcp_stream_socket > CAF_NET_EXPORT make_connected_tcp_stream_socket	(	std::string	host,
		uint16_t	port,
		timespan	timeout = infinite )

Parameters

host	TCP endpoint for connecting to.
port	TCP port of the server.
timeout	Maximum waiting time on the connection before canceling it.

Returns: The connected socket or an error.

Note: The timeout applies to a single connection attempt. If the DNS lookup for auth returns more than one possible IP address then the timeout applies to each connection attempt individually. For example, passing a timeout of one second with a DNS result of five entries would mean this function can block up to five seconds if all attempts time out.

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

libcaf_net/caf/net/tcp_stream_socket.hpp

Public Types

Related Symbols

Additional Inherited Members

Detailed Description

Friends And Related Symbol Documentation

◆ make_connected_tcp_stream_socket() [1/3]

◆ make_connected_tcp_stream_socket() [2/3]

◆ make_connected_tcp_stream_socket() [3/3]