rjr 0.18.2 → 0.19.1

data/lib/rjr/node_callback.rb

@@ -0,0 +1,43 @@
+# RJR Node Callback
+#
+# Copyright (C) 2012-2014 Mohammed Morsi <mo@morsi.org>
+# Licensed under the Apache License, Version 2.0
+
+module RJR
+
+# Node callback interface, used to invoke json-rpc
+# methods against a remote node via node connection
+# previously established
+#
+# After a node sends a json-rpc request to another,
+# the either node may send additional requests to
+# each other via the connection already established
+# until it is closed on either end
+class NodeCallback
+  attr_reader :node
+  attr_reader :connection
+
+  # NodeCallback initializer
+  # @param [Hash] args the options to create the node callback with
+  # @option args [node] :node node used to send messages
+  # @option args [connection] :connection connection to be used in
+  #   channel selection
+  def initialize(args = {})
+    @node        = args[:node]
+    @connection  = args[:connection]
+  end
+
+  def notify(callback_method, *data)
+    # TODO throw error here ?
+    return unless node.persistent?
+
+    msg = Messages::Notification.new :method  => callback_method,
+                                     :args    => data,
+                                     :headers => @node.message_headers
+
+    # TODO surround w/ begin/rescue block,
+    # raise RJR::ConnectionError on socket errors
+    @node.send_msg msg.to_s, @connection
+  end
+end # class NodeCallback
+end # module RJR

data/lib/rjr/nodes/amqp.rb

@@ -20,7 +20,7 @@ RJR::Nodes::AMQP = RJR::Nodes::Missing
 else
 require 'thread'
 require 'rjr/node'
-require 'rjr/message'
+require 'rjr/messages'
 
 module RJR
 module Nodes
@@ -52,6 +52,7 @@ module Nodes
 class AMQP < RJR::Node
   RJR_NODE_TYPE = :amqp
   PERSISTENT_NODE = true
+  INDIRECT_NODE = true
 
   private
 
@@ -126,7 +127,7 @@ class AMQP < RJR::Node
 
   # Publish a message using the amqp exchange
   #
