Struct Network

pub struct Network {
    pub name: Rc<String>,
    pub config: Rc<StackConfig>,
    pub stack: Stack<'static>,
    pub bindings: Rc<RefCell<HashSet<SocketHandle>>>,
    pub connections: Rc<RefCell<HashMap<ConnectionMeta, Connection>>>,
    pub handles: Rc<RefCell<HashMap<SocketHandle, ConnectionMeta>>>,
    /* private fields */
}

Fields

name: Rc<String>

config: Rc<StackConfig>

stack: Stack<'static>

bindings: Rc<RefCell<HashSet<SocketHandle>>>

Set of listening sockets. Socket is removed from this set, when connection is created. Network stack will create new binding using new handle in place of previous.

connections: Rc<RefCell<HashMap<ConnectionMeta, Connection>>>

handles: Rc<RefCell<HashMap<SocketHandle, ConnectionMeta>>>

Implementations

impl Network

pub fn new( name: impl ToString, config: Rc<StackConfig>, stack: Stack<'static>, ) -> Self

Creates a new Network instance

pub fn get_bound( &self, protocol: Protocol, local_endpoint: impl Into<SocketEndpoint>, ) -> Option<SocketHandle>

Returns a socket listening on an endpoint and ready for incoming connections. Sockets already connected won’t be returned.

pub fn bind( &self, protocol: Protocol, endpoint: impl Into<SocketEndpoint>, ) -> Result<SocketHandle>

Listen on a local endpoint

pub fn unbind( &self, protocol: Protocol, endpoint: impl Into<SocketEndpoint>, ) -> Result<()>

Stop listening on a local endpoint

pub fn connect( &self, remote: impl Into<IpEndpoint>, timeout: impl Into<Duration>, ) -> LocalBoxFuture<'_, Result<Connection>>

Initiate a TCP connection

pub fn disconnect_all( &self, remote_ip: Box<[u8]>, timeout: impl Into<Duration>, ) -> LocalBoxFuture<'_, ()>

Close all TCP connections with a remote IP address

pub fn bindings(&self) -> Ref<'_, HashSet<SocketHandle>>

pub fn handles(&self) -> Ref<'_, HashMap<SocketHandle, ConnectionMeta>>

pub fn connections(&self) -> Ref<'_, HashMap<ConnectionMeta, Connection>>

pub fn sockets(&self) -> Vec<(SocketDesc, SocketState<ChannelMetrics>)>

pub fn sockets_meta( &self, ) -> Vec<(SocketHandle, SocketDesc, SocketState<ChannelMetrics>)>

pub fn metrics(&self) -> ChannelMetrics

pub fn send<'a>( &self, data: impl Into<Payload>, connection: Connection, ) -> impl Future<Output = Result<()>> + 'a

Inject send data into the stack

pub fn receive(&self, data: impl Into<Payload>)

Inject received data into the stack

pub fn spawn_local(&self)

pub fn poll(&self)

Polls the inner network stack

pub fn ingress_receiver(&self) -> Option<IngressReceiver>

Take the ingress traffic receive channel

pub fn egress_receiver(&self) -> Option<EgressReceiver>

Take the egress traffic receive channel

Trait Implementations

impl Clone for Network

fn clone(&self) -> Network

Returns a duplicate of the value.

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

Performs copy-assignment from source.