A channel for receiving messages. A receiver contains an ordered sequence of deliveries.
Related: Class receiver-options, Class session, Class sender, Class delivery, Class terminus
Implementations: C, C++, Java, Python
AMQP: Conceptual overview, Attach performative, Detach performative, Flow performative, Transfer performative, Disposition performative
| Property | Summary | Type | Default value | Mutable | Nullable |
|---|---|---|---|---|---|
| container | The container holding this endpoint object | container | instance | ☐ | ☐ |
| session | The containing session | session | instance | ☐ | ☐ |
| source | The source end of the link | source | instance | ☐ | ☐ |
| target | The target end of the link | target | instance | ☐ | ☐ |
| name | The link name | string | discovered | ☐ | ☐ |
| deliveries | The deliveries contained in this receiver | iterator of delivery | instance | ☐ | ☐ |
| Method | Summary | Inputs | Outputs |
|---|---|---|---|
| open | Open the receiver | [options] | |
| close | Close the receiver | [error-condition] | |
| detach | Detach the receiver without closing it | [error-condition] |
| Property | Summary | Type | Default value | Mutable | Nullable |
|---|---|---|---|---|---|
| state | The remote endpoint state | endpoint-state | discovered | ☐ | ☐ |
| error | The remote endpoint error condition | error-condition | discovered | ☐ | ☒ |
| Method | Summary | Inputs | Outputs |
|---|---|---|---|
| add-work | Register a function to be called | function |
| Property | Summary | Type | Default value | Mutable | Nullable |
|---|---|---|---|---|---|
| properties | Application-defined properties | map of symbol ⇒ object | discovered | ☐ | ☒ |
| offered-capabilities | Extensions the endpoint supports | array of symbol | discovered | ☐ | ☒ |
| desired-capabilities | Extensions the endpoint can use | array of symbol | discovered | ☐ | ☒ |
| Property | Summary | Type | Default value | Mutable | Nullable |
|---|---|---|---|---|---|
| delivery-mode | The message delivery guarantee | delivery-mode | discovered | ☐ | ☐ |
Related: Property link.credit, Property receiver-options.credit-window
| Property | Summary | Type | Default value | Mutable | Nullable |
|---|---|---|---|---|---|
| credit | The number of messages the receiving end can accept | long | discovered | ☐ | ☐ |
| Method | Summary | Inputs | Outputs |
|---|---|---|---|
| add-credit | Issue credit to the sending end | count | |
| drain | Request any messages available at the sending end |
| Property | Summary | Type | Default value | Mutable | Nullable |
|---|---|---|---|---|---|
| max-message-size | The maximum message size | ulong | discovered | ☐ | ☒ |