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 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
//! Raw protocol. Without encryption and compression.
//!
//! Not recommend. It's unsafe but really fast.
//!
//! # Examples
//! ```rust
//! use anyhow::Result;
//! use bytes::{Buf, BufMut, BytesMut};
//! use tcp_handler::protocols::raw::*;
//! use tokio::net::{TcpListener, TcpStream};
//! use variable_len_reader::{VariableReader, VariableWriter};
//!
//! #[tokio::main]
//! async fn main() -> Result<()> {
//! let server = TcpListener::bind("localhost:0").await?;
//! let mut client = TcpStream::connect(server.local_addr()?).await?;
//! let (mut server, _) = server.accept().await?;
//!
//! let c_init = client_init(&mut client, "test", "0").await;
//! let s_init = server_init(&mut server, "test", |v| v == "0").await;
//! server_start(&mut server, "test", "0", s_init).await?;
//! client_start(&mut client, c_init).await?;
//!
//! let mut writer = BytesMut::new().writer();
//! writer.write_string("hello server.")?;
//! send(&mut client, &mut writer.into_inner()).await?;
//!
//! let mut reader = recv(&mut server).await?.reader();
//! let message = reader.read_string()?;
//! assert_eq!("hello server.", message);
//!
//! let mut writer = BytesMut::new().writer();
//! writer.write_string("hello client.")?;
//! send(&mut server, &mut writer.into_inner()).await?;
//!
//! let mut reader = recv(&mut client).await?.reader();
//! let message = reader.read_string()?;
//! assert_eq!("hello client.", message);
//!
//! Ok(())
//! }
//! ```
//!
//! The send process:
//! ```text
//! ┌────┬────────┬────────────┐ (It may not be in contiguous memory.)
//! in --> │ ** │ ****** │ ********** │
//! └────┴────────┴────────────┘
//! │
//! │─ Directly send packet
//! out <-- ─┘
//! ```
//! The recv process:
//! ```text
//! ┌────────────────────┐ (Packet data.)
//! in --> │ ****************** │
//! └────────────────────┘
//! │
//! │─ Directly recv packet
//! out <-- ─┘
//! ```
use bytes::{Buf, BytesMut};
use tokio::io::{AsyncRead, AsyncWrite};
use crate::protocols::common::*;
/// Init the client side in tcp-handler raw protocol.
///
/// Must be used in conjunction with [`client_start`].
///
/// # Arguments
/// * `stream` - The tcp stream or `WriteHalf`.
/// * `identifier` - The identifier of your application.
/// * `version` - Current version of your application.
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::protocols::raw::{client_init, client_start};
/// use tokio::net::TcpStream;
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let mut client = TcpStream::connect("localhost:25564").await?;
/// let c_init = client_init(&mut client, "test", "0").await;
/// client_start(&mut client, c_init).await?;
/// // Now the client is ready to use.
/// Ok(())
/// }
/// ```
#[inline]
pub async fn client_init<W: AsyncWrite + Unpin>(stream: &mut W, identifier: &str, version: &str) -> Result<(), StarterError> {
write_head(stream, ProtocolVariant::Raw, identifier, version).await?;
flush(stream).await?;
Ok(())
}
/// Init the server side in tcp-handler raw protocol.
///
/// Must be used in conjunction with [`server_start`].
///
/// # Arguments
/// * `stream` - The tcp stream or `ReadHalf`.
/// * `identifier` - The identifier of your application.
/// * `version` - A prediction to determine whether the client version is allowed.
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::protocols::raw::{server_init, server_start};
/// use tokio::net::TcpListener;
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let server = TcpListener::bind("localhost:25564").await?;
/// let (mut server, _) = server.accept().await?;
/// let s_init = server_init(&mut server, "test", |v| v == "0").await;
/// server_start(&mut server, "test", "0", s_init).await?;
/// // Now the server is ready to use.
/// Ok(())
/// }
/// ```
#[inline]
pub async fn server_init<R: AsyncRead + Unpin, P: FnOnce(&str) -> bool>(stream: &mut R, identifier: &str, version: P) -> Result<(u16, String), StarterError> {
read_head(stream, ProtocolVariant::Raw, identifier, version).await
}
/// Make sure the client side is ready to use in tcp-handler raw protocol.
///
/// Must be used in conjunction with [`client_init`].
///
/// # Arguments
/// * `stream` - The tcp stream or `ReadHalf`.
/// * `last` - The return value of [`client_init`].
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::protocols::raw::{client_init, client_start};
/// use tokio::net::TcpStream;
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let mut client = TcpStream::connect("localhost:25564").await?;
/// let c_init = client_init(&mut client, "test", "0").await;
/// client_start(&mut client, c_init).await?;
/// // Now the client is ready to use.
/// Ok(())
/// }
/// ```
#[inline]
pub async fn client_start<R: AsyncRead + Unpin>(stream: &mut R, last: Result<(), StarterError>) -> Result<(), StarterError> {
read_last(stream, last).await
}
/// Make sure the server side is ready to use in tcp-handler raw protocol.
///
/// Must be used in conjunction with [`server_init`].
///
/// # Arguments
/// * `stream` - The tcp stream or `WriteHalf`.
/// * `identifier` - The returned application identifier.
/// (Should be same with the para in [`server_init`].)
/// * `version` - The returned recommended application version.
/// (Should be passed the prediction in [`server_init`].)
/// * `last` - The return value of [`server_init`].
///
/// # Example
/// ```rust,no_run
/// use anyhow::Result;
/// use tcp_handler::protocols::raw::{server_init, server_start};
/// use tokio::net::TcpListener;
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
/// let server = TcpListener::bind("localhost:25564").await?;
/// let (mut server, _) = server.accept().await?;
/// let s_init = server_init(&mut server, "test", |v| v == "0").await;
/// let (protocol_version, client_version) = server_start(&mut server, "test", "0", s_init).await?;
/// // Now the server is ready to use.
/// # let _ = protocol_version;
/// # let _ = client_version;
/// Ok(())
/// }
/// ```
#[inline]
pub async fn server_start<W: AsyncWrite + Unpin>(stream: &mut W, identifier: &str, version: &str, last: Result<(u16, String), StarterError>) -> Result<(u16, String), StarterError> {
let res = write_last(stream, ProtocolVariant::Raw, identifier, version, last).await?;
flush(stream).await?;
Ok(res)
}
/// Send the message in raw tcp-handler protocol.
///
/// # Arguments
/// * `stream` - The tcp stream or `WriteHalf`.
/// * `message` - The message to send.
///
/// # Example
/// ```rust,no_run
/// # use anyhow::Result;
/// # use bytes::{BufMut, BytesMut};
/// # use tcp_handler::protocols::raw::{client_init, client_start};
/// use tcp_handler::protocols::raw::send;
/// # use tokio::net::TcpStream;
/// # use variable_len_reader::VariableWriter;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// # let mut client = TcpStream::connect("localhost:25564").await?;
/// # let c_init = client_init(&mut client, "test", "0").await;
/// # client_start(&mut client, c_init).await?;
/// let mut buffer = BytesMut::new().writer();
/// buffer.write_string("hello server!")?;
/// send(&mut client, &mut buffer.into_inner()).await?;
/// # Ok(())
/// # }
/// ```
#[inline]
pub async fn send<W: AsyncWrite + Unpin, B: Buf>(stream: &mut W, message: &mut B) -> Result<(), PacketError> {
write_packet(stream, message).await?;
flush(stream).await?;
Ok(())
}
/// Recv the message in raw tcp-handler protocol.
///
/// # Arguments
/// * `stream` - The tcp stream or `ReadHalf`.
///
/// # Example
/// ```rust,no_run
/// # use anyhow::Result;
/// # use bytes::Buf;
/// # use tcp_handler::protocols::raw::{server_init, server_start};
/// use tcp_handler::protocols::raw::recv;
/// # use tokio::net::TcpListener;
/// # use variable_len_reader::VariableReader;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// # let server = TcpListener::bind("localhost:25564").await?;
/// # let (mut server, _) = server.accept().await?;
/// # let s_init = server_init(&mut server, "test", |v| v == "0").await;
/// # server_start(&mut server, "test", "0", s_init).await?;
/// let mut reader = recv(&mut server).await?.reader();
/// let message = reader.read_string()?;
/// # let _ = message;
/// # Ok(())
/// # }
/// ```
#[inline]
pub async fn recv<R: AsyncRead + Unpin>(stream: &mut R) -> Result<BytesMut, PacketError> {
read_packet(stream).await
}
#[cfg(test)]
mod tests {
use anyhow::Result;
use bytes::{BufMut, BytesMut};
use variable_len_reader::{VariableReader, VariableWriter};
use crate::protocols::common::tests::create;
use crate::protocols::raw::*;
#[tokio::test]
async fn connect() -> Result<()> {
let (mut client, mut server) = create().await?;
let c = client_init(&mut client, "a", "1").await;
let s = server_init(&mut server, "a", |v| v == "1").await;
server_start(&mut server, "a", "1", s).await?;
client_start(&mut client, c).await?;
let mut writer = BytesMut::new().writer();
writer.write_string("hello server in raw.")?;
send(&mut client, &mut writer.into_inner()).await?;
let mut reader = recv(&mut server).await?.reader();
let message = reader.read_string()?;
assert_eq!("hello server in raw.", message);
let mut writer = BytesMut::new().writer();
writer.write_string("hello client in raw.")?;
send(&mut server, &mut writer.into_inner()).await?;
let mut reader = recv(&mut client).await?.reader();
let message = reader.read_string()?;
assert_eq!("hello client in raw.", message);
Ok(())
}
}