1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
//! # libstrophe - ergonomic wrapper for Rust //! //! This library provides high level ergonomic bindings for [libstrophe], an XMPP client library. //! //! //! # Documentation //! //! The documentation for this library covers only Rust specific bits and refers to [original //! library documentation][docs] in most other cases. //! //! //! # Workflow //! //! The general workflow is quite similar to what you get with the C library. The topmost object is //! [`Context`]. It contains platform-specific bits like logging and memory allocation. Plus an event //! loop used to keep things going. This crate wraps logging with the facilities provided by [`log`] //! crate (provided the default `rust-log` feature is enabled). Memory allocation is also handled by //! Rust native means. When a [`Connection`] is created it will temporarily consume the [`Context`]. //! After all of the setup is done, call one of the `connect_*()` methods to retrieve the [`Context`] //! back. In this manner a single [`Context`] can be used for multiple [`Connection`]s consequently. //! When you're done with setting up [`Connection`]s for the [`Context`], use `run()` or `run_once()` //! methods to start the event loop rolling. //! //! //! # Safety //! //! This create tries to be as safe as possible. Yet it's not always possible to guarantee that when //! wrapping a C library. The following assumptions are made which might not necessary be true and //! thus might introduce unsafety: //! //! * [`Context`] event loop methods are borrowing `self` immutably considering it immutable (or //! more specifically having interior mutability) //! //! The main objects in this crate are marked as `Send` and it should be indeed be safe to send them //! between threads. Yet, no major investigation of the library source code has been performed to //! ensure that this is true. //! //! //! # Initialization and shutdown //! //! You don't need to call the initialization function, it's done automatically when creating a //! [`Context`]. Yet you might want to call the [`shutdown()`] function when your application //! terminates. Be aware though that the initialization can be called only once in the program //! lifetime so you won't be able to use the library properly after you called [`shutdown()`]. //! //! //! # Callbacks //! //! The crate has the ability to store callbacks taking ownership of them so you can pass closures //! and not care about storing them externally. There are some things to note about it though. Please //! note though that it's not always possible to know whether the underlying library accepted the //! callback or not. The crate will keep the closure internally in either case, though it may not ever //! be called by the library. You can still remove the callback with the corresponding `*handler_delete()` //! or `*handler_clear()` method. //! //! Due to the fact that the crate uses `userdata` to pass the actual user callback, it's not possible //! to use `userdata` inside the callbacks for your own data. So if you need to have a state between //! callback invocations you must use closures. //! //! Because the main objects are marked as `Send` and we store callbacks inside them, all callbacks //! must also be `Send`. //! //! //! # Examples //! ``` //! let connection_handler = |ctx: &libstrophe::Context, //! _conn: &mut libstrophe::Connection, //! _evt: libstrophe::ConnectionEvent, //! _error: i32, //! _stream_error: Option<&libstrophe::error::StreamError>| { //! ctx.stop(); //! }; //! //! let ctx = libstrophe::Context::new_with_default_logger(); //! let mut conn = libstrophe::Connection::new(ctx); //! conn.set_jid("example@127.0.0.1"); //! conn.set_pass("password"); //! let ctx = conn.connect_client(None, None, connection_handler).unwrap(); //! ctx.run(); //! libstrophe::shutdown(); //! ``` //! //! For more complete examples see this crate `src/examples` directory and [libstrophe examples]. //! //! //! # Crate features //! //! The following features are provided: //! //! * `rust-log` - enabled by default, makes the create integrate into Rust logging facilities //! * `libstrophe-0_9_2` - enabled by default, enables functionality specific to libstrophe-0.9.2 //! * `fail-tests` - development feature, enables some additional tests that must fail unless //! safety contracts are broken //! //! [libstrophe]: http://strophe.im/libstrophe/ //! [`log`]: https://crates.io/crates/log //! [docs]: http://strophe.im/libstrophe/doc/0.9.2/ //! [libstrophe examples]: https://github.com/strophe/libstrophe/tree/0.9.2/examples //! [`Context`]: https://docs.rs/libstrophe/*/libstrophe/struct.Context.html //! [`Connection`]: https://docs.rs/libstrophe/*/libstrophe/struct.Connection.html //! [`shutdown()`]: https://docs.rs/libstrophe/*/libstrophe/fn.shutdown.html use std::{ os::raw, sync, }; use bitflags::bitflags; use lazy_static::lazy_static; pub use sys::{ xmpp_conn_event_t as ConnectionEvent, xmpp_log_level_t as LogLevel, }; pub use self::connection::{Connection, HandlerId, IdHandlerId, TimedHandlerId}; pub use self::alloc_context::AllocContext; pub use self::context::Context; // fixme, pub(crate) is there to please IDEA pub(crate) use self::ffi_types::FFI; pub use self::logger::Logger; pub use self::stanza::{Stanza, StanzaMutRef, StanzaRef}; mod alloc_context; mod ffi_types; mod connection; mod context; pub mod jid; pub mod error; mod logger; mod stanza; #[cfg(test)] mod tests; #[cfg(test)] mod examples; bitflags! { pub struct ConnectionFlags: raw::c_long { const DISABLE_TLS = sys::XMPP_CONN_FLAG_DISABLE_TLS as raw::c_long; const MANDATORY_TLS = sys::XMPP_CONN_FLAG_MANDATORY_TLS as raw::c_long; const LEGACY_SSL = sys::XMPP_CONN_FLAG_LEGACY_SSL as raw::c_long; #[cfg(feature = "libstrophe-0_9_2")] const TRUST_TLS = sys::XMPP_CONN_FLAG_TRUST_TLS as raw::c_long; } } static INIT: sync::Once = sync::ONCE_INIT; static DEINIT: sync::Once = sync::ONCE_INIT; lazy_static! { static ref ALLOC_CONTEXT: AllocContext = { AllocContext::default() }; } /// Convert type to *void for passing as `userdata` fn as_void_ptr<T>(cb: &T) -> *mut raw::c_void { cb as *const _ as _ } /// Convert *void from `userdata` to appropriate type unsafe fn void_ptr_as<'cb, T>(ptr: *const raw::c_void) -> &'cb mut T { (ptr as *mut T).as_mut().expect("userdata must be non-null") } /// Ensure that underlying C library is initialized /// /// Must be called from every possible crate usage entry point. fn init() { INIT.call_once(|| { unsafe { sys::xmpp_initialize(); } }); } fn deinit() { DEINIT.call_once(|| { unsafe { sys::xmpp_shutdown() } }); } /// [xmpp_version_check](http://strophe.im/libstrophe/doc/0.9.2/group___init.html#ga6cc7afca422acce51e0e7f52424f1db3) pub fn version_check(major: i32, minor: i32) -> bool { unsafe { FFI(sys::xmpp_version_check(major, minor)).receive_bool() } } /// [xmpp_shutdown](http://strophe.im/libstrophe/doc/0.9.2/group___init.html#ga06e07524aee531de1ceb825541307963) /// /// Call this function when your application terminates, but be aware that you can't use the library /// after you called `shutdown()` and there is now way to reinitialize it again. /// /// This function is thread safe, it's safe to call it several times and it's safe to call it before /// doing any initialization. pub fn shutdown() { init(); deinit(); }