Struct virtual_net::client::RemoteSocket

struct RemoteSocket {
    socket_id: SocketId,
    common: Arc<RemoteCommon>,
    rx_buffer: BytesMut,
    rx_recv: Receiver<Vec<u8>>,
    rx_recv_with_addr: Receiver<DataWithAddr>,
    tx_waker: Waker,
    rx_accept: Receiver<SocketWithAddr>,
    rx_sent: Receiver<u64>,
    pending_accept: Option<(SocketId, Receiver<Vec<u8>>)>,
    buffer_recv_with_addr: VecDeque<DataWithAddr>,
    buffer_accept: VecDeque<SocketWithAddr>,
    send_available: u64,
}

Fields

socket_id: SocketId

common: Arc<RemoteCommon>

rx_buffer: BytesMut

rx_recv: Receiver<Vec<u8>>

rx_recv_with_addr: Receiver<DataWithAddr>

tx_waker: Waker

rx_accept: Receiver<SocketWithAddr>

rx_sent: Receiver<u64>

pending_accept: Option<(SocketId, Receiver<Vec<u8>>)>

buffer_recv_with_addr: VecDeque<DataWithAddr>

buffer_accept: VecDeque<SocketWithAddr>

send_available: u64

Implementations

impl RemoteSocket

async fn io_socket(&self, req: RequestType) -> ResponseType

fn io_socket_fire_and_forget(&self, req: RequestType) -> Result<()>

fn touch_begin_accept(&mut self) -> Result<()>

Trait Implementations

impl Debug for RemoteSocket

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

Formats the value using the given formatter.

impl Drop for RemoteSocket

fn drop(&mut self)

Executes the destructor for this type.

impl VirtualConnectedSocket for RemoteSocket

fn set_linger(&mut self, linger: Option<Duration>) -> Result<()>

Determines how long the socket will remain in a TIME_WAIT after it disconnects (only the one that initiates the close will be in a TIME_WAIT state thus the clients should always do this rather than the server)

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

Returns how long the socket will remain in a TIME_WAIT after it disconnects

fn try_send(&mut self, data: &[u8]) -> Result<usize>

Tries to send out a datagram or stream of bytes on this socket

fn try_flush(&mut self) -> Result<()>

fn close(&mut self) -> Result<()>

Closes the socket

fn try_recv(&mut self, buf: &mut [MaybeUninit<u8>]) -> Result<usize>

Tries to read a packet from the socket

impl VirtualConnectionlessSocket for RemoteSocket

fn try_send_to(&mut self, data: &[u8], addr: SocketAddr) -> Result<usize>

Sends out a datagram or stream of bytes on this socket to a specific address

fn try_recv_from( &mut self, buf: &mut [MaybeUninit<u8>], ) -> Result<(usize, SocketAddr)>

Recv a packet from the socket

impl VirtualIoSource for RemoteSocket

fn remove_handler(&mut self)

Removes a previously registered waker using a token

fn poll_read_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<usize>>

Polls the source to see if there is data waiting

fn poll_write_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<usize>>

Polls the source to see if data can be sent

impl VirtualRawSocket for RemoteSocket

fn try_send(&mut self, data: &[u8]) -> Result<usize>

Sends out a datagram or stream of bytes on this socket

fn try_flush(&mut self) -> Result<()>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn try_recv(&mut self, buf: &mut [MaybeUninit<u8>]) -> Result<usize>

Recv a packet from the socket

fn set_promiscuous(&mut self, promiscuous: bool) -> Result<()>

Tells the raw socket and its backing switch that all packets should be received by this socket even if they are not destined for this device

fn promiscuous(&self) -> Result<bool>

Returns if the socket is running in promiscuous mode whereby it will receive all packets even if they are not destined for the local interface

impl VirtualSocket for RemoteSocket

fn set_ttl(&mut self, ttl: u32) -> Result<()>

Sets how many network hops the packets are permitted for new connections

fn ttl(&self) -> Result<u32>

Returns the maximum number of network hops before packets are dropped

fn addr_local(&self) -> Result<SocketAddr>

Returns the local address for this socket

fn status(&self) -> Result<SocketStatus>

Returns the status/state of the socket

fn set_handler( &mut self, handler: Box<dyn InterestHandler + Send + Sync>, ) -> Result<()>

Registers a waker for when this connection is ready to receive more data. Uses a stack machine which means more than one waker can be registered

impl VirtualTcpListener for RemoteSocket

fn try_accept( &mut self, ) -> Result<(Box<dyn VirtualTcpSocket + Sync>, SocketAddr)>

Tries to accept a new connection

fn set_handler( &mut self, handler: Box<dyn InterestHandler + Send + Sync>, ) -> Result<()>

