Struct TimestampedTcpSocket 

pub struct TimestampedTcpSocket { /* private fields */ }

A TCP socket wrapper that includes the raw file descriptor.

This structure is intended to wrap the raw file descriptor provided by a TCP socket and includes some common socket operations like bind, listen, accept, and connect. It also provides timestamped send and receive operations.

Safety

This structure performs raw system calls via the libc crate. Incorrect use could lead to system errors. Ensure the correct use of these system calls in accordance with POSIX standards.

Implementations

impl TimestampedTcpSocket

pub fn new(socket: RawFd) -> Self

Create a new instance of TimestampedTcpSocket from a raw file descriptor.

This method sets the SO_REUSEADDR option on the socket to allow the reuse of local addresses.

Safety

The provided file descriptor should be valid and correspond to a socket.

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

Binds the socket to a specific address.

The socket will be available for incoming connection attempts on the specified addr.

Errors

This method returns an error if the socket cannot be bound to the provided address.

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

Listen for incoming connections.

The backlog parameter defines the maximum number of pending connections.

Errors

This method returns an error if the socket cannot be set to listen mode.

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

Accept a new incoming connection attempt.

This method blocks until a connection attempt is made to the socket.

Returns

This method returns a new TimestampedTcpSocket for the incoming connection and the address of the peer socket.

Errors

This method returns an error if an incoming connection cannot be accepted.

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

Connect to a remote socket at the provided address.

This method blocks until the connection is established.

Errors

This method returns an error if the connection attempt fails.

Trait Implementations

impl AsRawFd for TimestampedTcpSocket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Deref for TimestampedTcpSocket

type Target = i32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for TimestampedTcpSocket

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<&mut i32> for TimestampedTcpSocket

fn from(value: &mut i32) -> Self

Converts to this type from the input type.

impl Socket<TimestampedTcpSocket> for TimestampedTcpSocket

unsafe fn from_raw_fd(fd: RawFd) -> TimestampedTcpSocket

Creates a new instance of the socket from the given raw file descriptor.

fn send(&self, message: impl BeBytes) -> Result<(isize, DateTime), CommonError>

Sends the given message over the socket.

fn send_to( &self, _address: &SocketAddr, message: impl BeBytes, ) -> Result<(isize, DateTime), CommonError>

Sends the given message to the specified socket address.

fn receive(&self, buffer: &mut [u8]) -> Result<(isize, DateTime), CommonError>

Receives data from the socket into the given buffer.

fn receive_from( &self, buffer: &mut [u8], ) -> Result<(isize, SocketAddr, DateTime), CommonError>

Receives data from the socket into the given buffer, along with the address of the sender.

fn set_socket_options( &mut self, level: i32, name: i32, value: Option<i32>, ) -> Result<i32, CommonError>

fn set_fcntl_options(&self) -> Result<i32, CommonError>

fn set_timestamping_options(&mut self) -> Result<i32, CommonError>