msgpack_rpc_server 0.1.0 → 0.1.1

data/README.rdoc

@@ -8,6 +8,9 @@ Logger library seemed to be incompatible with Daemons library. Therefore logging
 
 Tests are not implemented at the moment. I created this for my own purposes and I'm running this in small-scale production use, but I'm not familiar with the internals of the MessagePack-RPC library, and there may be something that I have not taken into consideration. Feel free to send suggestions for improvement. 
 
+== Installation:
+
+    gem install msgpack_rpc_server
 
 == Contributing to msgpack_rpc_server
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/examples/client.rb

@@ -0,0 +1,8 @@
+#/bin/env ruby
+
+require 'msgpack/rpc'
+  
+sp = MessagePack::RPC::SessionPool.new
+client = sp.get_session('127.0.0.1', 9000)
+puts client.call(:ping, "ruby client calling.")
+

data/examples/haskell/compile.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+#cabal install msgpack-rpc
+ghc --make ping.hs

data/examples/haskell/ping.hs

@@ -0,0 +1,9 @@
+import Network.MessagePackRpc.Client
+
+ping :: RpcMethod (String -> IO String)
+ping = method "ping"
+
+main = do
+  conn <- connect "127.0.0.1" 9000
+  print =<< ping conn "haskell client calling."
+

data/examples/server.rb

@@ -0,0 +1,29 @@
+#!/bin/env ruby
+
+require 'msgpack_rpc_server'
+
+class Handler
+
+	def ping(arg)
+		 log "ruby handler received: #{arg}"
+		 "message from ruby handler: received '#{arg}'"
+	end
+
+	def close; nil; end
+end
+
+config = {:uid => 'nobody', 
+	  :gid => 'nobody', 
+	  :listen_ip => '127.0.0.1',   # '0.0.0.0' for listening to all incoming connections
+	  :port => 9000,
+	  :dir => '.',
+	  :app_name => 'rpc-server-template', 
+	  # see http://daemons.rubyforge.org/classes/Daemons.html
+	  :ontop => false, 
+	  :backtrace => true, 
+	  :dir_mode => :system, # write to /var/run and /var/log
+	  :log_output => true
+}
+
+MsgPackRPCServer.new(config, Handler.new).run
+

data/lib/msgpack_rpc_server.rb

@@ -4,17 +4,65 @@ require 'msgpack/rpc'
 require 'etc'
 require 'daemons'
 
-
-def log(msg); puts "#{Time.new.to_s}: #{msg}"; end
-
+# This class is a thin layer over MessagePack::RPC::Server,
+# which implements privilege dropping and daemonizing. 
+#
+# Signal handlers call a +close+ method, which the handler class must implement,
+# and in which e.g. database connections are closed.  
+#
+# Server example:
+# 
+#     require 'msgpack_rpc_server'
+#
+#     msgpack_config = {:uid => 'nobody',
+#                       :gid => 'nobody',
+#                       :listen_ip => '127.0.0.1',
+#                       :port => 12345,
+#                       :dir => '.',
+#                       :app_name => 'test_server',
+#                       :ontop => false,
+#                       :backtrace => true,
+#                       :dir_mode => :script,
+#                       :log_output => true }
+#    
+#    class Handler
+#        def ping(arg); "pong received #{arg}"; end
+#        def close; nil; end
+#    end
+#
+#    MsgPackRPCServer.new(msgpack_config, Handler.new).run
+#
+# Client example:
+#
+#     require 'msgpack/rpc'
+#
+#     c = MessagePack::RPC::Client.new('127.0.0.1', 12345)
+#     puts c.call(:ping, "hello")
+#
+# MessagePack documentation: http://msgpack.org/
+#
+# Daemons documentation: http://daemons.rubyforge.org/
 
 class MsgPackRPCServer
 
+	# Returns a new instance. The first parameter is a hash containing configuration
+	# parameters. 
+	#
+	# Refer to the example and the Daemons library documentation for the format and meanings of
+	# configuration parameters. 
+	#
+	# The other parameter is an instance of the handler class. 
+
 	def initialize(config, handler)
 		@config = config
 		@handler = handler
 	end
 
+	# Logger library seemed to be incompatible with Daemons library, which is why logging is implemented in this very simple way for now.
+
+	def log(msg); puts "#{Time.new.to_s}: #{msg}"; end
+
+	# Daemonizes this process according to the configuration parameters given to +new+.
 	def daemonize
 		Daemons.daemonize({:ontop => @config[:ontop], :backtrace => @config[:backtrace], :dir => @config[:dir], 
 				   :app_name => @config[:app_name], :dir_mode => @config[:dir_mode], 
@@ -22,6 +70,7 @@ class MsgPackRPCServer
 		log "daemonized."
 	end
 
+	# Drops privileges according to the configuration parameters given to +new+.
 	def drop_privileges
 		gid = Etc::getgrnam(@config[:gid])[:gid]
 		uid = Etc::getpwnam(@config[:uid])[:uid]
@@ -30,14 +79,23 @@ class MsgPackRPCServer
 		log "privileges dropped."
 	end
 
-	private :daemonize, :drop_privileges, :log
+	# Calls the +close+ method of the handler class. 
+	def close
+		@handler.close
+		log "handler closed."
+	end
+
+	private :daemonize, :drop_privileges, :log, :close
 
+	# Starts the server after daemonizing and privilege dropping. 
+	# Sets signal handlers for INT and TERM. 
+	
 	def run
 		daemonize
 		drop_privileges
 
-		Signal.trap('INT') { log "received INT signal; exiting."; exit }
-		Signal.trap('TERM') { log "received TERM signal; exiting."; exit }
+		Signal.trap('INT') { log "received INT signal; exiting."; close; exit }
+		Signal.trap('TERM') { log "received TERM signal; exiting."; close; exit }
 
 		svr = MessagePack::RPC::Server.new
 		svr.listen @config[:listen_ip], @config[:port], @handler

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: msgpack_rpc_server
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  segments_generated: true
-  version: 0.1.0
+  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors: 
 - opiskelijarekisteri-devel
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-04 00:00:00 +03:00
-default_executable: 
+date: 2011-11-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: msgpack-rpc
@@ -25,11 +19,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        - 5
-        segments_generated: true
         version: 0.4.5
   type: :runtime
   prerelease: false
@@ -41,11 +30,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        - 4
-        segments_generated: true
         version: 1.1.4
   type: :runtime
   prerelease: false
@@ -57,11 +41,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        segments_generated: true
         version: 1.0.0
   type: :development
   prerelease: false
@@ -73,11 +52,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 6
-        - 4
-        segments_generated: true
         version: 1.6.4
   type: :development
   prerelease: false
@@ -98,10 +72,13 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/client.rb
+- examples/haskell/compile.sh
+- examples/haskell/ping.hs
+- examples/server.rb
 - lib/msgpack_rpc_server.rb
 - test/helper.rb
 - test/test_msgpack_rpc_server.rb
-has_rdoc: true
 homepage: http://github.com/opiskelijarekisteri-devel/msgpack_rpc_server
 licenses: 
 - GPLv3
@@ -115,24 +92,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 4066221359959899943
+      hash: 2202355589262301225
       segments: 
       - 0
-      segments_generated: true
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      segments_generated: true
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: MessagePack-RPC server template.