A top-level container of connections, sessions, senders, and receivers.
A container gives a unique identity to each communicating peer. It is often a process-level object.
It serves as an entry point to the API, allowing connections and links to be established. It can be supplied with an event handler in order to intercept important events, such as newly received messages or newly issued link credit for sending messages.
Related: Class connection, Class session, Class sender, Class receiver
Implementations: C, C++, Python
AMQP: Conceptual overview
Property | Summary | Type | Default value | Mutable | Nullable |
---|---|---|---|---|---|
id | A globally unique container identifier | string | generated | ☐ | ☐ |
auto-stop | Stop when all active connections and listeners are closed | boolean | true | ☒ | ☐ |
Method | Summary | Inputs | Outputs |
---|---|---|---|
connections | The connections managed by this container | iterator of connection | |
constructor | Create a new container | [messaging-handler], [id] | container |
run | Start processing events | ||
stop | Shutdown open connections and stop processing events | [error-condition] |
Property | Summary | Type | Default value | Mutable | Nullable |
---|---|---|---|---|---|
client-connection-options | Default options for new outbound connections | connection-options | instance | ☐ | ☐ |
server-connection-options | Default options for new inbound connections | connection-options | instance | ☐ | ☐ |
session-options | Default options for new sessions | session-options | instance | ☐ | ☐ |
sender-options | Default options for new senders | sender-options | instance | ☐ | ☐ |
receiver-options | Default options for new receivers | receiver-options | instance | ☐ | ☐ |
Method | Summary | Inputs | Outputs |
---|---|---|---|
connect | Create and open an outbound connection | connection-url, [options] | connection |
listen | Listen for incoming connections | listen-info, [handler], [options] | listener |
Method | Summary | Inputs | Outputs |
---|---|---|---|
open-receiver | Create and open a receiving link | address-url, [receiver-options] | receiver |
open-sender | Create and open a sending link | address-url, [sender-options] | sender |
Method | Summary | Inputs | Outputs |
---|---|---|---|
schedule | Schedule a function call | delay, function |