Struct libstrophe::Connection

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

Proxy to the underlying 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

Methods

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) -> EmptyResult

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)

xmpp_conn_disable_tls

pub fn is_secured(&self) -> bool

xmpp_conn_is_secured

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

xmpp_conn_set_keepalive

pub fn connect_client<CB>(
    self,
    alt_host: Option<&str>,
    alt_port: impl Into<Option<u16>>,
    handler: CB
) -> Result<Context<'cx, 'cb>, ConnectError<'cb, 'cx>> where
    CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, ConnectionEvent, i32, Option<&StreamError>) + Send + 'cb, 

xmpp_connect_client

Pre-last error: i32 argument in the handler contains a TLS error code that can be passed together with XMPP_CONN_DISCONNECT event. The specific meaning if that code depends on the underlying TLS implementation:

• for openssl it's the result of SSL_get_error()
• for schannel it's the result of WSAGetLastError()

Additionally the following OS dependent error constants can be set for error:

• ETIMEDOUT/WSAETIMEDOUT
• ECONNRESET/WSAECONNRESET
• ECONNABORTED/WSAECONNABORTED

pub fn connect_component<CB>(
    self,
    host: impl AsRef<str>,
    port: impl Into<Option<u16>>,
    handler: CB
) -> Result<Context<'cx, 'cb>, ConnectError<'cb, 'cx>> where
    CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, ConnectionEvent, i32, Option<&StreamError>) + Send + 'cb, 

xmpp_connect_component

See also 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>, ConnectError<'cb, 'cx>> where
    CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, ConnectionEvent, i32, Option<&StreamError>) + Send + 'cb, 

xmpp_connect_raw

See also connect_client() for additional info.

pub fn open_stream_default(&self) -> EmptyResult

xmpp_conn_open_stream_default

Related to connect_raw().

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

xmpp_conn_open_stream

Related to connect_raw().

pub fn tls_start(&self) -> EmptyResult

xmpp_conn_tls_start

Related to 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 send_raw() instead.

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

xmpp_send_raw

Be aware that this method doesn't print debug log line with the message being sent (unlike send_raw_string()).

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

xmpp_send

pub fn timed_handler_add<CB>(
    &mut self,
    handler: CB,
    period: Duration
) -> Option<TimedHandlerId<'cb, 'cx, CB>> where
    CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>) -> bool + Send + 'cb, 

xmpp_timed_handler_add

See handler_add() for additional information.

pub fn timed_handler_delete<CB>(&mut self, handler_id: TimedHandlerId<CB>)

xmpp_timed_handler_delete

See handler_delete() for additional information.

pub fn timed_handlers_clear(&mut self)

See handlers_clear() for additional information.

pub fn id_handler_add<CB>(
    &mut self,
    handler: CB,
    id: impl Into<String>
) -> Option<IdHandlerId<'cb, 'cx, CB>> where
    CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, &Stanza) -> bool + Send + 'cb, 

xmpp_id_handler_add

See handler_add() for additional information.

pub fn id_handler_delete<CB>(&mut self, handler_id: IdHandlerId<CB>)

xmpp_id_handler_delete

See handler_delete() for additional information.

pub fn id_handlers_clear(&mut self)

See 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<'cb, 'cx, CB>> where
    CB: FnMut(&Context<'cx, 'cb>, &mut Connection<'cb, 'cx>, &Stanza) -> bool + Send + 'cb, 

xmpp_handler_add

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

pub fn handler_delete<CB>(&mut self, handler_id: HandlerId<CB>)

xmpp_handler_delete

This version of this function accepts HandlerId returned from 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 handlers_clear() function.

pub fn handlers_clear(&mut self)

Removes all handlers that were set up with handler_add(). This function does not remove handlers added via id_handler_add(). You can use this function if you can't keep track of specific closure handles returned from handler_add(), but want to remove handlers anyway.

Trait Implementations

impl<'_, '_> Drop for Connection<'_, '_>

fn drop(&mut self)

xmpp_conn_release

impl<'_, '_> PartialEq<Connection<'_, '_>> for Connection<'_, '_>

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

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

#[must_use]

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

This method tests for !=.

impl<'_, '_> Eq for Connection<'_, '_>

impl<'_, '_> Send for Connection<'_, '_>

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

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

Formats the value using the given formatter.