1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
use super::loader::{DriverLoader};
#[cfg(feature = "tcp")]
use crate::adapters::tcp::{TcpAdapter, TcpConnectConfig, TcpListenConfig};
#[cfg(feature = "tcp")]
use crate::adapters::framed_tcp::{FramedTcpAdapter, FramedTcpConnectConfig, FramedTcpListenConfig};
#[cfg(feature = "udp")]
use crate::adapters::udp::{self, UdpAdapter, UdpConnectConfig, UdpListenConfig};
#[cfg(feature = "websocket")]
use crate::adapters::ws::{self, WsAdapter};
use serde::{Serialize, Deserialize};
/// Enum to identified the underlying transport used.
/// It can be passed to
/// [`NetworkController::connect()`](crate::network::NetworkController::connect()) and
/// [`NetworkController::listen()`](crate::network::NetworkController::connect()) methods
/// to specify the transport used.
#[derive(strum::EnumIter, Serialize, Deserialize, Clone, Copy, PartialEq, Eq, Hash, Debug)]
pub enum Transport {
/// 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.
#[cfg(feature = "tcp")]
Tcp,
/// 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`.
#[cfg(feature = "tcp")]
FramedTcp,
/// 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.
#[cfg(feature = "udp")]
Udp,
/// 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`.
#[cfg(feature = "websocket")]
Ws,
}
impl Transport {
/// Associates an adapter.
/// This method mounts the adapters to be used in the network instance.
pub fn mount_adapter(self, loader: &mut DriverLoader) {
match self {
#[cfg(feature = "tcp")]
Self::Tcp => loader.mount(self.id(), TcpAdapter),
#[cfg(feature = "tcp")]
Self::FramedTcp => loader.mount(self.id(), FramedTcpAdapter),
#[cfg(feature = "udp")]
Self::Udp => loader.mount(self.id(), UdpAdapter),
#[cfg(feature = "websocket")]
Self::Ws => loader.mount(self.id(), WsAdapter),
};
}
/// 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.
pub const fn max_message_size(self) -> usize {
match self {
#[cfg(feature = "tcp")]
Self::Tcp => usize::MAX,
#[cfg(feature = "tcp")]
Self::FramedTcp => usize::MAX,
#[cfg(feature = "udp")]
Self::Udp => udp::MAX_LOCAL_PAYLOAD_LEN,
#[cfg(feature = "websocket")]
Self::Ws => ws::MAX_PAYLOAD_LEN,
}
}
/// Tell if the transport protocol is a connection oriented protocol.
/// If it is, `Connection` and `Disconnection` events will be generated.
pub const fn is_connection_oriented(self) -> bool {
match self {
#[cfg(feature = "tcp")]
Transport::Tcp => true,
#[cfg(feature = "tcp")]
Transport::FramedTcp => true,
#[cfg(feature = "udp")]
Transport::Udp => false,
#[cfg(feature = "websocket")]
Transport::Ws => true,
}
}
/// 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.
pub const fn is_packet_based(self) -> bool {
match self {
#[cfg(feature = "tcp")]
Transport::Tcp => false,
#[cfg(feature = "tcp")]
Transport::FramedTcp => true,
#[cfg(feature = "udp")]
Transport::Udp => true,
#[cfg(feature = "websocket")]
Transport::Ws => true,
}
}
/// Returns the adapter id used for this transport.
/// It is equivalent to the position of the enum starting by 0
pub const fn id(self) -> u8 {
match self {
#[cfg(feature = "tcp")]
Transport::Tcp => 0,
#[cfg(feature = "tcp")]
Transport::FramedTcp => 1,
#[cfg(feature = "udp")]
Transport::Udp => 2,
#[cfg(feature = "websocket")]
Transport::Ws => 3,
}
}
}
impl From<u8> for Transport {
fn from(id: u8) -> Self {
match id {
#[cfg(feature = "tcp")]
0 => Transport::Tcp,
#[cfg(feature = "tcp")]
1 => Transport::FramedTcp,
#[cfg(feature = "udp")]
2 => Transport::Udp,
#[cfg(feature = "websocket")]
3 => Transport::Ws,
_ => panic!("Not available transport"),
}
}
}
impl std::fmt::Display for Transport {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{self:?}")
}
}
#[derive(Debug)]
pub enum TransportConnect {
#[cfg(feature = "tcp")]
Tcp(TcpConnectConfig),
#[cfg(feature = "tcp")]
FramedTcp(FramedTcpConnectConfig),
#[cfg(feature = "udp")]
Udp(UdpConnectConfig),
#[cfg(feature = "websocket")]
Ws,
}
impl TransportConnect {
pub fn id(&self) -> u8 {
let transport = match self {
#[cfg(feature = "tcp")]
Self::Tcp(_) => Transport::Tcp,
#[cfg(feature = "tcp")]
Self::FramedTcp(_) => Transport::FramedTcp,
#[cfg(feature = "udp")]
Self::Udp(_) => Transport::Udp,
#[cfg(feature = "websocket")]
Self::Ws => Transport::Ws,
};
transport.id()
}
}
impl From<Transport> for TransportConnect {
fn from(transport: Transport) -> Self {
match transport {
#[cfg(feature = "tcp")]
Transport::Tcp => Self::Tcp(TcpConnectConfig::default()),
#[cfg(feature = "tcp")]
Transport::FramedTcp => Self::FramedTcp(FramedTcpConnectConfig::default()),
#[cfg(feature = "udp")]
Transport::Udp => Self::Udp(UdpConnectConfig::default()),
#[cfg(feature = "websocket")]
Transport::Ws => Self::Ws,
}
}
}
#[derive(Debug)]
pub enum TransportListen {
#[cfg(feature = "tcp")]
Tcp(TcpListenConfig),
#[cfg(feature = "tcp")]
FramedTcp(FramedTcpListenConfig),
#[cfg(feature = "udp")]
Udp(UdpListenConfig),
#[cfg(feature = "websocket")]
Ws,
}
impl TransportListen {
pub fn id(&self) -> u8 {
let transport = match self {
#[cfg(feature = "tcp")]
Self::Tcp(_) => Transport::Tcp,
#[cfg(feature = "tcp")]
Self::FramedTcp(_) => Transport::FramedTcp,
#[cfg(feature = "udp")]
Self::Udp(_) => Transport::Udp,
#[cfg(feature = "websocket")]
Self::Ws => Transport::Ws,
};
transport.id()
}
}
impl From<Transport> for TransportListen {
fn from(transport: Transport) -> Self {
match transport {
#[cfg(feature = "tcp")]
Transport::Tcp => Self::Tcp(TcpListenConfig::default()),
#[cfg(feature = "tcp")]
Transport::FramedTcp => Self::FramedTcp(FramedTcpListenConfig::default()),
#[cfg(feature = "udp")]
Transport::Udp => Self::Udp(UdpListenConfig::default()),
#[cfg(feature = "websocket")]
Transport::Ws => Self::Ws,
}
}
}