diff options
| author | Darryl L. Pierce <mcpierce@apache.org> | 2013-02-13 21:49:26 +0000 |
|---|---|---|
| committer | Darryl L. Pierce <mcpierce@apache.org> | 2013-02-13 21:49:26 +0000 |
| commit | 65c887a028df431d759f9f6574abe47df1251115 (patch) | |
| tree | 4016c513f6e73452ab36ba60f6154d377c8f2cf7 /qpid/cpp | |
| parent | 9ecd81538a702428d631cb3ec65076a59f16132f (diff) | |
| download | qpid-python-65c887a028df431d759f9f6574abe47df1251115.tar.gz | |
NO-JIRA: Fixes a few typos in the Ruby documentation.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1445947 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/cpp')
5 files changed, 15 insertions, 12 deletions
diff --git a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/address.rb b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/address.rb index 1966332fee..0879f0fcd1 100644 --- a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/address.rb +++ b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/address.rb @@ -60,8 +60,8 @@ module Qpid # [node] # A nested map describing properties for the addressed node. Properties # are *type* (*topic* or *queue*), *durable* (a boolean), *x-declare* - # (a nested map of amqp 0.10-specific options) and *x-bindings*. (nested - # list which specifies a queue, exchange or a binding key and arguments. + # (a nested map of amqp 0.10-specific options) and *x-bindings* (nested + # list which specifies a queue, exchange or a binding key and arguments). # # [link] # A nested map through which properties of the link can be specified; diff --git a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/message.rb b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/message.rb index fadb279fbf..e167800455 100644 --- a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/message.rb +++ b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/message.rb @@ -89,7 +89,7 @@ module Qpid # Sets the content type for the +Message+. # - # This should be set by the sending applicaton and indicates to the + # This should be set by the sending application and indicates to the # recipients of the message how to interpret or decode the content. # # By default, only dictionaries and maps are automatically given a content @@ -154,10 +154,10 @@ module Qpid # Sets the correlation id of the +Message+. # # The correlation id can be used as part of a protocol for message - # exchange patterns; e.g., a requestion-response pattern might require + # exchange patterns; e.g., a request-response pattern might require # the correlation id of the request and the response to match, or it # might use the message id of the request as the correlation id on - # the response + # the response. # # *NOTE:* If the id is not a +String+ then the id is setup using # the object's string representation. @@ -191,6 +191,9 @@ module Qpid # Sets the time-to-live in milliseconds. # + # This can be used by the messaging infrastructure to discard messages + # that are no longer of relevance. + # # ==== Options # # * +duration+ - the number of milliseconds @@ -210,7 +213,7 @@ module Qpid # # This is a hint to the messaging infrastructure that the message # should be persisted or otherwise stored. This helps to ensure - # that th emessage is not lost during to failures or a shutdown. + # that the message is not lost due to failures or a shutdown. # # ==== Options # diff --git a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/receiver.rb b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/receiver.rb index 37dd45a6bd..05ee925212 100644 --- a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/receiver.rb +++ b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/receiver.rb @@ -35,7 +35,7 @@ module Qpid # session = conn.create_session # # # create a receiver that listens on the "updates" topic of "alerts" - # receiver = session.create_receiver "alerts/updates"t + # receiver = session.create_receiver "alerts/updates" # # # wait for an incoming message and process it # incoming = receiver.get Qpid::Messaging::Duration::FOREVER diff --git a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/sender.rb b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/sender.rb index d5dbb51926..4ce1393dc7 100644 --- a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/sender.rb +++ b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/sender.rb @@ -21,7 +21,7 @@ module Qpid module Messaging - # +Sender+ is the entity through which messages sent. + # +Sender+ is the entity through which messages are sent. # # An instance of +Sender+ can only be created using an active (not previously # closed) Session. See Qpid::Messaging::Session.create_sender for more details. diff --git a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/session.rb b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/session.rb index 7099f79258..7e6e11f654 100644 --- a/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/session.rb +++ b/qpid/cpp/bindings/qpid/ruby/lib/qpid_messaging/session.rb @@ -129,7 +129,7 @@ module Qpid # ==== Options # # * :message - if specified, then only that Message is acknowledged - # * :sync - if true, the call will block until processed by the server + # * :sync - if true, the call will block until processed by the broker # # ==== Examples # @@ -168,7 +168,7 @@ module Qpid # NOTE: A message connot be released once it has been acknowled. def release(message); @session_impl.release message.message_impl; end - # Requests synchronization with the server. + # Requests synchronization with the broker. # # ==== Arguments # @@ -176,7 +176,7 @@ module Qpid # # ==== Options # - # * +:block+ - if true, the call blocks until the server acknowledges it + # * +:block+ - if true, the call blocks until the broker acknowledges it # #-- # TODO: Add an optional block to be used for blocking calls. @@ -192,7 +192,7 @@ module Qpid # Returns the number of messages that have been acknowledged by this # +Session+ whose acknowledgements have not been confirmed as processed - # by the server. + # by the broker. def unsettled_acks; @session_impl.getUnsettledAcks; end # Fetches the next Receiver with a message pending. Waits the specified |
