Struct Connection

pub struct Connection<'cb, 'cx> { /* private fields */ }

Proxy to the underlying sys::xmpp_conn_t struct.

Most of the methods in this struct mimic the methods of the underlying library. So please see libstrophe docs for connection and handlers plus conn.c and handler.c sources. Only where it’s not the case or there is some additional logic involved then you can see the method description.

This struct implements:

• Drop (xmpp_conn_release).
• Eq by comparing internal pointers
• Send

Implementations

impl<'cb, 'cx> Connection<'cb, 'cx>

pub fn new(ctx: Context<'cx, 'cb>) -> Self

xmpp_conn_new

pub fn flags(&self) -> ConnectionFlags

xmpp_conn_get_flags

pub fn set_flags(&mut self, flags: ConnectionFlags) -> Result<()>

xmpp_conn_set_flags

pub fn jid(&self) -> Option<&str>

xmpp_conn_get_jid

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

xmpp_conn_get_bound_jid

pub fn set_jid(&mut self, jid: impl AsRef<str>)

xmpp_conn_set_jid

pub fn pass(&self) -> Option<&str>

xmpp_conn_get_pass

pub fn set_pass(&mut self, pass: impl AsRef<str>)

xmpp_conn_set_pass

pub fn disable_tls(&mut self)

👎Deprecated: replaced by set_flags()

xmpp_conn_disable_tls

pub fn is_secured(&self) -> bool

xmpp_conn_is_secured

pub fn set_keepalive(&mut self, timeout: Duration, interval: Duration)

👎Deprecated: replaced by set_sockopt_callback()

xmpp_conn_set_keepalive

pub fn is_connecting(&self) -> bool

xmpp_conn_is_connecting

pub fn is_connected(&self) -> bool

xmpp_conn_is_connected

pub fn is_disconnected(&self) -> bool

xmpp_conn_is_disconnected

pub fn set_cafile(&mut self, path: impl AsRef<str>)

xmpp_conn_set_cafile

pub fn set_capath(&mut self, path: impl AsRef<str>)

xmpp_conn_set_capath

pub fn set_certfail_handler<CB>(&mut self, handler: CB)

where CB: Fn(&TlsCert, &str) -> CertFailResult + Send + Sync + 'static,

xmpp_conn_set_certfail_handler xmpp_certfail_handler

Callback function receives TlsCert object and an error message.

pub fn peer_cert(&self) -> Option<TlsCert>

xmpp_conn_get_peer_cert

pub fn set_client_cert(&mut self, cert_path: &str, key_path: &str)

xmpp_conn_set_client_cert

pub fn cert_xmppaddr_num(&self) -> u32

xmpp_conn_cert_xmppaddr_num

pub fn cert_xmppaddr(&self, n: u32) -> Option<String>

xmpp_conn_cert_xmppaddr

pub fn set_password_callback<CB>(&mut self, handler: CB)

where CB: Fn(&Connection<'cb, 'cx>, usize) -> Option<String> + Send + 'cb,

xmpp_conn_set_password_callback xmpp_password_callback

Callback function receives Connection object and maximum allowed length of the password, it returns Some(String) with password on success or None in case of error. If the returned String is longer than maximum allowed length it is ignored and the error is returned.

pub fn clear_password_callback(&mut self) -> usize

Remove the callback set by Self::set_password_callback()

Returns the amount of the removed handlers.

pub fn set_sockopt_callback<CB>(&mut self, handler: CB)

where CB: Fn(*mut c_void) -> SockoptResult + Send + Sync + 'static,

xmpp_conn_set_sockopt_callback xmpp_sockopt_callback

Callback function receives pointer to a system-dependent socket object. See docs above for more details.

pub fn set_default_sockopt_callback(&mut self)

xmpp_sockopt_cb_keepalive

Sets default sockopt_callback function that just uses compile-time internal defaults for the socket timeout. Those values can be changed with a deprecated Connection::set_keepalive(). If you use that function then you don’t need to call Connection::set_default_sockopt_callback() manually because it will be called internally.

pub fn set_password_retries(&mut self, n: u32)

xmpp_conn_set_password_retries

pub fn get_keyfile(&self) -> Option<&str>

xmpp_conn_get_keyfile

pub fn send_queue_len(&self) -> i32

xmpp_conn_send_queue_len

pub fn send_queue_drop_element(&mut self, which: QueueElement) -> Option<String>

xmpp_conn_send_queue_drop_element

pub fn sm_state(&mut self) -> Option<SMState<'_, '_>>

xmpp_conn_get_sm_state

Because in the underlying library the output SMState object retains the reference to the Connection we need to prevent modifications to the Connection while a particular instance of SMState is alive.

pub fn set_sm_callback<CB>(&mut self, handler: CB)

where CB: FnMut(&mut Connection<'cb, 'cx>, SerializedSmStateRef<'_>) + Send + 'cb,

xmpp_conn_set_sm_callback

pub fn clear_sm_callback(&mut self) -> usize

Remove the callback set by Self::set_sm_callback()

Returns the amount of the removed handlers.

pub fn restore_sm_state(&mut self, sm_state: SerializedSmState) -> Result<()>

xmpp_conn_restore_sm_state

pub fn connect_client<CB>( self, alt_host: Option<&str>, alt_port: impl Into<Option<u16>>, handler: CB, ) -> Result<Context<'cx, 'cb>, ConnectClientError<'cb, 'cx>>

where CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, ConnectionEvent<'_, '_>) + Send + 'cb,

xmpp_connect_client xmpp_conn_handler

pub fn connect_component<CB>( self, host: impl AsRef<str>, port: impl Into<Option<u16>>, handler: CB, ) -> Result<Context<'cx, 'cb>, ConnectClientError<'cb, 'cx>>

where CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, ConnectionEvent<'_, '_>) + Send + 'cb,

xmpp_connect_component xmpp_conn_handler

See also Self::connect_client() for additional info.

pub fn connect_raw<CB>( self, alt_host: Option<&str>, alt_port: impl Into<Option<u16>>, handler: CB, ) -> Result<Context<'cx, 'cb>, ConnectClientError<'cb, 'cx>>

where CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, ConnectionEvent<'_, '_>) + Send + 'cb,

xmpp_connect_raw xmpp_conn_handler

See also Self::connect_client() for additional info.

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

xmpp_conn_open_stream_default

Related to Self::connect_raw().

pub fn open_stream(&self, attributes: &HashMap<&str, &str>) -> Result<()>

xmpp_conn_open_stream

Related to Self::connect_raw().

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

xmpp_conn_tls_start

Related to Self::connect_raw().

pub fn disconnect(&mut self)

xmpp_disconnect

pub fn send_raw_string(&mut self, data: impl AsRef<str>)

xmpp_send_raw_string

Be aware that this method performs a lot of allocations internally so you might want to use Self::send_raw() instead.

pub fn send_raw(&mut self, data: impl AsRef<[u8]>)

xmpp_send_raw

pub fn send(&mut self, stanza: &Stanza)

xmpp_send

pub fn timed_handler_add<CB>( &mut self, handler: CB, period: Duration, ) -> Option<TimedHandlerId>

where CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>) -> HandlerResult + Send + 'cb,

xmpp_timed_handler_add xmpp_timed_handler

See Self::handler_add for additional information.

pub fn timed_handler_delete(&mut self, handler_id: TimedHandlerId) -> usize

xmpp_timed_handler_delete

See Self::handler_delete() for additional information.

pub fn timed_handlers_clear(&mut self) -> usize

See Self::handlers_clear() for additional information.

pub fn id_handler_add<CB>( &mut self, handler: CB, id: impl Into<String>, ) -> Option<IdHandlerId>

where CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, &Stanza) -> HandlerResult + Send + 'cb,

xmpp_id_handler_add xmpp_handler

See Self::handler_add() for additional information.

pub fn id_handler_delete(&mut self, handler_id: IdHandlerId) -> usize

xmpp_id_handler_delete

See Self::handler_delete() for additional information.

pub fn id_handlers_clear(&mut self) -> usize

See Self::handlers_clear() for additional information.

pub fn handler_add<CB>( &mut self, handler: CB, ns: Option<&str>, name: Option<&str>, typ: Option<&str>, ) -> Option<HandlerId>

where CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, &Stanza) -> HandlerResult + Send + 'cb,

xmpp_handler_add xmpp_handler

This function returns HandlerId which is later can be used to remove the handler using Self::handler_delete().

pub fn handler_delete(&mut self, handler_id: HandlerId) -> usize

xmpp_handler_delete

This version of this function accepts HandlerId returned from [Self::add_handler()] function instead of function reference as the underlying library does. If you can’t keep track of those handles, but still want ability to remove handlers, check Self::handlers_clear() function. Returns the amount of the removed handlers.

pub fn handlers_clear(&mut self) -> usize

Removes all handlers that were set up with Self::handler_add().

This function does not remove handlers added via Self::id_handler_add(). You can use this function if you can’t keep track of specific closure handles returned from Self::handler_add(), but want to remove handlers anyway. Returns the amount of the removed handlers.

Trait Implementations

impl<'cb, 'cx> Debug for Connection<'cb, 'cx>

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

Formats the value using the given formatter.

impl Drop for Connection<'_, '_>

fn drop(&mut self)

xmpp_conn_release

impl PartialEq for Connection<'_, '_>

fn eq(&self, other: &Connection<'_, '_>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Connection<'_, '_>

impl Send for Connection<'_, '_>