Class | Qpid::Proton::Messenger::Messenger |
In: |
lib/messenger/messenger.rb
|
Parent: | Object |
The Messenger class defines a high level interface for sending and receiving Messages. Every Messenger contains a single logical queue of incoming messages and a single logical queue of outgoing messages. These messages in these queues may be destined for, or originate from, a variety of addresses.
The messenger interface is single-threaded. All methods except one ( interrupt ) are intended to be used from within the messenger thread.
The Messenger class works in conjuction with the Message class. The Message class is a mutable holder of message content.
The put method copies its Message to the outgoing queue, and may send queued messages if it can do so without blocking. The send method blocks until it has sent the requested number of messages, or until a timeout interrupts the attempt.
Similarly, the recv method receives messages into the incoming queue, and may block as it attempts to receive the requested number of messages, or until timeout is reached. It may receive fewer than the requested number. The get method pops the eldest Message off the incoming queue and copies it into the Message object that you supply. It will not block.
The blocking attribute allows you to turn off blocking behavior entirely, in which case send and recv will do whatever they can without blocking, and then return. You can then look at the number of incoming and outgoing messages to see how much outstanding work still remains.
Signal the sender that you have acted on the Message pointed to by the tracker. If no tracker is supplied, then all messages that have been returned by the get method are accepted, except those that have already been auto-settled by passing beyond your incoming window size.
Path to a certificate file for the Messenger.
This certificate is used when the Messenger accepts or establishes SSL/TLS connections. This property must be specified for the Messenger to accept incoming SSL/TLS connections and to establish client authenticated outgoing SSL/TLS connection. Non client authenticated outgoing SSL/TLS connections do not require this property.
Moves the message from the head of the incoming message queue into the supplied message object. Any content in the supplied message will be overwritten. A tracker for the incoming Message is returned. The tracker can later be used to communicate your acceptance or rejection of the Message.
If no message is provided in the argument, then one is created. In either case, the one returned will be the fetched message.
Sets the incoming window.
The Messenger will track the remote status of this many incoming deliveries after they have been accepted or rejected.
Messages enter this window only when you take them into your application using get(). If your incoming window size is n, and you get n+1 messages without explicitly accepting or rejecting the oldest message, then the message that passes beyond the edge of the incoming window will be assigned the default disposition of its link.
Attempts interrupting of the messenger thread.
The Messenger interface is single-threaded, and this is the only function intended to be called from outside of is thread.
Call this from a non-Messenger thread to interrupt it while it is blocking. This will cause a ::InterruptError to be raised.
If there is no currently blocking call, then the next blocking call will be affected, even if it is within the same thread that originated the interrupt.
Sets the outgoing window.
The Messenger will track the remote status of this many outgoing deliveries after calling send. A Message enters this window when you call the put() method with the message. If your outgoing window size is n, and you call put n+1 times, status information will no longer be available for the first message.
Turns passive mode on or off.
When set to passive mode, Messenger will not attempt to perform I/O operations internally. In this mode it is necesssary to use the Selectable type to drive any I/O needed to perform requestioned actions.
In this mode Messenger will never block.
This property contains the password for the Messenger.private_key file, or nil if the file is not encrypted.
Path to a private key file for the Messenger.
The property must be specified for the Messenger to accept incoming SSL/TLS connections and to establish client authenticated outgoing SSL/TLS connections. Non client authenticated SSL/TLS connections do not require this property.
Places the content contained in the message onto the outgoing queue of the Messenger.
This method will never block, however it will send any unblocked Messages in the outgoing queue immediately and leave any blocked Messages remaining in the outgoing queue. The send call may then be used to block until the outgoing queue is empty. The outgoing attribute may be used to check the depth of the outgoing queue.
Receives up to limit messages into the incoming queue. If no value for limit is supplied, this call will receive as many messages as it can buffer internally. If the Messenger is in blocking mode, this call will block until at least one Message is available in the incoming queue.
Options ====
Similar to route, except that the destination of the Message is determined before the message address is rewritten.
The outgoing address is only rewritten after routing has been finalized. If a message has an outgoing address of "amqp://0.0.0.0:5678", and a rewriting rule that changes its outgoing address to "foo", it will still arrive at the peer that is listening on "amqp://0.0.0.0:5678", but when it arrives there, the receiver will see its outgoing address as "foo".
The default rewrite rule removes username and password from addresses before they are transmitted.
Adds a routing rule to the Messenger‘s internal routing table.
The route procedure may be used to influence how a Messenger will internally treat a given address or class of addresses. Every call to the route procedure will result in Messenger appending a routing rule to its internal routing table.
Whenever a Message is presented to a Messenger for delivery, it will match the address of this message against the set of routing rules in order. The first rule to match will be triggered, and instead of routing based on the address presented in the message, the Messenger will route based on the address supplied in the rule.
The pattern matching syntax supports two types of matches, a ’%’ will match any character except a ’/’, and a ’*’ will match any character including a ’/’.
A routing address is specified as a normal AMQP address, however it may additionally use substitution variables from the pattern match that triggered the rule.
# route messages sent to foo to the destionaty amqp://foo.com messenger.route("foo", "amqp://foo.com") # any message to foobar will be routed to amqp://foo.com/bar messenger.route("foobar", "amqp://foo.com/bar") # any message to bar/<path> will be routed to the same path within # the amqp://bar.com domain messenger.route("bar/*", "amqp://bar.com/$1") # route all Message objects over TLS messenger.route("amqp:*", "amqps:$1") # supply credentials for foo messenger.route("amqp://foo.com/*", "amqp://user:password@foo.com/$1") # supply credentials for all domains messenger.route("amqp://*", "amqp://user:password@$1") # route all addresses through a single proxy while preserving the # original destination messenger.route("amqp://%$/*", "amqp://user:password@proxy/$1/$2") # route any address through a single broker messenger.route("*", "amqp://user:password@broker/$1")
Gets the last known remote state of the delivery associated with the given tracker, as long as the Message is still within your outgoing window. (Also works on incoming messages that are still within your incoming queue. See TrackerStatus for details on the values returned.
Subscribes the Messenger to messages originating from the specified source. The source is an address as specified in the Messenger introduction with the following addition. If the domain portion of the address begins with the ’~’ character, the Messenger will interpret the domain as host/port, bind to it, and listen for incoming messages. For example "~0.0.0.0", "amqp://~0.0.0.0" will all bind to any local interface and listen for incoming messages. An address of "amqps://~0.0.0.0" will only permit incoming SSL connections.
A path to a database of trusted certificates for use in verifying the peer on an SSL/TLS connection. If this property is nil, then the peer will not be verified.