snmp4em 1.0.3 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5aea9c134c9785958dbeaf94f757aa74b1ea166
+  data.tar.gz: eac0b67478cbddbd37756289194943ca297339cc
+SHA512:
+  metadata.gz: 4f6bfb1d99e40f5b28c9d0cb0ec8d7c8b5bc977d1c0df5eafdb6921531fb8fcf9d1bb4e1e5fea24cf6737130b08ff1d431a1fc5ef161d56e391c6743aa9251fb
+  data.tar.gz: 8a32202b3dbe22a36b641be5083b6d29ae5cb439bf42ac19e8d3ee6dfad734a8ca098793756a3491fc03934ace423acacccd35afdfca31f3bed83d055476f3a2

data/README.rdoc

@@ -12,6 +12,7 @@ The library currently supports:
 * SNMP v1 and v2 
 * SNMP Get, GetNext, Set, and Walk requests. For SNMPv2 clients, GetBulk and WalkBulk
 * Ability to query/set/walk multiple OIDs in parallel.
+* For Ruby 1.9 and above, fiber support to streamline asychronous code
 
 Future revisions of this library may support:
 
@@ -31,6 +32,7 @@ You may set the following options:
     :community => "public",      # Shorthand for setting both :community_ro and :community_rw
     :community_ro => "public",
     :community_rw => "public",
+    :fiber => false,
     :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
@@ -41,6 +43,13 @@ These options may also be passed to an individual query method, for instance:
   snmp = SNMP4EM::Manager.new(...)
   snmp.get(OID, :retries => 2, :timeout => 1)
 
+And when receiving traps:
+
+  SNMP4EM::NotificationManager.new(
+    :host => "127.0.0.1",        # Local interface on which to listen for traps. By default, localhost only!
+    :port => 161                 # Port on which to listen for traps.
+  )
+
 
 == Backwards compatibility
 
@@ -181,9 +190,47 @@ A simple SNMP-GET-BULK:
     end
   }
 
+Handling traps:
+
+  EM.run {
+    manager = SNMP4EM::NotificationManager.new
+
+    manager.on_trap do |trap|
+      if trap.is_a? SNMP::SNMPv1_Trap
+        puts "Got a SNMPv1_Trap"
+      elsif trap.is_a? SNMP::SNMPv2_Trap
+        puts "Got a SNMPv2_Trap"
+      end
+    end
+  }
+
+== Fiber Support
+
+If your Ruby supports it, you can pass enable fibers, either per-manager or per-request. This unwinds much of the complexity in writing event-driven code. Instead of receiving an object on which to hang callbacks, the current fiber will be suspended until the response is available. If an error occurs, it will be returned as a StandardError. Unfortunately, there is no way to raise this error, you are responsible for manually checking whether the returned object is an error or not.
+
+For example:
+
+  EM.run {
+    snmp = SNMP4EM::Manager.new(:host => "192.168.1.1")
+
+    f = Fiber.new do
+      response = snmp.get([OID_SYSNAME, OID_SYSLOCATION])
+  
+      if response.is_a? StandardError
+        puts "Uh oh!"
+      else
+        puts "System name = #{response[OID_SYSNAME]}"
+        puts "System location = #{response[OID_SYSLOCATION]}"
+      end
+    end
+  }
 
 == Change Log
 
+Version 1.1.0:
+
+* Fiber support
+
 Version 1.0.2:
 
 * Ability to specify timeouts as an array of timeout values. Inspired by https://github.com/calmh/node-snmp-native.

data/lib/snmp4em/manager.rb

@@ -62,6 +62,7 @@ module SNMP4EM
       @timeout = args[:timeout] || 1
       @retries = args[:retries] || 3
       @version = args[:version] || :SNMPv2c
+      @fiber   = args[:fiber]   || false
 
       self.extend SNMPv2cRequests if @version == :SNMPv2c
 
@@ -75,5 +76,21 @@ module SNMP4EM
       self.class.socket.send_datagram message.encode, @host, @port
     end
 
+    def wrap_in_fiber(request) # @private
+      require "fiber"
+
+      fiber = Fiber.current
+
+      request.callback do |response|
+        fiber.resume response
+      end
+
+      request.errback do |error|
+        fiber.resume StandardError.new(error)
+      end
+
+      Fiber.yield
+    end
+
   end
 end

