Struct QueueReceiver 

pub struct QueueReceiver<Sess, Payload, QueueImpl>
where
    Sess: Session,
    QueueImpl: Queue<Payload>,
{ /* private fields */ }

Encapsulates a Session and a Queue, polling from the Queue to implement Receive.

This is meant to be coupled with a QueueCallback or QueueCallbackRef, transforming a push-oriented callback into a poll-oriented receiver. Payloads dispatched to the QueueCallback/QueueCallbackRef are queued so that they may be polled via Receive::receive.

Queue is a trait, giving users have the flexibility to choose an implementation that satisfies their Publish/Sync requirements.

Implementations

impl<Sess, Payload, QueueImpl> QueueReceiver<Sess, Payload, QueueImpl>

where Sess: Session, QueueImpl: Queue<Payload>,

pub fn new(session: Sess, queue: QueueImpl) -> Self

Encapsulate the underlying session and queue

Trait Implementations

impl<Sess, Payload, QueueImpl> Debug for QueueReceiver<Sess, Payload, QueueImpl>

where Sess: Session, QueueImpl: Queue<Payload>,

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

Formats the value using the given formatter.

impl<Sess, Payload, QueueImpl> Flush for QueueReceiver<Sess, Payload, QueueImpl>

where Sess: Flush, QueueImpl: Queue<Payload> + 'static, Payload: 'static,

fn flush(&mut self) -> Result<(), Error>

Flush all pending publish data, blocking until completion.

impl<Sess, Payload, QueueImpl> Publish for QueueReceiver<Sess, Payload, QueueImpl>

where Sess: Publish, QueueImpl: Queue<Payload> + 'static, Payload: 'static,

type PublishPayload<'a> = <Sess as Publish>::PublishPayload<'a> where Self: 'a

The type given to the publish(..) function.

fn publish<'a>( &mut self, payload: Self::PublishPayload<'a>, ) -> Result<PublishOutcome<Self::PublishPayload<'a>>, Error>

Write the given payload to the session.

impl<Sess, Payload, QueueImpl> Receive for QueueReceiver<Sess, Payload, QueueImpl>

where Sess: Session, QueueImpl: Queue<Payload>,

type ReceivePayload<'a> = Payload where Self: 'a

The type returned by the receive(..) function.

fn receive<'a>( &'a mut self, ) -> Result<ReceiveOutcome<Self::ReceivePayload<'a>>, Error>

Attempt to receive a payload from the session. This will return ReceiveOutcome::Payload when data has been received. ReceiveOutcome::Active can be used to report that work was completed, but data is not ready. This means that only [ReceiveOutcome::None] should be used to indicate to a scheduler that yielding or idling is appropriate.

impl<Sess, Payload, QueueImpl> Session for QueueReceiver<Sess, Payload, QueueImpl>

where Sess: Session, QueueImpl: Queue<Payload>,

fn drive(&mut self) -> Result<DriveOutcome, Error>

Some implementations will internally buffer payloads or require a duty cycle to drive callbacks. Those implementations will require drive(..) to be called continuously to completely publish and/or receive data. This function will return DriveOutcome::Active if work was done, indicating to any scheduler that more work may be pending. When this function returns DriveOutcome::Idle, only then should it indicate to a scheduler that yielding or idling is appropriate.

fn status(&self) -> SessionStatus

Check the current session status.