-  # Implementation of {RJR::Node#send_msg}
+  # Implementation of RJR::Node#send_msg
   def send_msg(msg, metadata, &on_publish)
     @amqp_lock.synchronize {
       #raise RJR::Errors::ConnectionError.new("client unreachable") if @disconnected
@@ -143,7 +144,7 @@ class AMQP < RJR::Node
 
   # Instruct Node to start listening for and dispatching rpc requests.
   #
-  # Implementation of {RJR::Node#listen}
+  # Implementation of RJR::Node#listen
   def listen
     @@em.schedule do
       init_node {
@@ -155,7 +156,7 @@ class AMQP < RJR::Node
 
   # Instructs node to send rpc request, and wait for and return response.
   #
-  # Implementation of {RJR::Node#invoke}
+  # Implementation of RJR::Node#invoke
   #
   # Do not invoke directly from em event loop or callback as will block the message
   # subscription used to receive responses
@@ -166,9 +167,9 @@ class AMQP < RJR::Node
   # @return [Object] the json result retrieved from destination converted to a ruby object
   # @raise [Exception] if the destination raises an exception, it will be converted to json and re-raised here 
   def invoke(routing_key, rpc_method, *args)
-    message = RequestMessage.new :method => rpc_method,
-                                 :args   => args,
-                                 :headers => @message_headers
+    message = Messages::Request.new :method => rpc_method,
+                                    :args   => args,
+                                    :headers => @message_headers
     @@em.schedule do
       init_node {
         subscribe # begin listening for result
@@ -191,7 +192,7 @@ class AMQP < RJR::Node
 
   # Instructs node to send rpc notification (immadiately returns / no response is generated)
   #
-  # Implementation of {RJR::Node#notify}
+  # Implementation of RJR::Node#notif}
   #
   # @param [String] routing_key destination queue to send request to
   # @param [String] rpc_method json-rpc method to invoke on destination
@@ -202,9 +203,9 @@ class AMQP < RJR::Node
     published_c = ConditionVariable.new
 
     invoked = false
-    message = NotificationMessage.new :method => rpc_method,
-                                      :args   => args,
-                                      :headers => @message_headers
+    message = Messages::Notification.new :method => rpc_method,
+                                         :args   => args,
+                                         :headers => @message_headers
     @@em.schedule do
       init_node {
         send_msg(message.to_s, :routing_key => routing_key, :reply_to => @queue_name){

data/lib/rjr/nodes/easy.rb

@@ -116,21 +116,21 @@ class Easy < RJR::Node
 
   # Send data using specified connection
   #
-  # Implementation of {RJR::Node#send_msg}
+  # Implementation of RJR::Node#send_msg
   def send_msg(data, connection)
   # TODO
   end
 
   # Instruct Nodes to start listening for and dispatching rpc requests
   #
-  # Implementation of {RJR::Node#listen}
+  # Implementation of RJR::Node#listen
   def listen
     @multi_node.listen
   end
 
   # Instructs node to send rpc request, and wait for and return response.
   #
-  # Implementation of {RJR::Node#invoke}
+  # Implementation of RJR::Node#invoke
   #
   # @param [String] dst destination send request to
   # @param [String] rpc_method json-rpc method to invoke on destination
@@ -145,7 +145,7 @@ class Easy < RJR::Node
 
   # Instructs node to send rpc notification (immadiately returns / no response is generated)
   #
-  # Implementation of {RJR::Node#notify}
+  # Implementation of RJR::Node#notify
   #
   # @param [String] dst destination to send notification to
   # @param [String] rpc_method json-rpc method to invoke on destination

data/lib/rjr/nodes/local.rb

@@ -6,7 +6,7 @@
 # Licensed under the Apache License, Version 2.0
 
 require 'rjr/node'
-require 'rjr/message'
+require 'rjr/messages'
 
 module RJR
 module Nodes
@@ -38,6 +38,7 @@ module Nodes
 class Local < RJR::Node
   RJR_NODE_TYPE = :local
   PERSISTENT_NODE = true
+  INDIRECT_NODE = false
 
   # allows clients to override the node type for the local node
   attr_accessor :node_type
@@ -57,17 +58,17 @@ class Local < RJR::Node
   #
   # Simply dispatch local notification.
   #
-  # Implementation of {RJR::Node#send_msg}
+  # Implementation of RJR::Node#send_msg
   def send_msg(msg, connection)
     # ignore response message
-    unless ResponseMessage.is_response_message?(msg)
+    unless Messages::Response.is_response_message?(msg)
       launch_request(msg, true) # .join?
     end
   end
 
   # Instruct Nodes to start listening for and dispatching rpc requests
   #
-  # Implementation of {RJR::Node#listen}
+  # Implementation of RJR::Node#listen
   def listen
     # do nothing
     self
@@ -87,7 +88,7 @@ class Local < RJR::Node
 
   # Instructs node to send rpc request, and wait for and return response
   #
-  # Implementation of {RJR::Node#invoke}
+  # Implementation of RJR::Node#invoke
   #
   # If strictly confirming to other nodes, this would use event machine to launch
   # a thread pool job to dispatch request and block on result.
@@ -100,9 +101,9 @@ class Local < RJR::Node
   # @raise [Exception] if the destination raises an exception, it will be converted to json and re-raised here 
   def invoke(rpc_method, *args)
     0.upto(args.size).each { |i| args[i] = args[i].to_s if args[i].is_a?(Symbol) }
-    message = RequestMessage.new(:method => rpc_method,
-                                 :args   => args,
-                                 :headers => @message_headers)
+    message = Messages::Request.new(:method => rpc_method,
+                                    :args   => args,
+                                    :headers => @message_headers)
     launch_request(message.to_s, false)
 
     # TODO optional timeout for response ?
@@ -116,7 +117,7 @@ class Local < RJR::Node
 
   # Instructs node to send rpc notification (immediately returns / no response is generated)
   #
-  # Implementation of {RJR::Node#notify}
+  # Implementation of RJR::Node#notify
   #
   # Same performance comment as invoke_request above
   #
@@ -124,9 +125,9 @@ class Local < RJR::Node
   # @param [Array] args array of arguments to convert to json and invoke remote method wtih
   def notify(rpc_method, *args)
     0.upto(args.size).each { |i| args[i] = args[i].to_s if args[i].is_a?(Symbol) }
-    message = NotificationMessage.new(:method => rpc_method,
-                                      :args   => args,
-                                      :headers => @message_headers)
+    message = Messages::Notification.new(:method => rpc_method,
+                                         :args   => args,
+                                         :headers => @message_headers)
     launch_request(message.to_s, true) #.join ?
     nil
   end

data/lib/rjr/nodes/multi.rb

@@ -70,7 +70,7 @@ class Multi < RJR::Node
 
   # Instruct Node to start listening for and dispatching rpc requests
   #
-  # Implementation of {RJR::Node#listen}
+  # Implementation of RJR::Node#listen
   def listen
     @nodes.each { |node|
       node.listen

data/lib/rjr/nodes/tcp.rb

@@ -10,7 +10,8 @@ require 'thread'
 require 'eventmachine'
 
 require 'rjr/node'
-require 'rjr/message'
+require 'rjr/messages'
+require 'rjr/util/json_parser'
 
 module RJR
 module Nodes
@@ -34,13 +35,13 @@ class TCPConnection < EventMachine::Connection
     @data      = ""
   end
 
-  # {EventMachine::Connection#receive_data} callback, handle request / response messages
+  # EventMachine::Connection#receive_data callback, handle request / response messages
   def receive_data(data)
     # a large json-rpc message may be split over multiple packets
     #   (invocations of receive_data)
     # and multiple messages may be concatinated into one packet
     @data += data
-    while extracted = MessageUtil.retrieve_json(@data)
+    while extracted = JSONParser.extract_json_from(@data)
       msg, @data = *extracted
       @rjr_node.send(:handle_message, msg, self) # XXX private method
     end
@@ -80,6 +81,7 @@ end
 class TCP < RJR::Node
   RJR_NODE_TYPE = :tcp
   PERSISTENT_NODE = true
+  INDIRECT_NODE = false
 
   attr_accessor :connections
 
@@ -123,14 +125,14 @@ class TCP < RJR::Node
 
   # Send data using specified connection
   #
-  # Implementation of {RJR::Node#send_msg}
+  # Implementation of RJR::Node#send_msg
   def send_msg(data, connection)
     connection.send_msg(data)
   end
 
   # Instruct Node to start listening for and dispatching rpc requests
   #
-  # Implementation of {RJR::Node#listen}
+  # Implementation of RJR::Node#listen
   def listen
     @@em.schedule {
       @@em.start_server @host, @port, TCPConnection, { :rjr_node => self }
@@ -140,7 +142,7 @@ class TCP < RJR::Node
 
   # Instructs node to send rpc request, and wait for / return response.
   #
-  # Implementation of {RJR::Node#invoke}
+  # Implementation of RJR::Node#invoke
   #
   # Do not invoke directly from em event loop or callback as will block the message
   # subscription used to receive responses
@@ -153,9 +155,9 @@ class TCP < RJR::Node
     uri = URI.parse(uri)
     host,port = uri.host, uri.port
 
-    message = RequestMessage.new :method => rpc_method,
-                                 :args   => args,
-                                 :headers => @message_headers
+    message = Messages::Request.new :method => rpc_method,
+                                    :args   => args,
+                                    :headers => @message_headers
     connection = nil
     @@em.schedule {
       init_client(:host => host, :port => port,
@@ -176,7 +178,7 @@ class TCP < RJR::Node
 
   # Instructs node to send rpc notification (immadiately returns / no response is generated)
   #
-  # Implementation of {RJR::Node#notify}
+  # Implementation of RJR::Node#notify
   #
   # @param [String] uri location of node to send notification to, should be
   #   in format of jsonrpc://hostname:port
@@ -192,9 +194,9 @@ class TCP < RJR::Node
 
     invoked = false
     conn    = nil
-    message = NotificationMessage.new :method => rpc_method,
-                                      :args   => args,
-                                      :headers => @message_headers
+    message = Messages::Notification.new :method => rpc_method,
+                                         :args   => args,
+                                         :headers => @message_headers
     @@em.schedule {
       init_client(:host => host, :port => port,
                   :rjr_node => self) { |c|

data/lib/rjr/nodes/template.rb

@@ -26,14 +26,14 @@ class Template < RJR::Node
 
   # Send data using specified connection
   #
-  # Implementation of {RJR::Node#send_msg}
+  # Implementation of RJR::Node#send_msg
   def send_msg(data, connection)
     # TODO
   end
 
   # Instruct Node to start listening for and dispatching rpc requests
   #
-  # Implementation of {RJR::Node#listen}
+  # Implementation of RJR::Node#listen
   def listen
     # TODO
     self
@@ -41,7 +41,7 @@ class Template < RJR::Node
 
   # Instructs node to send rpc request, and wait for / return response.
   #
-  # Implementation of {RJR::Node#invoke}
+  # Implementation of RJR::Node#invoke
   # @param [String] optional_destination if the transport requires it, param
   #   to specify the target of this request, if not remove this param
   # @param [String] rpc_method json-rpc method to invoke on destination
@@ -52,7 +52,7 @@ class Template < RJR::Node
 
   # Instructs node to send rpc notification (immadiately returns / no response is generated)
   #
-  # Implementation of {RJR::Node#notify}
+  # Implementation of RJR::Node#notify
   # @param [String] optional_destination if the transport requires it, param
   #   to specify the target of this request, if not remove this param
   # @param [String] rpc_method json-rpc method to invoke on destination

data/lib/rjr/nodes/unix.rb

@@ -13,7 +13,8 @@ require 'thread'
 require 'eventmachine'
 
 require 'rjr/node'
-require 'rjr/message'
+require 'rjr/messages'
+require 'rjr/util/json_parser'
 
 module RJR
 module Nodes
@@ -35,13 +36,13 @@ class UnixConnection < EventMachine::Connection
     @data      = ""
   end
 
-  # {EventMachine::Connection#receive_data} callback, handle request / response messages
+  # EventMachine::Connection#receive_data callback, handle request / response messages
   def receive_data(data)
     # a large json-rpc message may be split over multiple packets
     #   (invocations of receive_data)
     # and multiple messages may be concatinated into one packet
     @data += data
-    while extracted = MessageUtil.retrieve_json(@data)
+    while extracted = JSONParser.extract_json_from(@data)
       msg, @data = *extracted
       @rjr_node.send(:handle_message, msg, self) # XXX private method
     end
@@ -65,6 +66,7 @@ end
 class Unix < RJR::Node
   RJR_NODE_TYPE = :unix
   PERSISTENT_NODE = true
+  INDIRECT_NODE = false
 
   attr_accessor :connections
 
@@ -106,14 +108,14 @@ class Unix < RJR::Node
 
   # Send data using specified connection
   #
-  # Implementation of {RJR::Node#send_msg}
+  # Implementation of RJR::Node#send_msg
   def send_msg(data, connection)
     connection.send_msg(data)
   end
 
   # Instruct Node to start listening for and dispatching rpc requests
   #
-  # Implementation of {RJR::Node#listen}
+  # Implementation of RJR::Node#listen
   def listen
     @@em.schedule {
       @@em.start_unix_domain_server @socketname, nil, UnixConnection, { :rjr_node => self }
@@ -123,7 +125,7 @@ class Unix < RJR::Node
 
   # Instructs node to send rpc request, and wait for / return response.
   #
-  # Implementation of {RJR::Node#invoke}
+  # Implementation of RJR::Node#invoke
   #
   # Do not invoke directly from em event loop or callback as will block the message
   # subscription used to receive responses
@@ -133,9 +135,9 @@ class Unix < RJR::Node
   # @param [String] rpc_method json-rpc method to invoke on destination
   # @param [Array] args array of arguments to convert to json and invoke remote method wtih
   def invoke(socketname, rpc_method, *args)
-    message = RequestMessage.new :method => rpc_method,
-                                 :args   => args,
-                                 :headers => @message_headers
+    message = Messages::Request.new :method => rpc_method,
+                                    :args   => args,
+                                    :headers => @message_headers
     connection = nil
     @@em.schedule {
       init_client(:socketname => socketname,
@@ -156,7 +158,7 @@ class Unix < RJR::Node
 
   # Instructs node to send rpc notification (immadiately returns / no response is generated)
   #
-  # Implementation of {RJR::Node#notify}
+  # Implementation of RJR::Node#notify
   #
   # @param [String] socketname name of socket which
   # destination node is listening on
@@ -169,9 +171,9 @@ class Unix < RJR::Node
 
     invoked = false
     conn    = nil
-    message = NotificationMessage.new :method => rpc_method,
-                                      :args   => args,
-                                      :headers => @message_headers
+    message = Messages::Notification.new :method => rpc_method,
+                                         :args   => args,
+                                         :headers => @message_headers
     @@em.schedule {
       init_client(:socketname => socketname,
                   :rjr_node => self) { |c|