rns_net/
lib.rs

1//! rns-net: Network node for Reticulum.
2//!
3//! Drives `rns-core::TransportEngine` with real TCP/UDP sockets and threads.
4//! Reads standard Python RNS config files, opens TCP server/client, UDP, and
5//! Local interfaces, persists identity and known destinations.
6
7#[cfg(feature = "hooks")]
8extern crate rns_hooks_crate as rns_hooks;
9
10pub mod common;
11pub mod event;
12pub mod hdlc;
13pub mod kiss;
14pub mod logging;
15pub mod rnode_kiss;
16pub use common::time;
17pub mod driver;
18pub mod interface;
19pub mod node;
20pub use common::config;
21pub mod announce_cache;
22pub mod ifac;
23pub mod md5;
24pub mod pickle;
25#[cfg(feature = "iface-local")]
26pub mod remote_management;
27pub mod rpc;
28pub mod serial;
29pub mod storage;
30pub use common::compressor;
31pub use common::link_manager;
32pub mod management;
33#[cfg(feature = "iface-local")]
34pub mod shared_client;
35pub use common::destination;
36pub mod discovery;
37pub mod holepunch;
38#[cfg(feature = "hooks")]
39pub mod provider_bridge;
40
41pub use config::RnsConfig;
42pub use destination::{AnnouncedIdentity, Destination, GroupKeyError};
43#[cfg(feature = "iface-backbone")]
44pub use driver::BackbonePeerPoolSettings;
45pub use driver::{AnnounceRateDefaults, Callbacks};
46pub use event::{
47    BackbonePeerHookEvent, BackbonePeerPoolMemberStatus, BackbonePeerPoolStatus,
48    BackbonePeerStateEntry, BlackholeInfo, Event, HookInfo, InterfaceStatsResponse, LinkInfoEntry,
49    LocalDestinationEntry, NextHopResponse, PathTableEntry, QueryRequest, QueryResponse,
50    RateTableEntry, ResourceInfoEntry, RuntimeConfigApplyMode, RuntimeConfigEntry,
51    RuntimeConfigError, RuntimeConfigErrorCode, RuntimeConfigSource, RuntimeConfigValue,
52    SingleInterfaceStat,
53};
54pub use ifac::IfacState;
55#[cfg(feature = "iface-auto")]
56pub use interface::auto::{AutoConfig, AutoFactory};
57#[cfg(feature = "iface-ax25-kiss")]
58pub use interface::ax25_kiss::{
59    decode_ui_frame as decode_ax25_ui_frame, encode_ui_frame as encode_ax25_ui_frame,
60    validate_address as validate_ax25_address, Ax25KissFactory,
61};
62#[cfg(feature = "iface-backbone")]
63pub use interface::backbone::{
64    BackboneClientConfig, BackboneClientInterfaceFactory, BackboneConfig, BackboneInterfaceFactory,
65};
66#[cfg(feature = "iface-i2p")]
67pub use interface::i2p::{I2pConfig, I2pFactory};
68#[cfg(feature = "iface-ax25-kiss")]
69pub use interface::kiss_iface::Ax25Address;
70#[cfg(feature = "iface-kiss")]
71pub use interface::kiss_iface::{KissFactory, KissIfaceConfig};
72#[cfg(feature = "iface-local")]
73pub use interface::local::{
74    LocalClientConfig, LocalClientFactory, LocalServerConfig, LocalServerFactory,
75};
76#[cfg(feature = "iface-pipe")]
77pub use interface::pipe::{PipeConfig, PipeFactory};
78pub use interface::registry::InterfaceRegistry;
79#[cfg(feature = "iface-rnode")]
80pub use interface::rnode::{RNodeConfig, RNodeFactory, RNodeMultiFactory, RNodeSubConfig};
81#[cfg(feature = "iface-serial")]
82pub use interface::serial_iface::{SerialFactory, SerialIfaceConfig};
83#[cfg(feature = "iface-tcp")]
84pub use interface::tcp::{TcpClientConfig, TcpClientFactory};
85#[cfg(feature = "iface-tcp")]
86pub use interface::tcp_server::{TcpServerConfig, TcpServerFactory};
87#[cfg(feature = "iface-udp")]
88pub use interface::udp::{UdpConfig, UdpFactory};
89#[cfg(all(feature = "iface-weave", target_os = "linux"))]
90pub use interface::weave::{
91    parse_device_frame as parse_weave_device_frame, WdclFrame, WeaveConfig, WeaveFactory,
92    WeaveInput, WeaveLogFrame, WeavePeerState, WeaveState,
93};
94pub use interface::{
95    InterfaceConfigData, InterfaceFactory, StartContext, StartResult, SubInterface,
96};
97pub use link_manager::{LinkManager, LinkManagerAction, RequestFailure, RequestResponse};
98pub use management::ManagementConfig;
99pub use node::{IfacConfig, InterfaceConfig, NodeConfig, RnsNode, SendError};
100#[cfg(feature = "hooks")]
101pub use provider_bridge::{
102    HookProviderEventEnvelope, OverflowPolicy, ProviderBridge, ProviderBridgeConfig,
103    ProviderEnvelope, ProviderMessage,
104};
105pub use rpc::{RpcAddr, RpcClient, RpcServer};
106pub use serial::Parity;
107#[cfg(feature = "iface-local")]
108pub use shared_client::SharedClientConfig;
109pub use storage::{
110    FsRatchetStore, KnownDestination, RatchetCleanupStats, RatchetEntry, RatchetStore, StoragePaths,
111};
112
113// Re-export commonly used types from rns-core
114pub use rns_core::constants::{
115    MODE_ACCESS_POINT, MODE_BOUNDARY, MODE_FULL, MODE_GATEWAY, MODE_INTERNAL, MODE_POINT_TO_POINT,
116    MODE_ROAMING,
117};
118pub use rns_core::link::TeardownReason;
119pub use rns_core::transport::types::InterfaceId;
120pub use rns_core::types::{
121    DestHash, DestinationType, Direction, IdentityHash, LinkId, PacketHash, ProofStrategy,
122};
rns_net/lib.rs

rns_net/
lib.rs
