Struct simple_websockets::EventHub

pub struct EventHub { /* private fields */ }

A queue of incoming events from clients.

The EventHub is the centerpiece of this library, and it is where all messages, connections, and disconnections are received.

Implementations

impl EventHub

pub fn drain(&self) -> Vec<Event>

Clears the event queue and returns all the events that were in the queue.

pub fn next_event(&self) -> Option<Event>

Returns the next event, or None if the queue is empty.

pub fn poll_event(&self) -> Event

Returns the next event, blocking if the queue is empty.

pub async fn poll_async(&self) -> Event

Async version of poll_event

pub fn is_empty(&self) -> bool

Returns true if there are currently no events in the queue.

Trait Implementations

impl Debug for EventHub

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

Formats the value using the given formatter.