A container of senders and receivers.
| Property | Summary | Type | Default value | Mutable | Nullable |
|---|---|---|---|---|---|
| client | The client holding this endpoint object | client | instance | ☐ | ☐ |
| connection | The containing connection | connection | 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 | ☐ | ☒ |
| 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 |
| 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 | ☐ | ☒ |
| Method | Summary | Inputs | Outputs |
|---|---|---|---|
| open-sender | Create and open a sending link | address, [sender-options] | sender |
| open-anonymous-sender | Create and open a sender with no target address | [sender-options] | sender |
| open-receiver | Create and open a receiving link | address, [receiver-options] | receiver |
| open-dynamic-receiver | Create and open a dynamic receiver | [receiver-options], [timeout] | receiver |
| (async) open-dynamic-receiver | Create and open a dynamic receiver | [receiver-options] | task of receiver |