Enum message_io::network::Transport

pub enum Transport {
    Tcp,
    FramedTcp,
    Udp,
    Ws,
}

Enum to identified the underlying transport used. It can be passed to NetworkController::connect() and NetworkController::listen() methods to specify the transport used.

Variants

Tcp

TCP protocol (available through the tcp feature). As stream protocol, receiving a message from TCP do not imply to read the entire message. If you want a packet based way to send over TCP, use FramedTcp instead.

FramedTcp

Tcp framed protocol (available through the tcp feature). Like TCP, but encoded with a slim frame layer to manage the data as a packet, instead of as a stream. It prefixes the message using variable integer encoding with the size of the message. Most of the time you would want to use this instead of the raw Tcp.

Udp

UDP protocol (available through the udp feature). Take into account that UDP is not connection oriented and a packet can be lost or received disordered. If it is specified in the listener and the address is a Ipv4 in the range of multicast ips (from 224.0.0.0 to 239.255.255.255), the listener will be configured in multicast mode.

Ws

WebSocket protocol (available through the websocket feature). If you use a crate::network::RemoteAddr::Str in the connect() method, you can specify an URL with wss of ws schemas to connect with or without security. If you use a crate::network::RemoteAddr::Socket the socket will be a normal websocket with the following uri: ws://{SocketAddr}/message-io-default.

Implementations

impl Transport

pub fn mount_adapter(self, loader: &mut DriverLoader)

Associates an adapter. This method mounts the adapters to be used in the network instance.

pub const fn max_message_size(self) -> usize

Maximum teorical packet payload length available for each transport.

Note: For UDP this value depends of the OS. The value returned by this function is the teorical maximum and could not be valid for all OS (MacOS in as an example of this). You can ensure your message not exceeds udp::MAX_COMPATIBLE_UDP_PAYLOAD_LEN in order to be more cross-platform compatible.

pub const fn is_connection_oriented(self) -> bool

Tell if the transport protocol is a connection oriented protocol. If it is, Connection and Disconnection events will be generated.

pub const fn is_packet_based(self) -> bool

Tell if the transport protocol is a packet based protocol. It implies that any send call corresponds to a data message event. The opossite of a packet based is a stream based transport (e.g Tcp). In this case, reading a data message event do not imply reading the entire message sent. It is in change of the user to determinate how to read the data.

pub const fn id(self) -> u8

Returns the adapter id used for this transport. It is equivalent to the position of the enum starting by 0

Trait Implementations

impl Clone for Transport

fn clone(&self) -> Transport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Transport

impl Debug for Transport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Transport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Transport

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

Formats the value using the given formatter.

impl Eq for Transport

impl Hash for Transport

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for Transport

type Iterator = TransportIter

fn iter() -> TransportIter

impl PartialEq<Transport> for Transport

fn eq(&self, other: &Transport) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Transport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Transport

impl StructuralPartialEq for Transport