MultiRelayMessageManager

Struct MultiRelayMessageManager 

Source
pub struct MultiRelayMessageManager<S: MessageStorage> {
    relay_connections: Arc<RwLock<BTreeMap<KeyId, RelayConnection>>>,
    storage: Arc<S>,
    global_events_tx: Sender<MessageEvent>,
    global_messages_tx: Sender<StreamMessage>,
    global_catchup_tx: Sender<CatchUpResponse>,
    catch_up_tasks: Arc<RwLock<BTreeMap<KeyId, JoinHandle<()>>>>,
}
Expand description

Multi-relay message manager that provides unified messaging across multiple relays with offline support and automatic failover.

This manager:

  • Manages connections to multiple relay servers
  • Uses persistent storage for offline message queuing (no in-memory queue)
  • Implements automatic failover and load balancing
  • Aggregates messages from all connected relays
  • Deduplicates messages based on message ID
  • Maintains the same interface as a single MessagesManager

Fields§

§relay_connections: Arc<RwLock<BTreeMap<KeyId, RelayConnection>>>

Map of relay ID to relay connection info

§storage: Arc<S>

Storage for message persistence and offline queuing

§global_events_tx: Sender<MessageEvent>

Global message event broadcaster (aggregates from all relays)

§global_messages_tx: Sender<StreamMessage>

Global message broadcaster (aggregates from all relays)

§global_catchup_tx: Sender<CatchUpResponse>

Global catch-up response broadcaster

§catch_up_tasks: Arc<RwLock<BTreeMap<KeyId, JoinHandle<()>>>>

Map of active catch-up tasks by relay ID

Implementations§

Source§

impl<S: MessageStorage + 'static> MultiRelayMessageManager<S>

Source

pub fn new(storage: Arc<S>) -> Self

Create a new multi-relay message manager

Source

pub async fn add_relay( &self, relay_id: KeyId, manager: Arc<MessagesManager>, should_catch_up: bool, ) -> Result<()>

Add a relay connection to the manager

§Arguments
  • relay_id - The unique identifier for the relay
  • manager - The messages manager for this relay
  • should_catch_up - Whether to start catching up on historical messages
Source

pub async fn remove_relay( &self, relay_id: &KeyId, ) -> Option<Arc<MessagesManager>>

Remove a relay connection

Source

pub async fn get_connected_relay_ids(&self) -> Vec<KeyId>

Get list of currently connected relay IDs

Source

pub async fn get_all_relay_ids(&self) -> Vec<KeyId>

Get list of all relay IDs (connected and disconnected)

Source

pub async fn has_connected_relays(&self) -> bool

Check if any relays are currently connected

Source

async fn start_catch_up_task( &self, relay_id: KeyId, manager: Arc<MessagesManager>, ) -> Result<()>

Start a catch-up task for a specific relay

Source

async fn process_all_unsynced_messages_for_relay<M: MessagesManagerTrait>( storage: &Arc<S>, relay_id: &KeyId, manager: &Arc<M>, batch_size: usize, ) -> Result<usize>

Process all unsynced messages for a specific relay in batches Returns the total number of messages processed

Source

async fn process_unsynced_messages_batch_for_relay<M: MessagesManagerTrait>( storage: &Arc<S>, relay_id: &KeyId, manager: &Arc<M>, batch_size: usize, ) -> Result<Option<usize>>

Process a single batch of unsynced messages for a specific relay Returns:

  • Ok(Some(count)) if messages were processed (count = number successfully processed)
  • Ok(None) if no unsynced messages were found (indicates completion)
  • Err(_) if there was an error

Trait Implementations§

Source§

impl<S: Clone + MessageStorage> Clone for MultiRelayMessageManager<S>

Source§

fn clone(&self) -> MultiRelayMessageManager<S>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S: MessageStorage> Drop for MultiRelayMessageManager<S>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<S: MessageStorage + 'static> MessagesManagerTrait for MultiRelayMessageManager<S>

Source§

fn message_events_stream(&self) -> Receiver<MessageEvent>

Get a stream of all message events from all relays

Source§

fn get_subscription_state_updates<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Subscriber<SubscriptionState, AsyncLock>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Subscribe to subscription state changes (aggregated from all relays)

Source§

fn subscribe<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Subscribe to messages on all connected relays

Source§

fn publish<'life0, 'async_trait>( &'life0 self, message: MessageFull, ) -> Pin<Box<dyn Future<Output = Result<PublishResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Publish a message to available relays or queue for offline delivery

Source§

fn ensure_contains_filter<'life0, 'async_trait>( &'life0 self, filter: Filter, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Ensure a filter is included in the subscription on all connected relays

Source§

fn messages_stream(&self) -> Receiver<StreamMessage>

Get a stream of incoming messages from all relays

Source§

fn catch_up_stream(&self) -> Receiver<CatchUpResponse>

Get a stream of catch-up responses from all relays

Source§

fn filtered_messages_stream( &self, _filter: Filter, ) -> Pin<Box<dyn Stream<Item = Box<MessageFull>> + Send>>

Get a filtered stream of messages matching the given filter from all relays

Source§

fn catch_up_and_subscribe<'life0, 'async_trait>( &'life0 self, _filter: Filter, _since: Option<String>, ) -> Pin<Box<dyn Future<Output = Result<Pin<Box<dyn Stream<Item = Box<MessageFull>> + Send>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Catch up to historical messages and subscribe to new ones for a filter

Source§

fn user_data<'life0, 'async_trait>( &'life0 self, author: KeyId, storage_key: StoreKey, ) -> Pin<Box<dyn Future<Output = Result<Option<MessageFull>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get user data by author and storage key from any available relay

Source§

fn check_messages<'life0, 'async_trait>( &'life0 self, message_ids: Vec<MessageId>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Option<String>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Check which messages exist on any connected relay Returns the first successful result from any relay

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
§

impl<T> Classify for T

§

type Classified = T

§

fn classify(self) -> T

§

impl<T> Classify for T

§

type Classified = T

§

fn classify(self) -> T

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
§

impl<T> Declassify for T

§

type Declassified = T

§

fn declassify(self) -> T

§

impl<T> Declassify for T

§

type Declassified = T

§

fn declassify(self) -> T

Source§

impl<T> DynClone for T
where T: Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DartSafe for T

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> TaskRetFutTrait for T
where T: Send,