Crate tx5_connection

• :warning: This code is new and should not yet be considered secure for production use!

Tx5

• tx5 - - The main holochain tx5 webrtc networking crate integrating the other code in this monorepo.

Tx5 Support Crates

• tx5-connection - - Holochain webrtc connection.
• tx5-core - - Core types used in other tx5 crates.
• tx5-online - - Network online connectivity status events.
• tx5-go-pion-turn - - Rust process wrapper around tx5-go-pion-turn executable.
• tx5-go-pion-sys - - Low level rust bindings to the go pion webrtc library.
• tx5-go-pion - - Higher level rust bindings to the go pion webrtc library.
• tx5-signal - - Holochain webrtc signal client.
• tx5-demo - - Demo showing off tx5 p2p connectivity.

tx5-connection

Holochain webrtc connection. Starts by sending messages over the sbd signal server, if we can upgrade to a proper webrtc p2p connection, we do so.

WebRTC Backend Features

Tx5 can be backed currently by 1 of 2 backend webrtc libraries.

• *DEFAULT* backend-go-pion - The pion webrtc library writen in go (golang).
  • https://github.com/pion/webrtc
• backend-webrtc-rs - The rust webrtc library.
  • https://github.com/webrtc-rs/webrtc

The go pion library is currently the default as it is more mature and well tested, but comes with some overhead of calling into a different memory/runtime. When the rust library is stable enough for holochain’s needs, we will switch the default. To switch now, or if you want to make sure the backend doesn’t change out from under you, set no-default-features and explicitly enable the backend of your choice.

Re-exports

pub use tx5_signal;

pub use super::*;

Structs

Conn

A tx5 connection.

ConnRecv

Receive messages from a tx5 connection.

ConnStats

Connection statistics.

FramedConn

A framed wrapper that can send and receive larger messages than the base connection.

FramedConnRecv

Receive a framed message on the connection.

Hub

A signal server connection from which we can establish tx5 connections.

HubConfig

Tx5 connection hub config.

HubRecv

A stream of incoming p2p connections.

Tx5InitConfig

Initial configuration. If you would like to change this from the default, please call Tx5InitConfig::set_as_global_default before creating any peer connections.

Enums

BackendModule

The backend webrtc module to use.