api/symfony/Component/Messenger/Transport/Receiver/ReceiverInterface.yaml
2024-09-26 02:03:21 -07:00

89 lines
2.2 KiB
YAML

name: ReceiverInterface
class_comment: null
dependencies:
- name: Envelope
type: class
source: Symfony\Component\Messenger\Envelope
- name: TransportException
type: class
source: Symfony\Component\Messenger\Exception\TransportException
properties: []
methods:
- name: get
visibility: public
parameters: []
comment: '# * @author Samuel Roze <samuel.roze@gmail.com>
# * @author Ryan Weaver <ryan@symfonycasts.com>
# */
# interface ReceiverInterface
# {
# /**
# * 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 iterable<Envelope>
# *
# * @throws TransportException If there is an issue communicating with the transport'
- name: ack
visibility: public
parameters:
- name: envelope
comment: '# * Acknowledges that the passed message was handled.
# *
# * @throws TransportException If there is an issue communicating with the transport'
- name: reject
visibility: public
parameters:
- name: envelope
comment: '# * Called when handling the message failed and it should not be retried.
# *
# * @throws TransportException If there is an issue communicating with the transport'
traits:
- Symfony\Component\Messenger\Envelope
- Symfony\Component\Messenger\Exception\TransportException
interfaces: []