Struct hyper_usse::Server

pub struct Server { /* fields omitted */ }

An SSE server.

Methods

impl Server

pub fn new() -> Self

Create a new server with no clients.

pub fn add_client(&mut self, client: Sender)

Add a client to a server. Sender can be obtained by calling Body::channel().

pub async fn send_to_clients<'_, B: Into<Bytes>>(&'_ mut self, text: B) -> usize

Send some text to the clients. Most often, this text is made using an EventBuilder. This will automatically remove all disconnected clients.

This function returns the number of currently connected clients.

pub async fn send_heartbeat<'_>(&'_ mut self) -> usize

Send a heartbeat (empty SSE) to all clients. This does not perform any action, but will prevent your connection being timed out for lasting too long without any data being sent.

This function returns the number of currently connected clients.

pub fn disconnect_all(&mut self)

Disconnect all clients that are currently connected to the server.

pub fn connections(&self) -> usize

Count the number of currently held connections.

Note that this may be an over-estimate of the number of currently connected clients, as some clients may have disconnected since the last send_to_clients or send_heartbeat (both of which prune the list of connections to those which still have a connected client).

Trait Implementations

impl Debug for Server

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

Formats the value using the given formatter.

impl Default for Server

fn default() -> Server

Returns the "default value" for a type.