52个版本 (14个破坏性更新)

0.26.2 2024年4月2日
0.26.0 2023年10月11日
0.25.5 2023年10月4日
0.22.12 2023年7月11日
0.8.0 2021年6月29日

#172 in 压缩


2 crate中使用

MIT许可证

1MB
25K SLoC

Crates.io docs.rs MIT licensed

什么是Netidx

Netidx是一种中间件,它允许在一个程序中发布一个值(如42),并在另一个程序中(无论是同一台机器还是通过网络)消费它。

值在分层命名空间中具有全局唯一的名称。例如,我们发布的42可能被命名为/the-ultimate-answer(通常我们不会将值直接放在根下,但在此例中这是合适的)。网络上的任何其他程序都可以通过该名称引用42,并在(不太可能)/the-ultimate-answer更改时接收更新。

与其他系统的比较

  • 类似于LDAP

    • Netidx跟踪值的分层目录
    • Netidx在一定程度上可浏览和可查询
    • Netidx支持身份验证、授权和加密
    • Netidx值可以写入也可以读取。
    • 通过在较小的系统之间添加引用,可以构建较大的Netidx系统。解析器服务器集群可能有父亲和子代。
  • 与LDAP不同

    • 在Netidx中,解析器服务器(如slapd)只保留拥有数据的发布者的位置,而不是数据本身。
    • 没有'条目'、'属性'、'ldif记录'等。系统中的每个名称要么是结构性的,要么是单个值。使用分层创建类似条目的结构。因此,也没有模式检查。
    • 可以订阅一个值,并在它更改时立即得到通知。
    • 数据上没有全局过滤器,例如,您不能查询(&(cn=bob)(uid=foo)),因为netidx不是一个数据库。是否存在以及什么查询机制取决于发布者。然而,您可以查询结构,例如/foo/**/bar将返回以bar结尾的foo下的任何路径。
  • 类似于MQTT

    • Netidx的值是发布/订阅
    • 单个Netidx值可能有多个订阅者
    • 所有Netidx订阅者在订阅的值发生变化时都会收到更新。
    • Netidx消息传递是可靠且有序的。
  • 不同于MQTT

    • 在Netidx中,没有集中的消息代理。消息直接通过TCP从发布者流向订阅者。解析器服务器只存储发布者/发布值的地址。

更多详细信息请参阅netidx书籍

以下是一个示例服务,它发布CPU温度,以及相应的消费者订阅的数据。

发布者

use netidx::{
    publisher::{Publisher, Value, BindCfg},
    config::Config,
    resolver::Auth,
    path::Path,
};
use tokio::time;
use std::time::Duration;
use anyhow::Result;

fn get_cpu_temp() -> f32 { 42. }

async fn run() -> Result<()> {
    // load the site cluster config. You can also just use a file.
    let cfg = Config::load_default()?;

    // no authentication (kerberos v5 is the other option)
    // listen on any unique address matching 192.168.0.0/16
    let publisher = Publisher::new(cfg, Auth::Anonymous, "192.168.0.0/16".parse()?).await?;

    let temp = publisher.publish(
        Path::from("/hw/washu-chan/cpu-temp"),
        Value::F32(get_cpu_temp())
    )?;

    loop {
        time::sleep(Duration::from_millis(500)).await;
        let mut batch = publisher.start_batch();
        temp.update(&mut batch, Value::F32(get_cpu_temp()));
        batch.commit(None).await;
    }
    Ok(())
}

订阅者

use netidx::{
    subscriber::{Subscriber, UpdatesFlags},
    config::Config,
    resolver::Auth,
    path::Path,
};
use futures::{prelude::*, channel::mpsc};
use anyhow::Result;

async fn run() -> Result<()> {
    let cfg = Config::load_default()?;
    let subscriber = Subscriber::new(cfg, Auth::Anonymous)?;
    let path = Path::from("/hw/washu-chan/cpu-temp");
    let temp = subscriber.subscribe_one(path, None).await?;
    println!("washu-chan cpu temp is: {:?}", temp.last());

    let (tx, mut rx) = mpsc::channel(10);
    temp.updates(UpdatesFlags::empty(), tx);
    while let Some(mut batch) = rx.next().await {
        for (_, v) in batch.drain(..) {
            println!("washu-chan cpu temp is: {:?}", v);
        }
    }
    Ok(())
}

发布的事物始终有一个值,新订阅者最初接收这个值。之后,订阅是一个无损耗的有序流,就像Tcp连接一样,只不过传输的单位不是字节publisher::Value而是。由于订阅者可以将值写回发布者,因此连接是双向的,就像Tcp流一样。

值包括许多有用的原语,包括零拷贝的字节缓冲区(使用令人惊叹的bytes crate),因此您可以轻松使用netidx高效地发送任何喜欢的消息。然而,建议坚持使用原语,并用多个发布的值在层次结构中表达结构,因为这样可以使您的系统更容易被发现,并且也非常高效。

netidx包括对kerberos v5(包括Active Directory)的可选支持。如果启用,所有组件将在解析器、订阅者和发布者之间进行相互身份验证,以及加密所有传输中的数据。

在krb5模式下,解析器服务器维护并强制执行整个命名空间的一组授权权限。系统管理员可以集中执行谁可以发布在哪里,以及谁可以订阅什么。

依赖项

~29–61MB
~1M SLoC