Skip to main content

PubSubManager

Struct PubSubManager 

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

Pub/Sub Manager interface

Uses StreamableHTTP protocol for all operations. Pub/Sub is reactive by default - use subscribe() and subscribe_topic().

Implementations§

Source§

impl PubSubManager

Source

pub async fn publish( &self, topic: &str, data: Value, priority: Option<u8>, headers: Option<HashMap<String, String>>, ) -> Result<usize>

Publish a message to a topic

§Returns

Returns the number of subscribers that received the message

§Example
let count = client.pubsub().publish(
    "user.created",
    json!({"id": 123, "name": "Alice"}),
    Some(5),
    None
).await?;
Source

pub async fn subscribe_topics( &self, subscriber_id: &str, topics: Vec<String>, ) -> Result<String>

Subscribe to topics

Supports wildcard patterns:

  • user.* - single-level wildcard
  • user.# - multi-level wildcard
§Returns

Returns a subscription ID

Source

pub async fn unsubscribe( &self, subscriber_id: &str, topics: Vec<String>, ) -> Result<()>

Unsubscribe from topics

Source

pub async fn list_topics(&self) -> Result<Vec<String>>

List all active topics

Source§

impl PubSubManager

Source

pub fn observe( &self, subscriber_id: impl Into<String>, topics: Vec<String>, ) -> (impl Stream<Item = PubSubMessage> + 'static, SubscriptionHandle)

Observe messages from Pub/Sub topics reactively using WebSocket

Returns a Stream of messages that are delivered in real-time via WebSocket. Supports wildcard patterns:

  • user.* - single-level wildcard
  • user.# - multi-level wildcard
§Arguments
  • subscriber_id - Unique subscriber identifier
  • topics - List of topics to subscribe to (supports wildcards)
§Example
use futures::StreamExt;
use synap_sdk::{SynapClient, SynapConfig};

let (mut stream, handle) = client.pubsub()
    .observe("subscriber-1", vec!["user.*".to_string(), "events.#".to_string()]);

// Process messages reactively
while let Some(message) = stream.next().await {
    tracing::info!("Received on {}: {:?}", message.topic, message.data);
}

// Stop subscribing
handle.unsubscribe();
Source

pub fn observe_topic( &self, subscriber_id: impl Into<String>, topic: impl Into<String>, ) -> (impl Stream<Item = PubSubMessage> + 'static, SubscriptionHandle)

Observe messages from a single topic reactively

Convenience method for subscribing to a single topic.

§Example
use futures::StreamExt;
use synap_sdk::{SynapClient, SynapConfig};

let (mut stream, handle) = client.pubsub()
    .observe_topic("subscriber-1", "user.events");

while let Some(message) = stream.next().await {
    tracing::info!("Received: {:?}", message);
}

handle.unsubscribe();

Trait Implementations§

Source§

impl Clone for PubSubManager

Source§

fn clone(&self) -> PubSubManager

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

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> 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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

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

Source§

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
Source§

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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