gbp-stack 0.2.0

Top-level facade for the Group Protocol Stack: re-exports gbp-core, gbp-protocol, gtp-protocol, gap-protocol, gsp-protocol, gbp-mls, gbp-transport and gbp-node.
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

//! Top-level facade for the [Group Protocol Stack].
//!
//! Most users should depend on this single crate; the layered architecture
//! is an implementation detail that is exposed for users who only need a
//! subset of the stack.
//!
//! # Layers
//!
//! ```text
//!   ┌────────────────────────────────────────────────────────┐
//!   │  Layer 4 — orchestration                               │
//!   │      gbp-node  →  gbp-stack  →  gbp-stack-ffi          │
//!   ├────────────────────────────────────────────────────────┤
//!   │  Layer 3 — security & transport                        │
//!   │      gbp-mls  ·  gbp-transport                         │
//!   ├────────────────────────────────────────────────────────┤
//!   │  Layer 2 — sub-protocols on top of GBP                 │
//!   │      gtp-protocol · gap-protocol · gsp-protocol        │
//!   ├────────────────────────────────────────────────────────┤
//!   │  Layer 1 — base protocol                               │
//!   │      gbp-protocol (GbpFrame, ControlMessage, …)        │
//!   ├────────────────────────────────────────────────────────┤
//!   │  Layer 0 — vocabulary                                  │
//!   │      gbp-core (StreamType, Flags, FSM, codes)          │
//!   └────────────────────────────────────────────────────────┘
//! ```
//!
//! [Group Protocol Stack]: https://github.com/F000NKKK/Group-Protocol-Stack

#![deny(missing_docs)]

pub use gap;
pub use gbp;
pub use gbp_core as core;
pub use gbp_mls as mls;
pub use gbp_node as node;
pub use gbp_transport as transport;
pub use gsp;
pub use gtp;

pub use gbp::{ControlMessage, ErrorObject, GbpFrame};

pub use gap::{GapAccept, GapClient, GapError, GapPayload};
pub use gsp::{GspAccept, GspClient, GspError, GspSignal};
pub use gtp::{GtpAccept, GtpClient, GtpError, GtpMessage};

pub use gbp_core::{
    ControlOpcode, ErrorClass, GbpFlags, GroupId, MemberId, NodeState, SignalType, StreamType,
    TransitionState, codes,
};

pub use gbp_mls::{MlsContext, StreamLabel, label_for};

pub use gbp_node::{DeliveredPayload, Event, GroupNode, NodeError, OutboundFrame, Sealer};

pub use gbp_transport::{MAX_FRAME, WireError, read_blob, read_frame, write_blob, write_frame};