PROTON-781: Added MessagingHandler to the Ruby reactive APIs.
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/271b3a00 Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/271b3a00 Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/271b3a00 Branch: refs/heads/PROTON-781-ruby-reactor-apis Commit: 271b3a006927537545d899615150671b026e4c86 Parents: 9eaa62a Author: Darryl L. Pierce <mcpie...@gmail.com> Authored: Wed Feb 25 13:32:09 2015 -0500 Committer: Darryl L. Pierce <mcpie...@gmail.com> Committed: Mon Jun 8 13:57:51 2015 -0400 ---------------------------------------------------------------------- .../ruby/lib/handler/messaging_handler.rb | 218 +++++++++++++++++++ proton-c/bindings/ruby/lib/qpid_proton.rb | 1 + 2 files changed, 219 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/271b3a00/proton-c/bindings/ruby/lib/handler/messaging_handler.rb ---------------------------------------------------------------------- diff --git a/proton-c/bindings/ruby/lib/handler/messaging_handler.rb b/proton-c/bindings/ruby/lib/handler/messaging_handler.rb new file mode 100644 index 0000000..b4a0bcf --- /dev/null +++ b/proton-c/bindings/ruby/lib/handler/messaging_handler.rb @@ -0,0 +1,218 @@ +#-- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +#++ + +module Qpid::Proton::Handler + + # A general purpose handler that simplifies processing events. + # + # @example + # + class MessagingHandler < Qpid::Proton::BaseHandler + + attr_reader :handlers + + # Creates a new instance. + # + # @param [Fixnum] prefetch + # @param [Boolean] auto_accept + # @param [Boolean] auto_settle + # @param [Boolean] peer_close_is_error + # + def initialize(prefetch = 10, auto_accept = true, auto_settle = true, peer_close_is_error = false) + @handlers = Array.new + @handlers << CFlowController.new(prefetch) unless prefetch.zero? + @handlers << EndpointStateHandler.new(peer_close_is_error, self) + @handlers << IncomingMessageHandler.new(auto_accept, self) + @handlers << OutgoingMessageHandler.new(auto_settle,self) + end + + # Called when the peer closes the connection with an error condition. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_connection_error(event) + EndpointStateHandler.print_error(event.connection, "connection") + end + + # Called when the peer closes the session with an error condition. + # + # @param event [Qpid:Proton::Event::Event] The event. + # + def on_session_error(event) + EndpointStateHandler.print_error(event.session, "session") + event.connection.close + end + + # Called when the peer closes the link with an error condition. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_link_error(event) + EndpointStateHandler.print_error(event.link, "link") + event.connection.close + end + + # Called when the event loop starts. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_reactor_init(event) + self.on_start(event) + end + + # Called when the event loop starts. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_start(event) + end + + # Called when the connection is closed. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_connection_closed(event) + end + + # Called when the session is closed. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_session_closed(event) + end + + # Called when the link is closed. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_link_closed(event) + end + + # Called when the peer initiates the closing of the connection. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_connection_closing(event) + end + + # Called when the peer initiates the closing of the session. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_session_closing(event) + end + + # Called when the peer initiates the closing of the link. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_link_closing(event) + end + + # Called when the socket is disconnected. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_disconnected(event) + end + + # Called when the sender link has credit and messages can therefore + # be transferred. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_sendable(event) + end + + # Called when the remote peer accepts an outgoing message. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_accepted(event) + end + + # Called when the remote peer rejects an outgoing message. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_rejected(event) + end + + # Called when the remote peer releases an outgoing message. + # + # Note that this may be in response to either the RELEASE or + # MODIFIED state as defined by the AMPQ specification. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_released(event) + end + + # Called when the remote peer has settled hte outgoing message. + # + # This is the point at which it should never be retransmitted. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_settled(event) + end + + # Called when a message is received. + # + # The message itself can be obtained as a property on the event. For + # the purpose of referring to this message in further actions, such as + # explicitly accepting it) the delivery should be used. This is also + # obtainable vi a property on the event. + # + # This method needs to be overridden. + # + # @param event [Qpid::Proton::Event::Event] The event. + # + def on_message(event) + end + + end + +end http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/271b3a00/proton-c/bindings/ruby/lib/qpid_proton.rb ---------------------------------------------------------------------- diff --git a/proton-c/bindings/ruby/lib/qpid_proton.rb b/proton-c/bindings/ruby/lib/qpid_proton.rb index 5c2e1bc..a60a028 100644 --- a/proton-c/bindings/ruby/lib/qpid_proton.rb +++ b/proton-c/bindings/ruby/lib/qpid_proton.rb @@ -90,6 +90,7 @@ require "handler/endpoint_state_handler" require "handler/incoming_message_handler" require "handler/outgoing_message_handler" require "handler/c_flow_controller" +require "handler/messaging_handler" module Qpid::Proton # @private --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
