snmp4em 1.0.1 → 1.0.2

data/README.rdoc

@@ -7,7 +7,7 @@ This gem extends Ruby-SNMP[http://snmplib.rubyforge.org] to use the asynchronous
 
 == Features
 
-Version 1.0.0 supports:
+The library currently supports:
 
 * SNMP v1 and v2 
 * SNMP Get, GetNext, Set, and Walk requests. For SNMPv2 clients, GetBulk and WalkBulk
@@ -17,7 +17,29 @@ Future revisions of this library may support:
 
 * Ability to act as an SNMP agent, responding to external queries.
 
-There are no plans to support SNMP v3.
+There are no plans to support SNMP v3 or the parsing of MIB files.
+
+
+== Options
+
+You may set the following options:
+
+  SNMP4EM::Manager.new(
+    :version => :SNMPv2c,
+    :host => "127.0.0.1",
+    :port => 161,
+    :community => "public",      # Shorthand for setting both :community_ro and :community_rw
+    :community_ro => "public",
+    :community_rw => "public",
+    :timeout => 1,
+    :retries => 3                # Can also be specified as an array of individual timeouts
+                                 # For instance, [0.5, 1, 2.5] would send three requests with increasing timeout values
+  )
+
+These options may also be passed to an individual query method, for instance:
+
+  snmp = SNMP4EM::Manager.new(...)
+  snmp.get(OID, :retries => 2, :timeout => 1)
 
 
 == Backwards compatibility
@@ -162,6 +184,10 @@ A simple SNMP-GET-BULK:
 
 == Change Log
 
+Version 1.0.2:
+
+* Ability to specify timeouts as an array of timeout values. Inspired by https://github.com/calmh/node-snmp-native.
+
 Version 1.0.1:
 
 * Requests resulting in an error now return nil unless return_raw is enabled

data/lib/snmp4em/manager.rb

@@ -71,7 +71,7 @@ module SNMP4EM
       self.class.init_socket
     end
     
-    def send(message) # @private
+    def send_msg(message) # @private
       self.class.socket.send_datagram message.encode, @host, @port
     end
 

data/lib/snmp4em/requests/snmp_bulkwalk_request.rb

@@ -64,12 +64,12 @@ module SNMP4EM
         return
       end
 
-      send
+      send_msg
     end
 
     private
     
-    def send
+    def send_msg
       Manager.track_request(self)
 
       vb_list = SNMP::VarBindList.new(pending_oids.collect{|oid| oid[:next_oid]})

data/lib/snmp4em/requests/snmp_get_request.rb

@@ -42,12 +42,12 @@ module SNMP4EM
         return
       end
     
-      send
+      send_msg
     end
 
     private
 
-    def send
+    def send_msg
       Manager.track_request(self)
 
       query_oids = @oids.select{|oid| oid[:state] == :pending}.collect{|oid| oid[:requested_oid]}

data/lib/snmp4em/requests/snmp_getbulk_request.rb

@@ -67,12 +67,12 @@ module SNMP4EM
         return
       end
 
-      send
+      send_msg
     end
 
     private
 
-    def send
+    def send_msg
       Manager.track_request(self)
 
       vb_list = SNMP::VarBindList.new(pending_oids.collect{|oid| oid[:requested_oid]})

data/lib/snmp4em/requests/snmp_getnext_request.rb

@@ -49,12 +49,12 @@ module SNMP4EM
         return
       end
     
-      send
+      send_msg
     end
 
     private
     
-    def send
+    def send_msg
       Manager.track_request(self)
 
       query_oids = @oids.select{|oid| oid[:state] == :pending}.collect{|oid| oid[:requested_oid]}

data/lib/snmp4em/requests/snmp_set_request.rb

@@ -47,12 +47,12 @@ module SNMP4EM
         return
       end
     
-      send
+      send_msg
     end
 
     private
     
-    def send
+    def send_msg
       Manager.track_request(self)
 
       pending_varbinds = pending_oids.collect{|oid| SNMP::VarBind.new(oid[:requested_oid], oid[:value])}

data/lib/snmp4em/requests/snmp_walk_request.rb

@@ -60,12 +60,12 @@ module SNMP4EM
         return
       end
 
-      send
+      send_msg
     end
 
     private
     
-    def send
+    def send_msg
       Manager.track_request(self)
 
       vb_list = SNMP::VarBindList.new(pending_oids.collect{|oid| oid[:next_oid]})

data/lib/snmp4em/snmp_request.rb

@@ -9,15 +9,21 @@ module SNMP4EM
       
       @oids ||= [*oids].collect { |oid_str| { :requested_string => oid_str, :requested_oid => SNMP::ObjectId.new(oid_str), :state => :pending }}
 
-      @timeout_timer = nil
-      @timeout_retries = args[:retries] || @sender.retries
+      retries = args[:retries] || @sender.retries
+      timeout = args[:timeout] || @sender.timeout
+
+      if retries.is_a?(Array)
+        @timeouts = retries.clone
+      else
+        @timeouts = (retries + 1).times.collect { timeout }
+      end
       
       @return_raw = args[:return_raw] || false
       @max_results = args[:max_results] || nil
       
       init_callbacks
       on_init(args) if respond_to?(:on_init)
-      send
+      send_msg
     end
 
     def pending_oids  # @private
@@ -55,17 +61,16 @@ module SNMP4EM
       end
     end
 
-    def send(msg)  # @private
-      @sender.send msg
+    def send_msg(msg)  # @private
+      @sender.send_msg msg
 
       @timeout_timer.cancel if @timeout_timer.is_a?(EM::Timer)
 
-      @timeout_timer = EM::Timer.new(@sender.timeout) do
-        if @timeout_retries > 0
-          send
-          @timeout_retries -= 1
-        else
+      @timeout_timer = EM::Timer.new(@timeouts.shift) do
+        if @timeouts.empty?
           fail "exhausted all timeout retries"
+        else
+          send_msg
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snmp4em
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors: