Struct ProtocolConfig 

pub struct ProtocolConfig {
    pub app_id: String,
    pub profile: String,
    pub transport: TransportConfig,
    pub dors: DorsConfig,
    pub relay: RelayConfig,
    pub mesh_relay: MeshRelayConfig,
    pub path: PathConfig,
    pub reliability: ReliabilityConfig,
    pub encryption: EncryptionConfig,
    pub initial_ttl: u8,
    pub group: GroupConfig,
    pub security: SecurityConfig,
}

Main configuration for the Offline Protocol.

Fields

app_id: String

Application identifier (required).

profile: String

Local profile selector (required).

Selects which stored identity this instance runs as — one namespace per (app_id, profile) pair — so an app hosting several accounts gives each its own value, and an app hosting one can pass a constant like "default".

It is not the device’s identity. The wire identity is the self-certifying address derived from the identity key held in this profile’s storage: it is minted on first start, reported by crate::OfflineProtocol::local_address, and it is what gets stamped as Message.sender, what peers see as NeighborDiscovered.peer_id, and what others use as recipient. An app cannot choose it, because choosing it would mean claiming a key one does not hold.

Under any configuration that reaches the wire the profile stays local. The one exception is the explicit EncryptionConfig::require_encryption = false opt-out, which lets a plaintext send go out with MLS never initialized — no address has been derived at that point, so the frame carries the profile as its sender and the send emits crate::events::SecurityWarningCode::PlaintextSend. The default (require_encryption = true) fails such a send closed instead. Treat the profile as private if that opt-out is in use.

transport: TransportConfig

Transport configuration.

dors: DorsConfig

DORS (Dynamic Offline Relay Switch) configuration.

relay: RelayConfig

Relay management configuration: whether this device carries traffic for other people at all, and the battery floors under which it stops.

mesh_relay: MeshRelayConfig

How this device carries traffic for other people: how far frames travel, how many neighbors each is handed to, and the ceilings that keep forwarding from crowding the radio out.

Whether to forward is Self::relay’s decision; this is the shape of it once the answer is yes.

path: PathConfig

Path selection configuration.

reliability: ReliabilityConfig

Reliability layer configuration.

encryption: EncryptionConfig

Encryption configuration for automatic MLS handling.

initial_ttl: u8

Initial TTL (Time-To-Live) for messages.

group: GroupConfig

Mesh group messaging configuration.

security: SecurityConfig

Security configuration for transport and control-message hardening.

Implementations

impl ProtocolConfig

pub fn new(app_id: impl Into<String>, profile: impl Into<String>) -> Self

Creates a new protocol configuration.

Arguments

• app_id - Application identifier
• profile - Local profile selector (storage namespace, never on the wire)

pub fn builder( app_id: impl Into<String>, profile: impl Into<String>, ) -> ProtocolConfigBuilder

Creates a builder for more granular configuration.

pub fn validate(&self) -> Result<()>

Validates the configuration.

Returns

Returns Ok(()) if valid, Err with a description of the problem if invalid.

Trait Implementations

impl Clone for ProtocolConfig

fn clone(&self) -> ProtocolConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProtocolConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.