Skip to main content

MIPClient

Struct MIPClient 

Source
pub struct MIPClient { /* private fields */ }
Expand description

Async MIP protocol client with auto-reconnection support

Implementations§

Source§

impl MIPClient

Source

pub fn new(options: MIPClientOptions) -> Self

Source

pub fn is_connected(&self) -> bool

Check if the client is connected

Source

pub fn on_connect<F>(&mut self, callback: F) -> &mut Self
where F: Fn() + Send + Sync + 'static,

Register connect event callback

Source

pub fn on_disconnect<F>(&mut self, callback: F) -> &mut Self
where F: Fn() + Send + Sync + 'static,

Register disconnect event callback

Source

pub fn on_reconnecting<F>(&mut self, callback: F) -> &mut Self
where F: Fn(u32) + Send + Sync + 'static,

Register reconnecting event callback

Source

pub fn on_message<F>(&mut self, callback: F) -> &mut Self
where F: Fn(MIPMessage) + Send + Sync + 'static,

Register message event callback

Source

pub fn on_event<F>(&mut self, callback: F) -> &mut Self
where F: Fn(MIPMessage) + Send + Sync + 'static,

Register event callback

Source

pub fn on_ack<F>(&mut self, callback: F) -> &mut Self
where F: Fn(u64) + Send + Sync + 'static,

Register ACK event callback

Source

pub fn on_pong<F>(&mut self, callback: F) -> &mut Self
where F: Fn() + Send + Sync + 'static,

Register pong event callback

Source

pub fn on_error<F>(&mut self, callback: F) -> &mut Self
where F: Fn(MIPError) + Send + Sync + 'static,

Register error event callback

Source

pub fn on_frame<F>(&mut self, callback: F) -> &mut Self
where F: Fn(Header, Vec<u8>) + Send + Sync + 'static,

Register raw frame event callback

Source

pub async fn connect(&mut self) -> MIPResult<()>

Connect to the MIP server

Source

pub async fn disconnect(&mut self) -> MIPResult<()>

Disconnect from the server

Source

pub fn subscribe(&self, topic: &str, require_ack: bool) -> MIPResult<u64>

Subscribe to a topic

Source

pub fn unsubscribe(&self, topic: &str, require_ack: bool) -> MIPResult<u64>

Unsubscribe from a topic

Source

pub fn publish( &self, topic: &str, message: &str, flags: FrameFlags, ) -> MIPResult<u64>

Publish a message to a topic

Source

pub fn ping(&self) -> MIPResult<u64>

Send a ping to the server

Source

pub fn send_raw_frame( &self, frame_type: FrameType, payload: &[u8], flags: FrameFlags, ) -> MIPResult<u64>

Send raw frame (advanced usage)

Trait Implementations§

Source§

impl Drop for MIPClient

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more