Skip to main content

RelaySessionHandle

Struct RelaySessionHandle 

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

Thread-safe generated-binding owner for one serialized relay session.

Implementations§

Source§

impl RelaySessionHandle

Source

pub fn new() -> Self

Construct an empty disconnected session.

Source

pub fn connect(&self) -> Result<RelaySessionAction, SoftchatError>

Begin a platform-owned WebSocket connection attempt.

§Errors

Returns a stable invalid-transition error.

Source

pub fn transport_connected(&self) -> Result<(), SoftchatError>

Notify the session that the native transport is connected.

§Errors

Returns a stable invalid-transition error.

Source

pub fn authenticated(&self) -> Result<(), SoftchatError>

Mark relay authentication complete and replay retained intent.

§Errors

Returns a stable transition or bounded-queue error.

Source

pub fn subscribe( &self, subscription_id: String, filter_json: Vec<String>, ) -> Result<(), SoftchatError>

Add or replace a subscription using strict filter JSON objects.

§Errors

Returns a stable filter, transition, or bounded-queue error.

Source

pub fn close_subscription( &self, subscription_id: String, ) -> Result<(), SoftchatError>

Close one retained subscription.

§Errors

Returns a stable state or bounded-queue error.

Source

pub fn publish(&self, events: Vec<SignedEvent>) -> Result<(), SoftchatError>

Queue already-persisted authored events for delivery.

§Errors

Returns a stable validation, state, or queue error.

Source

pub fn receive( &self, frame_json: String, ) -> Result<Vec<RelaySessionAction>, SoftchatError>

Consume one complete native WebSocket text frame.

§Errors

Returns a stable frame, correlation, state, or backpressure error.

Source

pub fn confirm_ingested(&self, event_id: String) -> Result<(), SoftchatError>

Confirm an authoritative platform transaction handled an event.

§Errors

Returns a stable persistence-result error for unknown IDs.

Source

pub fn transport_lost(&self) -> Result<Vec<RelaySessionAction>, SoftchatError>

Handle transport loss and return the reconnect plan.

§Errors

Returns a stable invalid-transition error.

Source

pub fn drain_outbound(&self, limit: u32) -> Result<Vec<String>, SoftchatError>

Drain at most limit ordered outbound text frames.

§Errors

Returns a stable error for a zero limit.

Source

pub fn snapshot(&self) -> RelaySessionSnapshot

Return one redacted serializable snapshot.

Source

pub fn cancel(&self) -> RelaySessionAction

Permanently cancel the session and clear process-local queues.

Trait Implementations§

Source§

impl Debug for RelaySessionHandle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RelaySessionHandle

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<UT> LiftRef<UT> for RelaySessionHandle

Source§

impl<UT> LowerError<UT> for RelaySessionHandle

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for RelaySessionHandle

Source§

type ReturnType = <Arc<RelaySessionHandle> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type. Read more
Source§

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call Read more
§

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts Read more
Source§

impl<UT> TypeId<UT> for RelaySessionHandle

Source§

const TYPE_ID_META: MetadataBuffer

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.

§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. 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> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,