Crate tx5

• :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-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-signal-srv - - Holochain webrtc signal server.
• 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-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.

Modules

• deps
  Re-exported dependencies.

Structs

• Config3
  Tx5 endpoint version 3 configuration.
• Ep3
  Tx5 endpoint version 3.
• Error
  Tx5 core error type.
• Id
  Tx5 32-byte identifier.
• 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.
• Tx5Url
  Tx5 url.

Enums

• Ep3Event
  Events generated by a tx5 endpoint version 3.

Traits

• ErrorExt
  Extension trait to extract a name from a Tx5 core error type.

Type Aliases

• PeerUrl
  A peer connection url.
• PreflightCheckCb
  Callback in charge of validating preflight data if any.
• PreflightSendCb
  Callback in charge of sending preflight data if any.
• Result
  A specialized Result type for I/O operations.
• SigUrl
  A signal server url.