reminder-client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6b36225cc57fa35c8e9dd456c6c489bc8e03ecf
-  data.tar.gz: 82c8267b349cfe3f15521bc0b42819b764a40836
+  metadata.gz: 5e4b20dadedd3af348a6f852daa7d2259dcf7b16
+  data.tar.gz: e6d69823fb71b2f49a59c03c941cfad7935376ad
 SHA512:
-  metadata.gz: 5e67bc877e9de398c3b53bc6f6d6de4d0f0c025f20a5228075644ffb00d4d49eafe1a3eaf2c19e1a275c422773ce221e505d89a8994c945c0488208acd24545d
-  data.tar.gz: 860550792871e6991ecfa43d29caeeb4438982e9577a21967774a31b80a8529207ce13bbdc2d4814c9bc6b48592d5517e5520865e332a2cf9bc877fa1109aff4
+  metadata.gz: a5716c61a67bd93fe1a5055f074491d04a0cc5c3a6066f850eb92544e4836f44d07793e78d5c5a0c3f2de0b8bfcad5adce4f597a1b863cc838521152393d3457
+  data.tar.gz: 3d0be3d23fb5c46d64bb6bbf1b1c78542e7cb02efe89d68bd7923dad9072cba6ed442896012f2662b7f5f53d09395365e682f54d8f9302447281a69df5d2bad4

data/lib/reminder-client/configcenter.rb

@@ -4,6 +4,18 @@ require 'zookeeper'
 require 'eventmachine'
 require 'zk'
 
+# Public: Create a Zk instence and connect, the following 
+# relaying on it, it will block until connected successfully.
+#
+# options  - The import hash include zk_address
+# 
+# Examples
+#
+#   Zoo.new({ :zk_address => "192.168.1.172:2181" })
+#   Zoo.new({ zk_address: "192.168.1.172:2181" })
+#   # => nil
+#
+# Returns a Zoo instance.
 class Zoo
   def initialize(options)
     p "start connect to #{options[:zk_address]}"
@@ -22,8 +34,20 @@ class Zoo
     puts "init succ #{@zk}"
   end
   
-  # server found server part 
-  # option temporarily has one param ip_port .eg "192.168.3.1:2222"
+  
+  # Public: zk server found server part, and it will create a ephemeral path 
+  # with current server's service ip, address, or so on.
+  #
+  # option  - The hash :ip_port -> service address .eg "192.168.3.1:2222".
+  # child(option) - The sub-path name.
+  #
+  # Examples
+  #
+  #   server_found_server({ server_found_base_path = "/stat-server" })
+  #   server_found_server({ server_found_base_path = "/stat-server" }, "child")
+  #   # => nil
+  #
+  # Returns nil.
   def server_found_server(option, child = 'default')
     #fork do
     # @zk.reopen()
@@ -32,7 +56,20 @@ class Zoo
     #end
   end
   
-  # server found client part
+
+  # Public: server found client part.
+  #
+  # server_path  - The String (zk's path) to be watched.
+  # block - The callback to be call when the server_path to be watched changed.
+  #
+  # Examples
+  #
+  #   server_found_client('/stat-service'){ | iplist, load_balance | 
+  #     puts iplist
+  #     puts load_balance
+  #   }
+  #   # => nil
+  #
   def server_found_client(server_path, &block)
     puts "zk server_found start watching on #{server_path}"
     relist = @zk.children(server_path, :watch => true)
@@ -57,6 +94,18 @@ class Zoo
     end
   end
   
+  # Private: Internal function, get each sub path's data.
+  #
+  # server_path  - The String to be duplicated.
+  # relist - The Integer number of times to duplicate the text.
+  #
+  # Examples
+  #
+  #   get_ip_from_server('/server-stat', ['default0000001', 'default0000002'
+  #   , 'default0000003'])
+  #   # => ['192.168.2.220:2222', '192.168.2.220:3333', '192.168.2.222:4444']
+  #
+  # Returns the ip list.
   def get_ip_from_server(server_path, relist)
     list = []
     relist.each { |child|
@@ -69,7 +118,22 @@ class Zoo
     list.uniq
   end
 
-  def server_config_client(config_path, service, group, &block)
+  # Public: The serverConfig client part
+  #
+  # config_path  - The config_path of zk tobe watched.
+  # group - The group of the service
+  # block - The callback to be call when the config_path to be watched changed.
+  #
+  #
+  # Examples
+  #
+  #   server_config_client('/config/server-stat', 'stat-service', 1){ |configdata|
+  #     puts configdata
+  #   }
+  #   # => nil
+  #
+  # Returns nil.
+  def server_config_client(config_path, group, &block)
     puts "zk server_config start watching on #{config_path}"
     
     # get server config for the first time

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reminder-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - caorong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zk
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A zookeeper client wrapper provide serverfound and serverconfig.