Struct EventStreamGroup 

pub struct EventStreamGroup { /* private fields */ }

Allows waiting for events from any one of several streams on the same client

Implementations

impl EventStreamGroup

pub fn new(client: &HlapiClient) -> Self

Creates a new poller for streams on the given client

pub fn add<T: 'static + Send>(&mut self, stream: &EventStream<T>)

Adds a stream to the list of streams to be polled. The stream must be on the same client as was passed to new. While a stream is part of a group, it is kept alive, so if a stream is not used anymore it should be removed from all groups it is a part of.

pub fn remove<T: 'static + Send>(&mut self, stream: &EventStream<T>)

Removes a stream from the list of streams to be polled

pub fn wait_for_event( &self, timeout: Option<Duration>, ) -> Result<bool, HlapiClientError>

Waits until one of the registered streams has an event, with an optional timeout. A zero duration means a non-blocking wait (i.e. just check if any stream has an event), and None means wait forever. Returns Ok(true) if one has an event, Ok(false) if the timeout was hit, and Err if there was an error. The stream’s client is unusable by other threads while this method is running.