A channel for receiving messages. A receiver contains an ordered sequence of deliveries.
| Property | Summary | Type | Default value | Mutable | Nullable |
|---|---|---|---|---|---|
| client | The client holding this endpoint object | client | 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 | ☐ | ☐ |
| Method | Summary | Inputs | Outputs |
|---|---|---|---|
| wait | Block until the remote peer confirms the open operation | [timeout] | endpoint |
| (async) wait | Wait until the remote peer confirms the open operation | task of endpoint |
| Property | Summary | Type | Default value | Mutable | Nullable |
|---|---|---|---|---|---|
| state | The remote endpoint state | endpoint-state | discovered | ☐ | ☐ |
| error | The remote endpoint error condition | error-condition | discovered | ☐ | ☒ |
| detached | True if the link was detached, not permanently closed | boolean | discovered | ☐ | ☐ |
| Method | Summary | Inputs | Outputs |
|---|---|---|---|
| close | Start closing the endpoint | [error-condition] | future of endpoint |
| (async) close | Start closing the endpoint | [error-condition] | task of endpoint |
| detach | Detach the link without permanently closing it | [error-condition] | future of link |
| (async) detach | Detach the link without permanently closing it | [error-condition] | task of link |
| 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 |
|---|---|---|---|---|---|
| max-message-size | The maximum message size | ulong | discovered | ☐ | ☒ |
| Method | Summary | Inputs | Outputs |
|---|---|---|---|
| receive | Receive a delivery on the link | [timeout] | delivery |
| try-receive | Receive a delivery on the link or return null if none is available | delivery | |
| (async) receive | Receive a delivery on the link | task of delivery |