Struct Client 

pub struct Client { /* private fields */ }

SMS Client.

Implementations

impl Client

pub fn new(config: ClientConfig) -> ClientResult<Self>

Create an SMS client with a connection config.

pub fn http(&self) -> ClientResult<&HttpClient>

Borrow the optional inner HTTP client.

pub fn http_arc(&self) -> ClientResult<Arc<HttpClient>>

Get a cloned Arc to the optional HTTP client for use in async contexts.

pub async fn on_message<F>(&self, callback: F) -> ClientResult<()>

where F: Fn(WebsocketMessage, Arc<Self>) + Send + Sync + 'static,

Set the callback for incoming WebSocket messages. The callback will include the WebSocket message and an Arc to the current Client allowing for easy use within the callback! This must be called before starting the WebSocket connection.

Example

use sms_client::http::types::HttpOutgoingSmsMessage;
use sms_client::ws::types::WebsocketMessage;
use sms_client::Client;
use log::info;

#[tokio::main]
async fn main() {
    let client: Client = unimplemented!("See other examples");

    client.on_message(move |message, client| {
        match message {
            WebsocketMessage::IncomingMessage(sms) => {
                // Can access client.http() here!
            },
            _ => { }
        }
    }).await?
}

pub async fn on_message_simple<F>(&self, callback: F) -> ClientResult<()>

where F: Fn(WebsocketMessage) + Send + Sync + 'static,

Set the callback for incoming WebSocket messages (simple version without client copy). This must be called before starting the WebSocket connection.

Example

use sms_client::Client;
use sms_client::ws::types::WebsocketMessage;
use log::info;

#[tokio::main]
async fn main() {
    let client: Client = unimplemented!("See other examples");

    client.on_message_simple(move |message| {
        match message {
            WebsocketMessage::OutgoingMessage(sms) => info!("Outgoing message: {:?}", sms),
            _ => { }
        }
    }).await?
}

pub async fn start_background_websocket(&self) -> ClientResult<()>

Start the WebSocket connection.

pub async fn start_blocking_websocket(&self) -> ClientResult<()>

Start the WebSocket connection and block until closed.

pub async fn stop_background_websocket(&self) -> ClientResult<()>

Stop the WebSocket connection.

pub async fn is_websocket_connected(&self) -> bool

Check if the WebSocket is currently connected.

pub async fn reconnect_websocket(&self) -> ClientResult<()>

Force a WebSocket reconnection.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.