interface QueueReceiverInterface implementsReceiverInterface

Some transports may have multiple queues. This interface is used to read from only some queues.

Methods

iterable
get()

Receives some messages.

void
ack(Envelope$envelope)

Acknowledges that the passed message was handled.

void
reject(Envelope$envelope)

Called when handling the message failed and it should not be retried.

iterable
getFromQueues(array$queueNames)

Get messages from the specified queue names instead of consuming from all queues.

Details

iterable get()

Receives some messages.

While this method could return an unlimited number of messages, the intention is that it returns only one, or a "small number" of messages each time. This gives the user more flexibility: they can finish processing the one (or "small number") of messages from this receiver and move on to check other receivers for messages. If this method returns too many messages, it could cause a blocking effect where handling the messages received from one call to get() takes a long time, blocking other receivers from being called.

If applicable, the Envelope should contain a TransportMessageIdStamp.

If a received message cannot be decoded, the message should not be retried again (e.g. if there's a queue, it should be removed) and a MessageDecodingFailedException should be thrown.

Return Value

iterable

Exceptions

TransportException If there is an issue communicating with the transport

void ack(Envelope$envelope)

Acknowledges that the passed message was handled.

Parameters

Envelope $envelope

Return Value

void

Exceptions

TransportException If there is an issue communicating with the transport

void reject(Envelope$envelope)

Called when handling the message failed and it should not be retried.

Parameters

Envelope $envelope

Return Value

void

Exceptions

TransportException If there is an issue communicating with the transport

iterable getFromQueues(array$queueNames)

Get messages from the specified queue names instead of consuming from all queues.

Parameters

array $queueNames

Return Value

iterable