Module raw

Source
Expand description

Raw protocol. Without encryption and compression.

Not recommend. It’s unsafe but really fast.

§Examples

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:

        ┌────┬────────┬────────────┐ (It may not be in contiguous memory.)
in  --> │ ** │ ****** │ ********** │
        └────┴────────┴────────────┘
          │
          │─ Directly send packet
out <--  ─┘

The recv process:

        ┌────────────────────┐ (Packet data.)
in  --> │ ****************** │
        └────────────────────┘
          │
          │─ Directly recv packet
out <--  ─┘

Functions§

client_init
Init the client side in tcp-handler raw protocol.
client_start
Make sure the client side is ready to use in tcp-handler raw protocol.
recv
Recv the message in tcp-handler raw protocol.
send
Send the message in tcp-handler raw protocol.
server_init
Init the server side in tcp-handler raw protocol.
server_start
Make sure the server side is ready to use in tcp-handler raw protocol.