A channel for sending messages. A sender contains an ordered sequence of deliveries.
Related: Class sender-options, Class session, Class receiver, 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 | ☐ | ☐ |
trackers | The trackers contained in this sender | iterator of tracker | instance | ☐ | ☐ |
Method | Summary | Inputs | Outputs |
---|---|---|---|
open | Open the sender | [sender-options] | |
close | Close the sender | [error-condition] | |
detach | Detach the sender 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 | ☐ | ☐ |
Property | Summary | Type | Default value | Mutable | Nullable |
---|---|---|---|---|---|
credit | The number of messages the receiving end can accept | long | discovered | ☐ | ☐ |
draining proposed | The sender is being drained | boolean | discovered | ☐ | ☐ |
sendable proposed | A message can be sent | boolean | discovered | ☐ | ☐ |
Property | Summary | Type | Default value | Mutable | Nullable |
---|---|---|---|---|---|
max-message-size | The maximum message size | ulong | discovered | ☐ | ☒ |
Method | Summary | Inputs | Outputs |
---|---|---|---|
send | Send a message on the link | message | tracker |