Crate tx5 

P2P WebRTC connection establishment and pooling. Tx5 uses SBD as the WebRTC signaling protocol for connection establishment, providing an interface where you can attempt to send data to any known peer with the expectation that Tx5 will open a connection to that peer or use an existing open connection.

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

Tx5 - The main holochain tx5 webrtc networking crate.

WebRTC Backend Features

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

• *DEFAULT* backend-libdatachannel - WebRTC library written in C++.
  • https://github.com/paullouisageneau/libdatachannel
• backend-go-pion - The pion webrtc library written in Go (golang).
  • https://github.com/pion/webrtc

The go pion library was the original implementation, but as libdatachannel has reached stability, we have switched it over to be the default as it is much easier to write rust FFI bindings to C++ code than Go code.

Modules

backend

Backend modules usable by tx5.

stats

Return types for get_stats() call.

Structs

Config

Tx5 endpoint configuration.

Endpoint

Tx5 endpoint.

EndpointRecv

Receiver for endpoint events.

IceServers

Configuration for a group of ICE servers.

PeerUrl

A peer connection url.

PubKey

Public key.

SigUrl

A signal server url.

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.

WebRtcConfig

WebRTC config.

Enums

EndpointEvent

Endpoint event.

Type Aliases

BoxFuture

Dynamic future type.

PreflightCheckCb

Callback in charge of validating preflight data if any.

PreflightSendCb

Callback in charge of sending preflight data if any.