Struct xmpp::agent::TokioXmppClient

pub struct TokioXmppClient<C>
where
    C: ServerConnector,
{ /* private fields */ }

XMPP client connection and state

It is able to reconnect. TODO: implement session management.

This implements the futures crate’s Stream and Sink traits.

Implementations

impl<C> Client<C>

where C: ServerConnector,

pub fn set_reconnect(&mut self, reconnect: bool) -> &mut Client<C>

Set whether to reconnect (true) or let the stream end (false) when a connection to the server has ended.

pub fn bound_jid(&self) -> Option<&Jid>

Get the client’s bound JID (the one reported by the XMPP server).

pub async fn send_stanza(&mut self, stanza: Stanza) -> Result<(), Error>

Send stanza

pub fn get_stream_features(&self) -> Option<&StreamFeatures>

Get the stream features (<stream:features/>) of the underlying stream

pub async fn send_end(&mut self) -> Result<(), Error>

End connection by sending </stream:stream>

You may expect the server to respond with the same. This client will then drop its connection.

Make sure to disable reconnect.

impl Client<StartTlsServerConnector>

pub fn new<J, P>(jid: J, password: P) -> Client<StartTlsServerConnector>

where J: Into<Jid>, P: Into<String>,

Available on crate feature starttls only.

Start a new XMPP client using StartTLS transport and autoreconnect

Start polling the returned instance so that it will connect and yield events.

pub fn new_starttls<J, P>( jid: J, password: P, dns_config: DnsConfig, timeouts: Timeouts, ) -> Client<StartTlsServerConnector>

where J: Into<Jid>, P: Into<String>,

Available on crate feature starttls only.

Start a new XMPP client with StartTLS transport and specific DNS config

impl Client<TcpServerConnector>

pub fn new_plaintext<J, P>( jid: J, password: P, dns_config: DnsConfig, timeouts: Timeouts, ) -> Client<TcpServerConnector>

where J: Into<Jid>, P: Into<String>,

Available on crate feature insecure-tcp only.

Start a new XMPP client with plaintext insecure connection and specific DNS config

impl<C> Client<C>

where C: ServerConnector,

pub fn new_with_connector<J, P>( jid: J, password: P, connector: C, timeouts: Timeouts, ) -> Client<C>

where J: Into<Jid>, P: Into<String>,

Start a new client given that the JID is already parsed.

Trait Implementations

impl<C> Sink<Stanza> for Client<C>

where C: ServerConnector,

Outgoing XMPP packets

See send_stanza() for an async fn

type Error = Error

The type of value produced by the sink when an error occurs.

fn start_send( self: Pin<&mut Client<C>>, item: Stanza, ) -> Result<(), <Client<C> as Sink<Stanza>>::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_ready( self: Pin<&mut Client<C>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Client<C> as Sink<Stanza>>::Error>>

Attempts to prepare the Sink to receive a value.

fn poll_flush( self: Pin<&mut Client<C>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Client<C> as Sink<Stanza>>::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Client<C>>, cx: &mut Context<'_>, ) -> Poll<Result<(), <Client<C> as Sink<Stanza>>::Error>>

Flush any remaining output and close this sink, if necessary.

impl<C> Stream for Client<C>

where C: ServerConnector,

Incoming XMPP events

In an async fn you may want to use this with use futures::stream::StreamExt;

fn poll_next( self: Pin<&mut Client<C>>, cx: &mut Context<'_>, ) -> Poll<Option<<Client<C> as Stream>::Item>>

Low-level read on the XMPP stream, allowing the underlying machinery to:

• connect,
• starttls,
• authenticate,
• bind a session, and finally
• receive stanzas

…for your client

type Item = Event

Values yielded by the stream.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.