pub enum Transport {
Tcp,
FramedTcp,
Udp,
Ws,
}
Expand description
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§
Source§impl Transport
impl Transport
Sourcepub fn mount_adapter(self, loader: &mut DriverLoader)
pub fn mount_adapter(self, loader: &mut DriverLoader)
Associates an adapter. This method mounts the adapters to be used in the network instance.
Sourcepub const fn max_message_size(self) -> usize
pub const fn max_message_size(self) -> usize
Maximum theorical packet payload length available for each transport.
The value returned by this function is the theorical maximum and could not be valid for
all networks.
You can ensure your message not exceeds udp::MAX_INTERNET_PAYLOAD_LEN
in order to be
more cross-platform compatible.
Sourcepub const fn is_connection_oriented(self) -> bool
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.
Sourcepub const fn is_packet_based(self) -> bool
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. It satisfies that the number of bytes sent are the same as received. 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.