Struct message_io::network::Network

pub struct Network { /* fields omitted */ }

Network is in charge of managing all the connections transparently. It transforms raw data from the network into message events and vice versa, and manages the different adapters for you.

Implementations

impl<'a> Network

pub fn new<M, C>(user_event_callback: C) -> Network where
    M: for<'b> Deserialize<'b> + Send + 'static,
    C: Fn(NetEvent<M>) + Send + Clone + 'static, 

Creates a new Network. The user must register an event_callback that can be called each time the network generate and NetEvent.

pub fn connect<A: ToSocketAddrs>(
    &mut self,
    transport: Transport,
    addr: A
) -> Result<Endpoint>

Creates a connection to the specific address by TCP. The endpoint, an identified of the new connection, will be returned. If the connection can not be performed (e.g. the address is not reached) an error is returned.

pub fn listen<A: ToSocketAddrs>(
    &mut self,
    transport: Transport,
    addr: A
) -> Result<(ResourceId, SocketAddr)>

Listen messages from specified transport. The giver address will be used as interface and listening port. If the port can be opened, a ResourceId identifying the listener is returned along with the local address, or an error if not. The address is returned despite you passed as parameter because when a '0' port is specified, the OS will give a value. If the protocol is UDP and the address is Ipv4 in the range of multicast ips (from 224.0.0.0 to 239.255.255.255) it will be listening is multicast mode.

pub fn remove_resource(&mut self, resource_id: ResourceId) -> Option<()>

Remove a network resource. Returns None if the resource id not exists. This is used mainly to remove resources that the program has been created explicitely, as connection or listeners. Resources of endpoints generated by listening from TCP can also be removed to close the connection. Note: UDP endpoints generated by listening from UDP shared the resource. This means that there is no resource to remove as the TCP case. (in fact there is no connection itself to close, 'there is no spoon').

pub fn local_addr(&self, resource_id: ResourceId) -> Option<SocketAddr>

Request a local address of a resource. Returns None if the endpoint id does not exists. Note: UDP endpoints generated by a listen from UDP shared the resource.

pub fn send<M: Serialize>(
    &mut self,
    endpoint: Endpoint,
    message: M
) -> SendingStatus

Serialize and send the message thought the connection represented by the given endpoint. If the same message should be sent to different endpoints, use Network::send_all() to get a better performance. The funcion panics if the endpoint do not exists in the Network. If the endpoint disconnects during the sending, a RemoveEndpoint is generated. A SendingStatus is returned with the information about the sending.

pub fn send_all<'b, M: Serialize>(
    &mut self,
    endpoints: impl IntoIterator<Item = &'b Endpoint>,
    message: M
) -> &Vec<SendingStatus>

This functions performs the same actions as Network::send() but for several endpoints. When there are severals endpoints to send the data, this function is faster than consecutive calls to Network::send() since the encoding and serialization is performed only one time for all endpoints. The funcion panics if some of endpoints do not exists in the Network.