Struct RelaySession 

pub struct RelaySession { /* private fields */ }

One deterministic transport-independent relay session.

Implementations

impl RelaySession

pub const fn new() -> Self

Create one disconnected session with empty bounded queues.

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

Begin a platform-owned connection attempt.

Errors

Returns SoftchatError::InvalidRelaySession unless disconnected or waiting in backoff.

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

Notify the session that the native WebSocket is open.

Existing subscriptions are replayed only after the host indicates authentication is complete.

Errors

Returns a stable transition error from any state except Connecting.

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

Mark NIP-42 authentication complete and replay session intent.

Errors

Returns a transition or bounded-queue failure.

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

Add or replace one subscription intent.

The request is queued immediately when ready and retained across reconnects.

Errors

Returns a validation, state, or bounded-queue failure.

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

Close one retained subscription.

Errors

Returns a state or bounded-queue failure.

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

Queue one or more already persisted authored events for publication.

Errors

Returns a state, duplicate-ID, event-validation, or queue failure.

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

Consume one complete relay WebSocket text frame.

Errors

Returns a frame, state, correlation, or backpressure failure.

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

Confirm that an authoritative platform transaction handled an event.

Errors

Returns a stable state error for an unknown or repeated confirmation.

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

Handle transport loss and classify only nonterminal in-flight events for retry.

Errors

Returns a transition error when no live transport existed.

pub fn cancel(&mut self) -> RelaySessionAction

Permanently cancel and clear process-local queues.

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

Drain at most limit queued frames for the platform WebSocket.

Errors

Returns a stable state error for zero limits.

pub fn snapshot(&self) -> RelaySessionSnapshot

Return a stable non-secret snapshot.

Trait Implementations

impl Debug for RelaySession

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

Formats the value using the given formatter.

impl Default for RelaySession

fn default() -> Self

Returns the “default value” for a type.