Alias to ucred system type.

Message header type for sending and receiving low-level socket messages.

Message header type for sending and receiving ancillary data through socket.

Socket types.

• stream = SOCK_STREAM
• datagram = SOCK_DGRAM
• raw = SOCK_RAW

Socket shutdown options.

• read = SHUT_RD
• write = SHUT_WR
• read_write = SHUT_RDWR

Socket wrapper.

• Socket is a file descriptor which is used for communication.
• Usually, sockets are used for network communication.
• The socket is non-blocking and automatically closed on child process execution.

Base classes

• public sys::fildes

Derived classes

• sys::netlink_socket

Types

• using protocol_type = int

  Protocol number type.

• using duration = clock_type::duration

  Duration type.

• using clock_type = std::chrono::system_clock

  Clock type used in this class.

Enumerations

• enum message_flags: int
• enum option: int

  Socket options.

• enum tcp_options: int
• enum options: int

Methods

• socket(fd_type sock)explicitprotected

  Construct the socket with bare file descriptor.

• swap(socket & rhs) -> void

  Swap with rhs.

• receive_fds(fd_type * data, size_t n) -> void

  Receive an array of n file descriptors pointed by data.

  bad_call

  
  

  See

  cmsg(3)

  See

  unix(7)

  Note

  The method works only for unix domain sockets.

• send_fds(const fd_type * data, size_t n) -> void

  Send an array of n file descriptors pointed by data.

  bad_call

  
  

  See

  cmsg(3)

  See

  unix(7)

  Note

  The method works only for unix domain sockets.

• send(const void * buf, size_t n, int flags = 0) const -> ssize_t

  Write n bytes from buffer pointed by buf to the socket.

  bad_call

  if system error occurs, except std::errc::resource_unavailable_try_again and std::errc::operation_in_progress

  
  

  See

  std::errc

  See

  send(2)

• receive(void * buf, size_t n, int flags = 0) const -> ssize_t

  Read n bytes from the socket and store them in buffer pointed by buf.

  bad_call

  if system error occurs, except std::errc::resource_unavailable_try_again and std::errc::operation_in_progress

  
  

  See

  std::errc

  See

  recv(2)

• receive(message_header & hdr, int flags) const -> UNISTDX_DEPRECATED ssize_t
• receive(message_header & hdr, message_flags flags = message_flags{}) const -> ssize_t

  Receive low-level message hdr over the socket.

  bad_call

  if system error occurs, except std::errc::resource_unavailable_try_again and std::errc::operation_in_progress

  
  

  See

  std::errc

  See

  recvmsg(2)

• send(const message_header & hdr, int flags) const -> UNISTDX_DEPRECATED ssize_t
• send(const message_header & hdr, message_flags flags = message_flags{}) const -> ssize_t

  Send low-level message hdr through the socket.

  bad_call

  if system error occurs, except std::errc::resource_unavailable_try_again and std::errc::operation_in_progress

  
  

  See

  std::errc

  See

  sendmsg(2)

• peer_name() const -> socket_address

  Get address of the client, connected to the socket.

  bad_call

  
  

  See

  getpeername(2)

• name() const -> socket_address

  Get bound socket address.

  bad_call

  
  

  See

  getsockname(2)

• bind_addr() const -> socket_address

  Get bound socket address. The same as name, but does not throw.

  See

  getsockname(2)

• credentials() const -> user_credentials

  Get UID, GID and PID of the process, that is connected to this socket (client).

  bad_call

  
  

  See

  getsockopt(2)

  Note

  The method works only for unix domain sockets.

• set_user_timeout(duration d) -> void

  Set TCP user timeout option (see RFC 5482).

  bad_call

  
  

  See

  setsockopt(2)

  See

  tcp(7)

• set_keep_alive(int max_probes, duration idle_time, duration interval) -> void

  Set keep-alive options.

  bad_call

  
  

  max_probes

  maximum number of keep-alive probes

  
  

  idle_time

  the number of seconds before the first probe is sent

  
  

  interval

  the number of seconds between subsequent probes

  
  

  See

  setsockopt(2)

  See

  tcp(7)

