tmm1-amqp 0.5.9 → 0.6.0

data/lib/mq/rpc.rb

@@ -1,5 +1,45 @@
 class MQ
+  # Basic RPC (remote procedure call) facility.
+  #
+  # Needs more detail and explanation.
+  #
+  #  EM.run do
+  #    server = MQ.rpc('hash table node', Hash)
+  #
+  #    client = MQ.rpc('hash table node')
+  #    client[:now] = Time.now
+  #    client[:one] = 1
+  #
+  #    client.values do |res|
+  #      p 'client', :values => res
+  #    end
+  #
+  #    client.keys do |res|
+  #      p 'client', :keys => res
+  #      EM.stop_event_loop
+  #    end
+  #  end
+  #
   class RPC < BlankSlate
+    # Takes a channel, queue and optional object.
+    #
+    # The optional object may be a class name, module name or object
+    # instance. When given a class or module name, the object is instantiated
+    # during this setup. The passed queue is automatically subscribed to so
+    # it passes all messages (and their arguments) to the object.
+    #
+    # Marshalling and unmarshalling the objects is handled internally. This
+    # marshalling is subject to the same restrictions as defined in the
+    # Marshal[http://ruby-doc.org/core/classes/Marshal.html] standard 
+    # library. See that documentation for further reference.
+    #
+    # When the optional object is not passed, the returned rpc reference is 
+    # used to send messages and arguments to the queue. See #method_missing 
+    # which does all of the heavy lifting with the proxy. Some client 
+    # elsewhere must call this method *with* the optional block so that 
+    # there is a valid destination. Failure to do so will just enqueue 
+    # marshalled messages that are never consumed.
+    #
     def initialize mq, queue, obj = nil
       @mq = mq
       @mq.rpcs[queue] ||= self
@@ -34,6 +74,20 @@ class MQ
       end
     end
 
+    # Calling MQ.rpc(*args) returns a proxy object without any methods beyond
+    # those in Object. All calls to the proxy are handled by #method_missing which
+    # works to marshal and unmarshal all method calls and their arguments.
+    #
+    #  EM.run do
+    #    server = MQ.rpc('hash table node', Hash)
+    #    client = MQ.rpc('hash table node')
+    #
+    #    # calls #method_missing on #[] which marshals the method name and
+    #    # arguments to publish them to the remote
+    #    client[:now] = Time.now
+    #    ....
+    #  end
+    #
     def method_missing meth, *args, &blk
       # XXX use uuids instead
       message_id = "random message id #{::Kernel.rand(999_999_999_999)}"

data/protocol/codegen.rb

@@ -12,6 +12,7 @@ s = JSON.parse(File.read(path))
 require 'erb'
 
 puts ERB.new(%q[
+  #:stopdoc:
   # this file was autogenerated on <%= Time.now.to_s %>
   # using <%= name.ljust(16) %> (mtime: <%= File.mtime(path) %>)
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tmm1-amqp
 version: !ruby/object:Gem::Version 
-  version: 0.5.9
+  version: 0.6.0
 platform: ruby
 authors: 
 - Aman Gupta
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-01 00:00:00 -07:00
+date: 2009-01-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,8 +27,8 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - README
 - examples/amqp/simple.rb
@@ -38,6 +38,8 @@ files:
 - examples/mq/pingpong.rb
 - examples/mq/primes-simple.rb
 - examples/mq/primes.rb
+- examples/mq/simple-ack.rb
+- examples/mq/simple-get.rb
 - examples/mq/simple.rb
 - examples/mq/stocks.rb
 - lib/amqp/buffer.rb
@@ -50,6 +52,7 @@ files:
 - lib/ext/em.rb
 - lib/ext/emfork.rb
 - lib/mq/exchange.rb
+- lib/mq/header.rb
 - lib/mq/logger.rb
 - lib/mq/queue.rb
 - lib/mq/rpc.rb
@@ -58,7 +61,7 @@ files:
 - protocol/codegen.rb
 - protocol/doc.txt
 - protocol/amqp-0.8.xml
-has_rdoc: false
+has_rdoc: true
 homepage: http://amqp.rubyforge.org/
 post_install_message: 
 rdoc_options: []