offline-protocol 0.21.0

Main protocol engine for the Offline Protocol SDK
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

//! Main protocol engine for the Offline Protocol SDK.
//!
//! This crate ties together all the components (core, transport, router, reliability)
//! into a single easy-to-use API.
//!
//! All code in this crate is 100% safe Rust with no unsafe blocks.

#![deny(unsafe_code)]
#![warn(missing_docs)]

pub mod config;
pub mod constants;
pub mod error;
pub mod events;
pub mod file_transfer;
mod group_mesh;
mod media_envelope;
pub mod mls;
pub mod mls_observability;
pub mod protocol;
pub mod protocol_state_storage;
pub mod telemetry;
pub mod transport_manager;
pub mod visualization;

pub use config::{
    EncryptionConfig, GroupConfig, OverflowPolicy, PendingQueueConfig, ProtocolConfig,
    SecurityConfig, DEFAULT_PENDING_TTL_MS,
};
pub use error::{Error, EstablishmentState, Result, SessionStateError};
pub use events::{
    DecryptionFailureCode, DorsEscalationPhase, DorsEscalationReasonCode, DorsReasonCode, Event,
    EventCallback, GroupInfoMember, PresenceSource, PresenceStatus, UserGroupSummary,
};
pub use group_mesh::{GroupRichReadiness, GroupSendOptions, RelaySyncState};
pub use offline_protocol_services::MeshServices;
pub use protocol::mesh_relay::{MeshRelayConfig, MeshRelayStats};
pub use protocol::{MediaSendOptions, OfflineProtocol, SendMessageOptions};
pub use protocol_state_storage::{
    ProtocolStateError, ProtocolStateResult, ProtocolStateStorage,
    MAX_PROTOCOL_STATE_RECORD_TRANSFER_BYTES,
};
pub use transport_manager::TransportManager;
pub use visualization::{
    MessageStats, NetworkLink, NetworkNode, NetworkTopology, NetworkVisualizer, NodeRole,
};

#[cfg(test)]
mod dors_integration_tests;
#[cfg(test)]
mod group_mesh_tests;
#[cfg(test)]
mod test_identity;

// Re-export reliability types for configuration and telemetry frames
pub use offline_protocol_reliability::{
    AckConfig, DeduplicatorConfig, DeduplicatorMode, DeduplicatorStats, RetryConfig,
    RetryQueueStats,
};

// Re-export MLS types for end-to-end encryption
pub use mls::{
    EncryptedMessage, GroupId, GroupInfo, KeyPackageBundle, MlsManager, MlsStorage, WelcomeMessage,
};
pub use mls_observability::{
    DecryptionFailureKind, MlsErrorCategory, MlsEventEmitter, MlsLifecycleEvent,
    MlsOperationContext, NoopMlsEventEmitter,
};
pub use telemetry::{
    DeviceCapabilitySnapshot, MetricsFrame, MlsVerbosity, NoopTelemetrySink, RoutingDecision,
    RoutingPhase, RoutingReasonCode, TelemetryConfig, TelemetryRecord, TelemetrySink,
    TransportStateEvent,
};