Struct WebRtcConfig 

pub struct WebRtcConfig {
    pub advertise_on_nostr: Option<bool>,
    pub auto_connect: Option<bool>,
    pub accept_connections: Option<bool>,
    pub mtu: Option<u16>,
    pub max_connections: Option<usize>,
    pub connect_timeout_ms: Option<u64>,
    pub ice_gather_timeout_ms: Option<u64>,
    pub data_channel_label: Option<String>,
    pub ordered: Option<bool>,
    pub max_retransmits: Option<u16>,
    pub signal_relays: Option<Vec<String>>,
    pub stun_servers: Option<Vec<String>>,
}

WebRTC transport instance configuration.

WebRTC uses Nostr gift-wrapped signaling from node.discovery.nostr and carries ordinary FIPS datagrams over an SCTP data channel.

Fields

advertise_on_nostr: Option<bool>

Whether this transport should be advertised on Nostr overlay discovery. Default: false.

auto_connect: Option<bool>

Whether to automatically connect to discovered WebRTC peers. Default: false.

accept_connections: Option<bool>

Accept inbound WebRTC offers. Default: true.

mtu: Option<u16>

Data-channel MTU. Defaults to 1200.

max_connections: Option<usize>

Maximum simultaneous WebRTC peer connections. Defaults to 32.

connect_timeout_ms: Option<u64>

Outbound connect timeout in milliseconds. Defaults to 30000.

ice_gather_timeout_ms: Option<u64>

Non-trickle ICE gathering timeout in milliseconds. Defaults to 10000.

data_channel_label: Option<String>

Data channel label. Defaults to “fips”.

ordered: Option<bool>

Ordered data channel delivery. Default: false.

max_retransmits: Option<u16>

Maximum retransmits for partial reliability. Default: 0. Set to null/omit for the unreliable datagram-like default.

signal_relays: Option<Vec<String>>

Override signaling relays for this transport. When unset, node.discovery.nostr.dm_relays is used.

stun_servers: Option<Vec<String>>

Override STUN servers for this transport. When unset, node.discovery.nostr.stun_servers is used.

Implementations

impl WebRtcConfig

pub fn advertise_on_nostr(&self) -> bool

Whether this WebRTC transport should be advertised on Nostr discovery.

pub fn auto_connect(&self) -> bool

Whether this transport auto-connects to discovered peers.

pub fn accept_connections(&self) -> bool

Whether this transport accepts inbound offers.

pub fn mtu(&self) -> u16

Get the data-channel MTU.

pub fn max_connections(&self) -> usize

Get the maximum number of peer connections.

pub fn connect_timeout_ms(&self) -> u64

Get the connect timeout in milliseconds.

pub fn ice_gather_timeout_ms(&self) -> u64

Get the ICE gathering timeout in milliseconds.

pub fn data_channel_label(&self) -> &str

Get the data channel label.

pub fn ordered(&self) -> bool

Whether the data channel is ordered.

pub fn max_retransmits(&self) -> u16

Get the configured max retransmits. Default is 0.

pub fn signal_relays<'a>(&'a self, fallback: &'a [String]) -> Vec<String>

Resolve signaling relays, falling back to node discovery relays.

pub fn stun_servers<'a>(&'a self, fallback: &'a [String]) -> Vec<String>

Resolve STUN servers, falling back to node discovery STUN servers.

Trait Implementations

impl Clone for WebRtcConfig

fn clone(&self) -> WebRtcConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebRtcConfig

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

Formats the value using the given formatter.

impl Default for WebRtcConfig

fn default() -> WebRtcConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebRtcConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WebRtcConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.