Crate tx5_core 

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-core

Holochain WebRTC p2p communication ecosystem core types.

Modules

deps

Re-exported dependencies.

file_check

A couple crates that depend on tx5-core need to be able to write/verify files on system. Enable this file_check feature to provide that ability.

Structs

Error

Tx5 core error type.

EventPermit

Permit for sending on the channel.

EventRecv

Receiver side of an explicitly bounded channel that lets us send bounded (backpressured) events, but unbounded error messages.

EventSend

Sender side of an explicitly bounded channel that lets us send bounded (backpressured) events, but unbounded error messages.

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.

Traits

ErrorExt

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

Type Aliases

BoxFut

Pinned, boxed, future type alias.

Result

A specialized Result type for I/O operations.