Skip to main content

PushServer

Struct PushServer 

Source
pub struct PushServer<C: ChannelKind> { /* private fields */ }
Expand description

Generic multiplexed push server parameterized by channel type.

C implements ChannelKind and defines the channel taxonomy. Channel-specific handling is registered by the consumer via register_handler.

Implementations§

Source§

impl<C: ChannelKind> PushServer<C>

Source

pub fn new() -> Self

Source

pub fn with_auth_validator(auth_validator: AuthValidator<C>) -> Self

Source

pub fn router(self: Arc<Self>) -> Router<Arc<Self>>

Axum router exposing /rps (WebSocket), /rps/sse, and /rps/ack.

Source

pub fn connected_clients(&self) -> usize

Number of currently connected WebSocket clients.

Source

pub fn connected_client_ids(&self) -> Vec<Uuid>

All currently connected client IDs.

Source

pub fn register_handler<F>(&self, channel: C, handler: F)
where F: Fn(Uuid, Frame<C>, &PushServer<C>) + Send + Sync + 'static,

Register a handler for a specific channel. When a frame arrives on this channel, the handler is invoked with the client ID, the frame, and a reference to the server.

Source

pub async fn upgrade(self: Arc<Self>, ws: WebSocketUpgrade) -> impl IntoResponse

Upgrade an HTTP request to an RPS WebSocket connection.

Source

pub fn send(&self, client_id: Uuid, frame: Frame<C>) -> Result<(), SendError>

Push a frame to a connected client.

Source

pub fn send_binary( &self, client_id: Uuid, channel: C, bytes: &[u8], mime: &str, name: Option<&str>, pointer_url: Option<&str>, ) -> Result<(), SendError>

Send a binary asset using inline-or-pointer logic.

Source

pub fn send_system(&self, client_id: Uuid, op: SystemOp<C>)

Send a system-level message to a client.

Trait Implementations§

Source§

impl<C: ChannelKind> Default for PushServer<C>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<C> Freeze for PushServer<C>

§

impl<C> !RefUnwindSafe for PushServer<C>

§

impl<C> Send for PushServer<C>

§

impl<C> Sync for PushServer<C>

§

impl<C> Unpin for PushServer<C>

§

impl<C> UnsafeUnpin for PushServer<C>

§

impl<C> !UnwindSafe for PushServer<C>

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> Same for T

Source§

type Output = T

Should always be Self
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
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,