Chapter 8. Senders and receivers
Chapter 8. Senders and receivers The client uses sender and receiver links to represent channels for delivering messages. Senders and receivers are unidirectional, with a source end for the message origin, and a target end for the message destination. Sources and targets often point to queues or topics on a message broker. Sources are also used to represent subscriptions. 8.1. Creating queues and topics on demand Some message servers support on-demand creation of queues and topics. When a sender or receiver is attached, the server uses the sender target address or the receiver source address to create a queue or topic with a name matching the address. The message server typically defaults to creating either a queue (for one-to-one message delivery) or a topic (for one-to-many message delivery). The client can indicate which it prefers by setting the queue or topic capability on the source or target. To select queue or topic semantics, follow these steps: Configure your message server for automatic creation of queues and topics. This is often the default configuration. Set either the queue or topic capability on your sender target or receiver source, as in the examples below. Example: Sending to a queue created on demand var conn = container.connect({host: "example.com"}); var sender_opts = { target: { address: "jobs", capabilities: ["queue"] } } conn.open_sender( sender_opts ); Example: Receiving from a topic created on demand var conn = container.connect({host: "example.com"}); var receiver_opts = { source: { address: "notifications", capabilities: ["topic"] } } conn.open_receiver( receiver_opts ); For more details, see the following examples: queue-send.js queue-receive.js topic-send.js topic-receive.js 8.2. Creating durable subscriptions A durable subscription is a piece of state on the remote server representing a message receiver. Ordinarily, message receivers are discarded when a client closes. However, because durable subscriptions are persistent, clients can detach from them and then re-attach later. Any messages received while detached are available when the client re-attaches. Durable subscriptions are uniquely identified by combining the client container ID and receiver name to form a subscription ID. These must have stable values so that the subscription can be recovered. Set the connection container ID to a stable value, such as client-1 : var container = rhea.create_container({id: "client-1"}); Create a receiver with a stable name, such as sub-1 , and configure the receiver source for durability by setting the durable and expiry_policy properties: var receiver_opts = { source: { address: "notifications", name: "sub-1", durable: 2, expiry_policy: "never" } } conn.open_receiver(receiver_opts); To detach from a subscription, use the receiver.detach() method. To terminate the subscription, use the receiver.close() method. For more information, see the durable-subscribe.js example . 8.3. Creating shared subscriptions A shared subscription is a piece of state on the remote server representing one or more message receivers. Because it is shared, multiple clients can consume from the same stream of messages. The client configures a shared subscription by setting the shared capability on the receiver source. Shared subscriptions are uniquely identified by combining the client container ID and receiver name to form a subscription ID. These must have stable values so that multiple client processes can locate the same subscription. If the global capability is set in addition to shared , the receiver name alone is used to identify the subscription. To create a durable subscription, follow these steps: Set the connection container ID to a stable value, such as client-1 : var container = rhea.create_container({id: "client-1"}); Create a receiver with a stable name, such as sub-1 , and configure the receiver source for sharing by setting the shared capability: var receiver_opts = { source: { address: "notifications", name: "sub-1", capabilities: ["shared"] } } conn.open_receiver(receiver_opts); To detach from a subscription, use the receiver.detach() method. To terminate the subscription, use the receiver.close() method. For more information, see the shared-subscribe.js example .
var conn = container.connect({host: "example.com"}); var sender_opts = { target: { address: "jobs", capabilities: ["queue"] } } conn.open_sender( sender_opts ); var conn = container.connect({host: "example.com"}); var receiver_opts = { source: { address: "notifications", capabilities: ["topic"] } } conn.open_receiver( receiver_opts ); var container = rhea.create_container({id: "client-1"}); var receiver_opts = { source: { address: "notifications", name: "sub-1", durable: 2, expiry_policy: "never" } } conn.open_receiver(receiver_opts); var container = rhea.create_container({id: "client-1"}); var receiver_opts = { source: { address: "notifications", name: "sub-1", capabilities: ["shared"] } } conn.open_receiver(receiver_opts);