LongPollingServiceContext

Struct LongPollingServiceContext 

Source
pub struct LongPollingServiceContext<AdditionalData, CustomData> { /* private fields */ }
Expand description

Context for sending messages to channels.

Implementations§

Source§

impl<AdditionalData, CustomData> LongPollingServiceContext<AdditionalData, CustomData>

Source

pub fn rx(&self) -> CometdEventReceiver<AdditionalData, CustomData>

Get new events receiver.

§Example
    let mut rx = context.rx();
     
    while let Some(event) = rx.recv().await {
        println!("Got event: `{event:?}`");
    }
Source

pub fn tx(&self) -> CometdCustomDataSender<AdditionalData, CustomData>

Get new events sender.

§Example
 async {
    let tx = context.tx();
     
    tx.send("hello").await;
Source

pub async fn send( &self, channel: &str, message: impl Debug + Serialize, ) -> Result<(), SendError>

Send message to channel.

§Example
#[derive(Debug, Clone, serde::Serialize)]
    struct Data<'a> {
        msg: std::borrow::Cow<'a, str>,
        r#bool: bool,
        num: u64,
    }

    let context = axum_cometd::LongPollingServiceContextBuilder::new()
        .timeout(Duration::from_secs(1))
        .max_interval(Duration::from_secs(2))
        .client_channel_capacity(10_000)
        .subscription_channel_capacity(20_000)
        .build::<(), ()>();

    loop {
        context
            .send(
                "/topic",
                Data {
                    msg: "Hello World!!!".into(),
                    r#bool: true,
                    num: u64::MAX,
                },
            )
            .await?;
        tokio::time::sleep(std::time::Duration::from_millis(1000)).await;
    }
Source

pub async fn send_to_client( &self, channel: &str, client_id: &ClientId, msg: impl Debug + Serialize, ) -> Result<(), SendError>

Send message direct to client.

Source

pub async fn unsubscribe(self: &Arc<Self>, client_id: ClientId)

Remove client.

Trait Implementations§

Source§

impl<AdditionalData: Debug, CustomData: Debug> Debug for LongPollingServiceContext<AdditionalData, CustomData>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<AdditionalData, CustomData> !Freeze for LongPollingServiceContext<AdditionalData, CustomData>

§

impl<AdditionalData, CustomData> !RefUnwindSafe for LongPollingServiceContext<AdditionalData, CustomData>

§

impl<AdditionalData, CustomData> Send for LongPollingServiceContext<AdditionalData, CustomData>
where AdditionalData: Sync + Send, CustomData: Sync + Send,

§

impl<AdditionalData, CustomData> Sync for LongPollingServiceContext<AdditionalData, CustomData>
where AdditionalData: Sync + Send, CustomData: Sync + Send,

§

impl<AdditionalData, CustomData> Unpin for LongPollingServiceContext<AdditionalData, CustomData>

§

impl<AdditionalData, CustomData> !UnwindSafe for LongPollingServiceContext<AdditionalData, CustomData>

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.

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, 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