Registers a waker for when a new connection has arrived. This uses a stack machine which means more than one waker can be registered

fn addr_local(&self) -> Result<SocketAddr>

Returns the local address of this TCP listener

fn set_ttl(&mut self, ttl: u8) -> Result<()>

Sets how many network hops the packets are permitted for new connections

fn ttl(&self) -> Result<u8>

Returns the maximum number of network hops before packets are dropped

impl VirtualTcpSocket for RemoteSocket

fn set_recv_buf_size(&mut self, size: usize) -> Result<()>

Sets the receive buffer size which acts as a trottle for how much data is buffered on this side of the pipe

fn recv_buf_size(&self) -> Result<usize>

Size of the receive buffer that holds all data that has not yet been read

fn set_send_buf_size(&mut self, size: usize) -> Result<()>

Sets the size of the send buffer which will hold the bytes of data while they are being sent over to the peer

fn send_buf_size(&self) -> Result<usize>

Size of the send buffer that holds all data that is currently being transmitted.

fn set_nodelay(&mut self, reuse: bool) -> Result<()>

When NO_DELAY is set the data that needs to be transmitted to the peer is sent immediately rather than waiting for a bigger batch of data, this reduces latency but increases encapsulation overhead.

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

Indicates if the NO_DELAY flag is set which means that data is immediately sent to the peer without waiting. This reduces latency but increases encapsulation overhead.

fn set_keepalive(&mut self, keep_alive: bool) -> Result<()>

When KEEP_ALIVE is set the connection will periodically send an empty data packet to the server to make sure the connection stays alive.

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

Indicates if the KEEP_ALIVE flag is set which means that the socket will periodically send an empty data packet to keep the connection alive.

fn set_dontroute(&mut self, dont_route: bool) -> Result<()>

When DONT_ROUTE is set the packet will be sent directly to the interface without passing through the routing logic.

fn dontroute(&self) -> Result<bool>

Indicates if the packet will pass straight through to the interface bypassing the routing logic.

fn addr_peer(&self) -> Result<SocketAddr>

Returns the address (IP and Port) of the peer socket that this is conencted to

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

Shuts down either the READER or WRITER sides of the socket connection.

fn is_closed(&self) -> bool

Return true if the socket is closed

impl VirtualUdpSocket for RemoteSocket

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

Sets a flag that means that the UDP socket is able to receive and process broadcast packets.

fn broadcast(&self) -> Result<bool>

Indicates if the SO_BROADCAST flag is set which means that the UDP socket will receive and process broadcast packets

fn set_multicast_loop_v4(&mut self, val: bool) -> Result<()>

Sets a flag that indicates if multicast packets that this socket is a member of will be looped back to the sending socket. This applies to IPv4 addresses

fn multicast_loop_v4(&self) -> Result<bool>

Gets a flag that indicates if multicast packets that this socket is a member of will be looped back to the sending socket. This applies to IPv4 addresses

fn set_multicast_loop_v6(&mut self, val: bool) -> Result<()>

Sets a flag that indicates if multicast packets that this socket is a member of will be looped back to the sending socket. This applies to IPv6 addresses

fn multicast_loop_v6(&self) -> Result<bool>

Gets a flag that indicates if multicast packets that this socket is a member of will be looped back to the sending socket. This applies to IPv6 addresses

fn set_multicast_ttl_v4(&mut self, ttl: u32) -> Result<()>

Sets the TTL for IPv4 multicast packets which is the number of network hops before the packet is dropped

fn multicast_ttl_v4(&self) -> Result<u32>

Gets the TTL for IPv4 multicast packets which is the number of network hops before the packet is dropped

fn join_multicast_v4( &mut self, multiaddr: Ipv4Addr, iface: Ipv4Addr, ) -> Result<()>

Tells this interface that it will subscribe to a particular multicast address. This applies to IPv4 addresses

fn leave_multicast_v4( &mut self, multiaddr: Ipv4Addr, iface: Ipv4Addr, ) -> Result<()>

Tells this interface that it will unsubscribe to a particular multicast address. This applies to IPv4 addresses

fn join_multicast_v6(&mut self, multiaddr: Ipv6Addr, iface: u32) -> Result<()>

Tells this interface that it will subscribe to a particular multicast address. This applies to IPv6 addresses

fn leave_multicast_v6(&mut self, multiaddr: Ipv6Addr, iface: u32) -> Result<()>

Tells this interface that it will unsubscribe to a particular multicast address. This applies to IPv6 addresses

fn addr_peer(&self) -> Result<Option<SocketAddr>>

Returns the remote address of this UDP socket if it has been connected to a specific target destination address

impl VirtualIcmpSocket for RemoteSocket