#tcp #tcp-stream #networking #server

tcp-server

方便的服务端TCP服务。基于tcp-handler。

11个版本

0.2.2 2024年1月28日
0.2.1 2024年1月27日
0.1.1 2024年1月26日
0.0.6 2024年1月9日
0.0.2 2023年12月28日

#2126 in 网络编程

Download history 22/week @ 2024-06-30 69/week @ 2024-07-28

每月下载量 69次

(MIT OR Apache-2.0) AND BSD-3-Clause

140KB
1.5K SLoC

Tcp-Server

Crate Crates.io License

在其他语言中阅读: 英文, 简体中文.

描述

方便的服务端TCP服务。也请参阅tcp-client(客户端)。

基于tcp-handler

拥有完整的API文档

使用

将以下内容添加到您的 Cargo.toml

[dependencies]
tcp-server = "~0.2"

示例

use tcp_server::{func_handler, Server};
use tcp_server::anyhow::anyhow;
use tcp_server::handler_base::FuncHandler;
use tcp_server::tcp_handler::bytes::{Buf, BufMut, BytesMut};
use tcp_server::tcp_handler::variable_len_reader::{VariableReader, VariableWriter};
use tcp_server::tokio::io::{AsyncReadExt, AsyncWriteExt};

struct MyServer;

impl Server for MyServer {
    fn get_identifier(&self) -> &'static str {
        "MyTcpApplication"
    }
    
    fn check_version(&self, version: &str) -> bool {
        version == env!("CARGO_PKG_VERSION")
    }
    
    fn get_function<R, W>(&self, func: &str) -> Option<Box<dyn FuncHandler<R, W>>>
        where R: AsyncReadExt + Unpin + Send, W: AsyncWriteExt + Unpin + Send {
        match func {
            // define your route here.
            // example:
            "hello" => Some(Box::new(HelloHandler)),
            _ => None,
        }
    }
}

// define your method here.
// example:
func_handler!(HelloHandler, |stream| {
    let mut reader = stream.recv().await?.reader();
    if "hello server" != reader.read_string()? {
        return Err(anyhow!("Invalid message."));
    }
    let mut writer = BytesMut::new().writer();
    writer.write_string("hello client")?;
    stream.send(&mut writer.into_inner()).await?;
    Ok(())
});

#[tokio::main]
async fn main() {
    MyServer.start().await.unwrap();
}

版本映射

版本映射到具有相同协议的tcp-client。(推荐联合使用,否则可能发生意外错误。)

客户端版本 服务端版本
>=0.1.0 >=0.2.0
<0.1.0 <0.2.0

依赖项

~4–15MB
~181K SLoC