Struct IpcRpcClient

pub struct IpcRpcClient<U: UserMessage> { /* private fields */ }

Used to send messages to the connected server.

Implementations

impl<U: UserMessage> IpcRpcClient<U>

pub async fn initialize_client<F, Fut>( key: ConnectionKey, message_handler: F, ) -> Result<IpcRpcClient<U>, IpcRpcError>

where F: Fn(U) -> Fut + Send + Sync + 'static, Fut: Future<Output = Option<U>> + Send,

Initializes a client connected to the server which was paired with the given ConnectionKey.

pub fn send_timeout( &self, user_message: U, timeout: Duration, ) -> impl Future<Output = Result<U, IpcRpcError>> + Send + 'static

Sends a message, waiting the given timeout for a reply.

pub fn send( &self, user_message: U, ) -> impl Future<Output = Result<U, IpcRpcError>> + Send + 'static

Sends a message, will give up on receiving a reply after the DEFAULT_REPLY_TIMEOUT has passed.

pub fn wait_for_server_to_disconnect( &self, ) -> impl Future<Output = Result<(), IpcRpcError>> + Send + 'static

pub async fn schema_validated( &mut self, ) -> Result<SchemaValidationStatus, IpcRpcError>

Returns the outcome of automatic schema validation testing. This testing is performed on connection initiation.

Trait Implementations

impl<U: Clone + UserMessage> Clone for IpcRpcClient<U>

fn clone(&self) -> IpcRpcClient<U>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<U: Debug + UserMessage> Debug for IpcRpcClient<U>

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

Formats the value using the given formatter.

impl<U: UserMessage> Drop for IpcRpcClient<U>

fn drop(&mut self)

Executes the destructor for this type.