Struct Endpoint

pub struct Endpoint { /* private fields */ }

Tx5 endpoint.

Implementations

impl Endpoint

pub fn new(config: Arc<Config>) -> (Self, EndpointRecv)

Construct a new tx5 endpoint.

pub async fn listen(&self, sig_url: SigUrl) -> Option<PeerUrl>

Connect to a signal server as a listener, allowing incoming connections. You probably only want to call this once.

pub fn close(&self, peer_url: &PeerUrl)

Request that the peer connection identified by the given peer_url is closed.

pub async fn send(&self, peer_url: PeerUrl, data: Vec<u8>) -> Result<()>

Send data to a remote on this tx5 endpoint. The future returned from this method will resolve when the data is handed off to our networking backend.

pub async fn broadcast(&self, data: &[u8])

Broadcast data to all connections that happen to be open. If no connections are open, no data will be broadcast. The future returned from this method will resolve when all broadcast messages have been handed off to our networking backend (or have timed out).

pub fn get_listening_addresses(&self) -> Vec<PeerUrl>

Get a list of listening addresses (PeerUrls) at which this endpoint is currently reachable.

pub fn get_stats(&self) -> Stats

Get stats.

Trait Implementations

impl Debug for Endpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.