Class: SNMP::TrapListener
- Inherits:
-
Object
- Object
- SNMP::TrapListener
- Defined in:
- lib/snmp/manager.rb
Overview
Defined Under Namespace
Classes: Config
Constant Summary collapse
- NULL_HANDLER =
Proc.new {}
Instance Attribute Summary collapse
-
#config ⇒ Object
readonly
Retrieves the current configuration of this TrapListener.
Instance Method Summary collapse
-
#exit ⇒ Object
(also: #kill, #terminate)
Stops the trap handler thread and releases the socket.
-
#initialize(options = {}, &block) ⇒ TrapListener
constructor
Start a trap handler thread.
-
#join ⇒ Object
Joins the current thread to the trap handler thread.
-
#on_trap(object_id, &block) ⇒ Object
Define a trap handler block for a specific trap ObjectId.
-
#on_trap_default(&block) ⇒ Object
Define the default trap handler.
-
#on_trap_v1(&block) ⇒ Object
Define a trap handler block for all SNMPv1 traps.
-
#on_trap_v2c(&block) ⇒ Object
Define a trap handler block for all SNMPv2c traps.
Constructor Details
#initialize(options = {}, &block) ⇒ TrapListener
Start a trap handler thread. If a block is provided then the block is executed before trap handling begins. This block is typically used to define the trap handler blocks.
The trap handler blocks execute in the context of the trap handler thread.
The most specific trap handler is executed when a trap arrives. Only one handler is executed. The handlers are checked in the following order:
-
handler for a specific OID
-
handler for a specific SNMP version
-
default handler
The default for the :community option is ‘nil’ allows traps with any community to be accepted. To only accept traps from a specific community, the community may also be set to a string (e.g. ‘public’) or a list of strings (e.g. [‘public’, ‘my_private_community’] ).
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 |
# File 'lib/snmp/manager.rb', line 616 def initialize(={}, &block) config = Config.new() @transport = config.create_transport @community = config.community @max_bytes = config.max_recv_bytes @mib = MIB.new load_modules(config.mib_modules, config.mib_dir) @config = config.applied_config @handler_init = block @oid_handler = {} @v1_handler = nil @v2c_handler = nil @default_handler = nil @lock = Mutex.new @handler_thread = Thread.new(self) { |m| process_traps(m) } end |
Instance Attribute Details
#config ⇒ Object (readonly)
Retrieves the current configuration of this TrapListener.
595 596 597 |
# File 'lib/snmp/manager.rb', line 595 def config @config end |
Instance Method Details
#exit ⇒ Object Also known as: kill, terminate
Stops the trap handler thread and releases the socket.
See also Thread#exit.
688 689 690 691 |
# File 'lib/snmp/manager.rb', line 688 def exit @handler_thread.exit @transport.close end |
#join ⇒ Object
Joins the current thread to the trap handler thread.
See also Thread#join.
679 680 681 |
# File 'lib/snmp/manager.rb', line 679 def join @handler_thread.join end |
#on_trap(object_id, &block) ⇒ Object
Define a trap handler block for a specific trap ObjectId. This handler only applies to SNMPv2 traps. Note that symbolic OIDs are not supported by this method (like in the SNMP.Manager class).
649 650 651 652 |
# File 'lib/snmp/manager.rb', line 649 def on_trap(object_id, &block) raise ArgumentError, "a block must be provided" unless block @lock.synchronize { @oid_handler[ObjectId.new(object_id)] = block } end |
#on_trap_default(&block) ⇒ Object
Define the default trap handler. The default trap handler block is executed only if no other block is applicable. This handler should expect to receive both SNMPv1_Trap and SNMPv2_Trap objects.
639 640 641 642 |
# File 'lib/snmp/manager.rb', line 639 def on_trap_default(&block) raise ArgumentError, "a block must be provided" unless block @lock.synchronize { @default_handler = block } end |
#on_trap_v1(&block) ⇒ Object
Define a trap handler block for all SNMPv1 traps. The trap yielded to the block will always be an SNMPv1_Trap.
658 659 660 661 |
# File 'lib/snmp/manager.rb', line 658 def on_trap_v1(&block) raise ArgumentError, "a block must be provided" unless block @lock.synchronize { @v1_handler = block } end |
#on_trap_v2c(&block) ⇒ Object
Define a trap handler block for all SNMPv2c traps. The trap yielded to the block will always be an SNMPv2_Trap. Note that InformRequest is a subclass of SNMPv2_Trap, so inform PDUs are also received by this handler.
669 670 671 672 |
# File 'lib/snmp/manager.rb', line 669 def on_trap_v2c(&block) raise ArgumentError, "a block must be provided" unless block @lock.synchronize { @v2c_handler = block } end |