Struct Publisher

pub struct Publisher<T> {
    subs: Mutex<HashMap<SubscriptionID, Sender<T>>>,
    subscription_buffer_size: usize,
}

A simple publish-subscribe system.

use karyon_core::pubsub::{Publisher};

 async {
    let publisher = Publisher::new();
     
    let sub = publisher.subscribe().await;
     
    publisher.notify(&String::from("MESSAGE")).await;

    let msg = sub.recv().await;

    // ....
 };
  

Fields

subs: Mutex<HashMap<SubscriptionID, Sender<T>>>

subscription_buffer_size: usize

Implementations

impl<T: Clone> Publisher<T>

pub fn new() -> Arc<Publisher<T>>

Creates a new Publisher

pub fn with_buffer_size(size: usize) -> Arc<Publisher<T>>

Creates a new Publisher with the provided buffer size for the Subscription channel.

This is important to control the memory used by the Subscription channel. If the subscriber can’t keep up with the new messages coming, then the channel buffer will fill with new messages, and if the buffer is full, the emit function will block until the subscriber starts to process the buffered messages.

If size is zero, this function will panic.

pub async fn subscribe(self: &Arc<Self>) -> Subscription<T>

Subscribes and return a Subscription

pub async fn unsubscribe(self: &Arc<Self>, id: &SubscriptionID)

Unsubscribes by providing subscription id

pub async fn notify(self: &Arc<Self>, value: &T)

Notifies all subscribers