Class: SNMP::TrapListener

Inherits:
Object
  • Object
show all
Defined in:
lib/snmp/manager.rb

Overview

SNMP Trap Listener

Listens to a socket and processes received traps and informs in a separate thread.

Example

require 'snmp'

m = SNMP::TrapListener.new(:Port => 1062, :Community => 'public') do |manager|
  manager.on_trap_default { |trap| p trap }
end
m.join

Defined Under Namespace

Classes: Config

Constant Summary collapse

NULL_HANDLER = 
Proc.new {}

Instance Attribute Summary collapse

Instance Method Summary collapse

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:

  1. handler for a specific OID

  2. handler for a specific SNMP version

  3. 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’] ).



620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/snmp/manager.rb', line 620

def initialize(options={}, &block)
  config = Config.new(options)
  @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.



599
600
601
 
# File 'lib/snmp/manager.rb', line 599

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.



692
693
694
695
 
# File 'lib/snmp/manager.rb', line 692

def exit
  @handler_thread.exit
  @transport.close
end

#join ⇒ Object

Joins the current thread to the trap handler thread.

See also Thread#join.



683
684
685
 
# File 'lib/snmp/manager.rb', line 683

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).

Raises:

  • (ArgumentError) 


653
654
655
656
 
# File 'lib/snmp/manager.rb', line 653

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.

Raises:

  • (ArgumentError) 


643
644
645
646
 
# File 'lib/snmp/manager.rb', line 643

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.

Raises:

  • (ArgumentError) 


662
663
664
665
 
# File 'lib/snmp/manager.rb', line 662

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.

Raises:

  • (ArgumentError) 


673
674
675
676
 
# File 'lib/snmp/manager.rb', line 673

def on_trap_v2c(&block)
  raise ArgumentError, "a block must be provided" unless block
  @lock.synchronize { @v2c_handler = block }
end