roplat 0.2.0

roplat: just a robot operation system
Documentation 
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

//! 进程间通讯（IPC）旁路通讯模块
//!
//! 与 `triple_buffer` / `ring_buffer` 同级的第三类旁路通讯资源，
//! 负责跨进程数据交换。与进程内原语的根本差异：进程间不共享地址空间，
//! 因此引入「传输后端 + 端点发现 + 类型握手」三件套。
//!
//! 设计原则（对齐系统篇 §VII-A「进程内静态、进程间动态」主张）：
//! - 保持与 `triple_buffer` / `ring_buffer` 完全一致的用户契约：节点代码不变
//! - 在进程边界处显式对应：不穿透 system 图规约
//! - 开放世界假设：两侧进程可来自不同 crate、不同时刻启动
//!
//! MVP 覆盖：
//! - `transport` 模块：`IpcTransport` trait + 错误类型 + 握手协议
//! - `endpoint` 模块：端点 URI 解析与 `SchemaId` 计算
//! - `rendezvous` 模块：零依赖的基于文件的端点发现
//! - `ring_buffer` 模块：`IpcRingBuffer<T>`（SPSC FIFO，跨进程版本）
//! - `backend::tcp` 模块：跨平台 loopback TCP 后端
//! - `backend::loopback` 模块：进程内 mpsc 环回后端（仅单元测试用）

pub mod backend;
pub mod endpoint;
pub mod handshake;
pub mod rendezvous;
pub mod ring_buffer;
pub mod transport;
pub mod triple_buffer;

pub use endpoint::{EndpointUri, Role, SchemaId};
pub use handshake::{Hello, HelloAck};
pub use rendezvous::{RendezvousDescriptor, RendezvousDir};
pub use ring_buffer::{
    ConnectOptions, IpcOptions, IpcRingReader, IpcRingWriter, OverflowPolicy, TcpOptions,
    create_ipc_ring_buffer, create_ipc_ring_buffer_with_opts,
};
pub use transport::{IpcError, IpcResult, IpcTransport};
pub use triple_buffer::{
    IpcTripleReader, IpcTripleWriter, create_ipc_triple_buffer, create_ipc_triple_buffer_with_opts,
};