• unset(tcp_options name) -> void

  Set boolean TCP option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  tcp(7)

• set(tcp_options name) -> void

  Set boolean TCP option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  tcp(7)

• set(tcp_options name, const char * value, socket_length_type size) -> void

  Set string TCP option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  tcp(7)

• template <class T>
set(tcp_options name, T value) -> void

  Set TCP option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  tcp(7)

• get(tcp_options name, char * value, socket_length_type & size) const -> void

  Get string TCP option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  tcp(7)

• template <class T>
get(tcp_options name) const -> T

  Get TCP option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  tcp(7)

• unset(options name) -> void

  Set boolean socket option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  socket(7)

• set(options name) -> void

  Set boolean socket option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  socket(7)

• template <class T>
get(options name) const -> T

  Get socket option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  socket(7)

• template <class T>
set(options name, T value) -> void

  Set socket option.

  bad_call

  
  

  See

  setsockopt(2)

  See

  socket(7)

• type() const -> socket_type

  Get socket type.

  bad_call

  
  

  See

  getsockopt(2)

  See

  socket(7)

• setopt(option opt) -> UNISTDX_DEPRECATED void

  Set boolean option.

  bad_call

  
  

  See

  setsockopt(2)

• shutdown(shutdown_flag how = shutdown_flag::read_write) -> void

  Shutdown communication on the socket, but do not close it.

  bad_call

  if system error occurs, except std::errc::not_connected and std::errc::not_supported

  
  

  See

  shutdown(2)

  See

  std::errc

• accept(socket & client_socket, socket_address & client_address) -> bool

  Accept socket connection.

  bad_call

  
  

  client_socket

  socket that initiated a connection (client)

  
  

  client_address

  socket address of the client

  
  

  Date

  2018-05-24

  See

  accept4(2)

  Return

  true if the connection was accepted and more connections might be accepted, false if there are no more connections to be accepted

• listen(int max_pending_connections = SOMAXCONN) -> void

  Listen on previously binded socket address.

  bad_call

  
  

  See

  listen(2)

• connect(const socket_address_view & e) -> void

  Connect to socket address e.

  bad_call

  if system error occurs, except std::errc::operation_in_progress

  
  

  See

  connect(2)

  See

  std::errc

• bind(const socket_address_view & e) -> void

  Bind on socket address e.

  bad_call

  
  

  See

  bind(2)

• operator=(socket && rhs) -> socket &

  Move-assignment.

• ~socket()

  Close the socket.

• socket(socket_address_family family, socket_type type = socket_type::stream, protocol_type proto = 0)explicit

  Construct the socket with protocol family family, type type and protocol proto.

  bad_call

  
  

  See

  socket(2)

• socket(const socket_address_view & bind_addr, const socket_address_view & conn_addr) -> UNISTDX_DEPRECATED

  Construct the socket, bind on bind_addr and connect to a process listening on conn_addr.

  bad_call

  
  

  See

  socket(2)

• socket(const socket_address_view & bind_addr) -> UNISTDX_DEPRECATEDexplicit

  Construct the socket and bind on bind_addr and listen.

  bad_call

  
  

  See

  socket(2)

• socket(fildes && rhs)explicit

  Construct the socket from file descriptor rhs.

• socket(socket && rhs)explicit

  Move-constructor.

• operator=(const socket & rhs) -> socket &
• socket(const socket & rhs)
• socket()

Friends

• operator<<

  Print socket file descriptor and status.

Stream buffer traits for socket.

Types

• using char_type = void

  Character type.

Methods

• read(socket & src, char_type * s, std::streamsize n) -> std::streamsize

  Read n bytes to array pointed by s from socket src.

• write(socket & sink, const char_type * s, std::streamsize n) -> std::streamsize

  Write n bytes from array pointed by s to socket sink.

Overload of std::swap for socket.

Print socket file descriptor and status.