Struct nex_socket::Socket

pub struct Socket { /* private fields */ }

Socket. Provides cross-platform adapter for system socket.

Implementations

impl Socket

pub fn new(socket_option: SocketOption) -> Result<Socket>

Constructs a new Socket.

pub fn bind(&self, addr: SocketAddr) -> Result<()>

Bind socket to address.

pub fn send(&self, buf: &[u8]) -> Result<usize>

Send packet.

pub fn send_to(&self, buf: &[u8], target: SocketAddr) -> Result<usize>

Send packet to target.

pub fn receive(&self, buf: &mut Vec<u8>) -> Result<usize>

Receive packet.

pub fn receive_from(&self, buf: &mut Vec<u8>) -> Result<(usize, SocketAddr)>

Receive packet with sender address.

pub fn write(&self, buf: &[u8]) -> Result<usize>

Write data to the socket and send to the target. Return how many bytes were written.

pub fn write_all(&self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

pub fn read(&self, buf: &mut Vec<u8>) -> Result<usize>

Read data from the socket. Return how many bytes were read.

pub fn read_to_end(&self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf.

pub fn read_to_end_timeout( &self, buf: &mut Vec<u8>, timeout: Duration ) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf. This ignore io::Error on read_to_end because it is expected when reading response. If no response is received, and io::Error is occurred, return Err.

pub fn ttl(&self, ip_version: IpVersion) -> Result<u32>

Get TTL or Hop Limit.

pub fn set_ttl(&self, ttl: u32, ip_version: IpVersion) -> Result<()>

Set TTL or Hop Limit.

pub fn tos(&self) -> Result<u32>

Get the value of the IP_TOS option for this socket.

pub fn set_tos(&self, tos: u32) -> Result<()>

Set the value of the IP_TOS option for this socket.

pub fn receive_tos(&self) -> Result<bool>

Get the value of the IP_RECVTOS option for this socket.

pub fn set_receive_tos(&self, receive_tos: bool) -> Result<()>

Set the value of the IP_RECVTOS option for this socket.

pub fn connect(&self, addr: &SocketAddr) -> Result<()>

Initiate TCP connection.

pub fn connect_timeout( &self, addr: &SocketAddr, timeout: Duration ) -> Result<()>

Initiate a connection on this socket to the specified address, only only waiting for a certain period of time for the connection to be established. The non-blocking state of the socket is overridden by this function.

pub fn listen(&self, backlog: i32) -> Result<()>

Listen TCP connection.

pub fn accept(&self) -> Result<(Socket, SocketAddr)>

Accept TCP connection.

pub fn local_addr(&self) -> Result<SocketAddr>

Get local address.

pub fn peer_addr(&self) -> Result<SocketAddr>

Get peer address.

pub fn socket_type(&self) -> Result<SocketType>

Get type of the socket.

pub fn try_clone(&self) -> Result<Socket>

Create a new socket with the same configuration and bound to the same address.

pub fn is_nonblocking(&self) -> Result<bool>

Returns true if this socket is set to nonblocking mode, false otherwise.

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

Set non-blocking mode.

pub fn shutdown(&self, how: Shutdown) -> Result<()>

Shutdown TCP connection.

pub fn is_broadcast(&self) -> Result<bool>

Get the value of the SO_BROADCAST option for this socket.

pub fn set_broadcast(&self, broadcast: bool) -> Result<()>

Set the value of the SO_BROADCAST option for this socket.

When enabled, this socket is allowed to send packets to a broadcast address.

pub fn get_error(&self) -> Result<Option<Error>>

Get the value of the SO_ERROR option on this socket.

pub fn keepalive(&self) -> Result<bool>

Get the value of the SO_KEEPALIVE option on this socket.

pub fn set_keepalive(&self, keepalive: bool) -> Result<()>

Set value for the SO_KEEPALIVE option on this socket.

Enable sending of keep-alive messages on connection-oriented sockets.

pub fn linger(&self) -> Result<Option<Duration>>

Get the value of the SO_LINGER option on this socket.

pub fn set_linger(&self, dur: Option<Duration>) -> Result<()>

Set value for the SO_LINGER option on this socket.

pub fn receive_buffer_size(&self) -> Result<usize>

Get the value of the SO_RCVBUF option on this socket.

pub fn set_receive_buffer_size(&self, size: usize) -> Result<()>

Set value for the SO_RCVBUF option on this socket.

Changes the size of the operating system’s receive buffer associated with the socket.

pub fn receive_timeout(&self) -> Result<Option<Duration>>

Get value for the SO_RCVTIMEO option on this socket.

pub fn set_receive_timeout(&self, duration: Option<Duration>) -> Result<()>

Set value for the SO_RCVTIMEO option on this socket.

pub fn reuse_address(&self) -> Result<bool>

Get value for the SO_REUSEADDR option on this socket.

pub fn set_reuse_address(&self, reuse: bool) -> Result<()>

Set value for the SO_REUSEADDR option on this socket.

This indicates that futher calls to bind may allow reuse of local addresses.

pub fn send_buffer_size(&self) -> Result<usize>

Get value for the SO_SNDBUF option on this socket.

pub fn set_send_buffer_size(&self, size: usize) -> Result<()>

Set value for the SO_SNDBUF option on this socket.

Changes the size of the operating system’s send buffer associated with the socket.

pub fn send_timeout(&self) -> Result<Option<Duration>>

Get value for the SO_SNDTIMEO option on this socket.

pub fn set_send_timeout(&self, duration: Option<Duration>) -> Result<()>

Set value for the SO_SNDTIMEO option on this socket.

If timeout is None, then write and send calls will block indefinitely.

pub fn is_ip_header_included(&self) -> Result<bool>

Get the value of the IP_HDRINCL option on this socket.

pub fn set_ip_header_included(&self, include: bool) -> Result<()>

Set the value of the IP_HDRINCL option on this socket.

pub fn nodelay(&self) -> Result<bool>

Get the value of the TCP_NODELAY option on this socket.

pub fn set_nodelay(&self, nodelay: bool) -> Result<()>

Set the value of the TCP_NODELAY option on this socket.

If set, segments are always sent as soon as possible, even if there is only a small amount of data.

pub fn into_tcp_stream(self) -> Result<TcpStream>

Get TCP Stream This function will consume the socket and return a new std::net::TcpStream.

pub fn into_tcp_listener(self) -> Result<TcpListener>

Get TCP Listener This function will consume the socket and return a new std::net::TcpListener.

pub fn into_udp_socket(self) -> Result<UdpSocket>

Get UDP Socket This function will consume the socket and return a new std::net::UdpSocket.

Trait Implementations

impl Clone for Socket

fn clone(&self) -> Socket

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Socket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.