Skip to main content

Module signaling_method

Module signaling_method 

Source
Expand description

WebRTC Signaling Transport Methods

This module defines the different transport methods available for WebRTC signaling in Mina Rust’s peer-to-peer network. WebRTC requires an external signaling mechanism to exchange connection metadata before establishing direct peer-to-peer connections.

§Signaling Transport Methods

The Mina Rust node supports multiple signaling transport methods to accommodate different network environments and security requirements:

§HTTP/HTTPS Direct Connections

  • HTTP: Direct HTTP connections to signaling servers (typically for local/testing)
  • HTTPS: Secure HTTPS connections to signaling servers (recommended for production)

These methods allow peers to directly contact signaling servers to exchange offers and answers for WebRTC connection establishment.

§HTTPS Proxy

  • HTTPS Proxy: Uses an SSL gateway/proxy server to reach the actual signaling server

§P2P Relay Signaling

  • P2P Relay: Uses existing peer connections to relay signaling messages
  • Enables signaling through already-established peer connections
  • Provides redundancy when direct signaling server access is unavailable
  • Supports bootstrapping new connections through existing network peers

§URL Format

Signaling methods use a structured URL format:

  • HTTP: /http/{host}/{port}
  • HTTPS: /https/{host}/{port}
  • HTTPS Proxy (legacy): /https_proxy/{cluster_id}/{host}/{port}
  • Proxied: /proxied/{http|https}/{encoded_prefix}/{host}/{port}
  • P2P Relay: /p2p/{peer_id}

§Connection Strategy

The signaling method determines how peers discover and connect to each other:

  1. Direct Methods (HTTP/HTTPS) - Can connect immediately to signaling servers
  2. Proxy Methods - Route through intermediate proxy infrastructure
  3. Relay Methods - Require existing peer connections for message routing

Re-exports§

pub use http::HttpSignalingInfo;

Modules§

http 🔒
HTTP signaling transport configuration.

Structs§

PathPrefix
URL path prefix for proxy signaling.

Enums§

ProxyScheme
Proxy connection scheme (HTTP or HTTPS).
SignalingMethod
WebRTC signaling transport method configuration.
SignalingMethodParseError
Errors that can occur when parsing signaling method strings.