data/lib/snmp4em/snmp_common_requests.rb

@@ -11,7 +11,8 @@ module SNMP4EM
     # *  _version_ - Override the version provided in the {SNMP4EM::Manager} constructor
  
     def get(oids, args = {})
-      SnmpGetRequest.new(self, oids, args.merge(:version => @version))
+      request = SnmpGetRequest.new(self, oids, args.merge(:version => @version))
+      if (@fiber || args[:fiber]) then wrap_in_fiber(request) else request end
     end
 
     # Sends an SNMP-GETNEXT request to the remote agent for all OIDs specified in the _oids_ array. Returns a {SnmpGetRequest} object,
@@ -24,7 +25,8 @@ module SNMP4EM
     # *  _version_ - Override the version provided in the {SNMP4EM::Manager} constructor
 
     def getnext(oids, args = {})
-      SnmpGetNextRequest.new(self, oids, args.merge(:version => @version))
+      request = SnmpGetNextRequest.new(self, oids, args.merge(:version => @version))
+      if (@fiber || args[:fiber]) then wrap_in_fiber(request) else request end
     end
 
     # Sends an SNMP-SET request to the remote agent for all OIDs specified in the _oids_ hash. The hash must map OID values to requested
@@ -37,7 +39,8 @@ module SNMP4EM
     # *  _version_ - Override the version provided in the {SNMP4EM::Manager} constructor
 
     def set(oids, args = {})
-      SnmpSetRequest.new(self, oids, args.merge(:version => @version))
+      request = SnmpSetRequest.new(self, oids, args.merge(:version => @version))
+      if (@fiber || args[:fiber]) then wrap_in_fiber(request) else request end
     end
 
     # Sends a series of SNMP-GETNEXT requests to simulate an SNMP "walk" operation. Given an OID prefix, the library will keep requesting the
@@ -53,7 +56,8 @@ module SNMP4EM
     # *  _version_ - Override the version provided in the {SNMP4EM::Manager} constructor
 
     def walk(oids, args = {})
-      SnmpWalkRequest.new(self, oids, args.merge(:version => @version))
+      request = SnmpWalkRequest.new(self, oids, args.merge(:version => @version))
+      if (@fiber || args[:fiber]) then wrap_in_fiber(request) else request end
     end
   end
 end

data/lib/snmp4em/snmp_v2c_requests.rb

@@ -19,7 +19,8 @@ module SNMP4EM
     # *  _maxrepetitions_ - Number of OID-value pairs to be returned for each OID (default is 10)
 
     def getbulk(oids, args = {})
-      SnmpGetBulkRequest.new(self, oids, args)
+      request = SnmpGetBulkRequest.new(self, oids, args)
+      if (@fiber || args[:fiber]) then wrap_in_fiber(request) else request end
     end
 
     # Uses SNMPv2 GET-BULK operations to fetch all values of one or more OID prefixes. This produces the same result as {SNMPCommonRequests#walk}, but with much
@@ -34,7 +35,8 @@ module SNMP4EM
     # *  _version_ - Override the version provided in the {SNMP4EM::Manager} constructor
 
     def bulkwalk(oids, args = {})
-      SnmpBulkWalkRequest.new(self, oids, args)
+      request = SnmpBulkWalkRequest.new(self, oids, args)
+      if (@fiber || args[:fiber]) then wrap_in_fiber(request) else request end
     end
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snmp4em
 version: !ruby/object:Gem::Version
-  version: 1.0.3
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Norman Elton
@@ -14,65 +13,57 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: snmp
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A high-performance SNMP engine built on EventMachine and Ruby-SNMP
@@ -106,7 +97,9 @@ files:
 - lib/snmp4em.rb
 - README.rdoc
 homepage: http://github.com/normelton/snmp4em
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --line-numbers
@@ -118,22 +111,20 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '1.2'
 requirements: []
 rubyforge_project: snmp4em
-rubygems_version: 1.8.25
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A high-performance SNMP engine built on EventMachine and Ruby-SNMP
 test_files: []
 has_rdoc: