#messaging #streaming #stream #queue #build-time #message-queue #client-server

无 std selium

一个极具开发者友好性、可组合的消息平台,零配置构建时间

6 个版本 (破坏性)

0.5.0 2024 年 5 月 6 日
0.4.0 2024 年 2 月 15 日
0.3.1 2023 年 12 月 24 日
0.2.0 2023 年 10 月 19 日
0.1.0 2023 年 8 月 14 日

#547网络编程

Download history 141/week @ 2024-05-02 12/week @ 2024-05-09 4/week @ 2024-05-16 5/week @ 2024-05-23

每月 420 次下载

MPL-2.0 许可证

220KB
4K SLoC

Selium

Crates.io MPL2 licensed Build Status Audit Status

Selium 是一个极具开发者友好性、可组合的消息平台,具有零配置构建时间。

入门

Hello World

首先,创建一个新的 Cargo 项目

$ cargo new --bin hello-selium
$ cd hello-selium
$ cargo add futures
$ cargo add -F std selium
$ cargo add -F macros,rt tokio

将以下代码复制到 hello-world/src/main.rs

use futures::{SinkExt, StreamExt};
use selium::{prelude::*, std::codecs::StringCodec};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let connection = selium::client()
        .with_certificate_authority("certs/client/ca.der")? // your Selium cert authority
        .with_cert_and_key(
            "certs/client/localhost.der",
            "certs/client/localhost.key.der",
        )? // your client certificates
        .connect("127.0.0.1:7001") // your Selium server's address
        .await?;

    let mut publisher = connection
        .publisher("/some/topic") // choose a topic to group similar messages together
        .with_encoder(StringCodec) // allows you to exchange string messages between clients
        .open() // opens a new stream for sending data
        .await?;

    let mut subscriber = connection
        .subscriber("/some/topic") // subscribe to the publisher's topic
        .with_decoder(StringCodec) // use the same codec as the publisher
        .open() // opens a new stream for receiving data
        .await?;

    // Send a message and close the publisher
    publisher.send("Hello, world!".into()).await?;
    publisher.finish().await?;

    // Receive the message
    if let Some(Ok(message)) = subscriber.next().await {
        println!("Received message: {message}");
    }

    Ok(())
}

为了测试、开发 Selium 或直接进入操作,您可以使用 selium-tools CLI 生成用于 mTLS 的自签名证书集。

为此,安装 selium-tools 二进制文件,然后运行 gen-certs 命令。默认情况下,gen-certs 将证书输出到 certs/client/*certs/server/*。您可以使用 -s-c 参数分别覆盖这些路径。

$ cargo install selium-tools
$ cargo run --bin selium-tools gen-certs

接下来,打开一个新的终端窗口并启动一个新的 Selium 服务器,提供上一步生成的证书。

$ cargo install selium-tools
$ cargo install selium-server
$ cargo run --bin selium-server -- \
  --bind-addr=127.0.0.1:7001 \
  --ca certs/server/ca.der \
  --cert certs/server/localhost.der \
  --key certs/server/localhost.key.der

最后,在我们的原始终端窗口中运行客户端

$ cargo run

运行基准测试

仓库中包含一个 benchmarks 二进制文件,其中包含发布/订阅客户端的端到端基准测试。

这些基准测试测量了客户端编码/解码消息有效负载的性能,以及 Selium 服务器的响应性。

要使用默认选项运行基准测试,执行以下命令

$ cd benchmarks
$ cargo run --release

这将使用为基准配置参数提供的默认值运行基准测试,应产生类似以下摘要的输出

$ cargo run --release

Benchmark Results
---------------------
Number of Messages: 1,000,000
Number of Streams: 10
Message Size (Bytes): 32

| Duration             | Total Transferred    | Avg. Throughput      | Avg. Latency         |
| 1.3476 Secs          | 30.52 MB             | 22.65 MB/s           | 1347.56 ns           |

如果默认配置不足,执行以下命令查看基准测试参数列表。

$ cargo run -- --help

下一步

Selium是一个代理消息平台,这意味着它包含客户端和服务器组件。请查看clientserver仓库以获取更多信息。

我们还提供了包含所有这些信息和更多内容的用户指南。我们的入门章节将指导您在5分钟内设置一个安全、可工作的Selium平台。

为Selium做贡献

我们非常欢迎您的帮助!如果您有想要的功能,请先提出一个问题,以免失望。虽然我们很高兴合并符合我们路线图的建设性贡献,但您的功能可能并不完全符合。最好先检查一下。

依赖项

~17–30MB
~556K SLoC