Struct tx5::Ep

pub struct Ep { /* private fields */ }

A tx5 endpoint representing an instance that can send and receive.

Implementations

impl Ep

pub async fn new() -> Result<(Self, ManyRcv<EpEvt>)>

Construct a new tx5 endpoint.

pub async fn with_config<I: IntoConfig>( into_config: I ) -> Result<(Self, ManyRcv<EpEvt>)>

Construct a new tx5 endpoint with configuration.

pub fn listen( &self, sig_url: Tx5Url ) -> impl Future<Output = Result<Tx5Url>> + 'static + Send

Establish a listening connection to a signal server, from which we can accept incoming remote connections. Returns the client url at which this endpoint may now be addressed.

pub fn ban(&self, rem_id: Id, span: Duration)

Close down all connections to, fail all outgoing messages to, and drop all incoming messages from, the given remote id, for the specified ban time period.

pub fn send<B: Buf>( &self, rem_cli_url: Tx5Url, data: B ) -> impl Future<Output = Result<()>> + 'static + Send

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 fn broadcast<B: Buf>( &self, data: B ) -> impl Future<Output = Result<Vec<Result<()>>>> + 'static + Send

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.

This method is currently not ideal. It naively gets a list of open connection urls and adds the broadcast to all of their queues. This could result in a connection being re-established just for the broadcast to occur.

pub fn demo(&self) -> Result<()>

Send a demo broadcast to every connected signal server. Warning, if demo mode is not enabled on these servers, this could result in a ban.

pub fn get_stats(&self) -> impl Future<Output = Result<Value>> + 'static + Send

Get stats.

Trait Implementations

impl Clone for Ep

fn clone(&self) -> Ep

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Ep

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

Formats the value using the given formatter.

impl PartialEq<Ep> for Ep

fn eq(&self, other: &Ep) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Ep

impl StructuralEq for Ep

impl StructuralPartialEq for Ep