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



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/snmp/manager.rb', line 603

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.



582
583
584
 
# File 'lib/snmp/manager.rb', line 582

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.



675
676
677
678
 
# File 'lib/snmp/manager.rb', line 675

def exit
  @handler_thread.exit
  @transport.close
end

#join ⇒ Object

Joins the current thread to the trap handler thread.

See also Thread#join.



666
667
668
 
# File 'lib/snmp/manager.rb', line 666

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) 


636
637
638
639
 
# File 'lib/snmp/manager.rb', line 636

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) 


626
627
628
629
 
# File 'lib/snmp/manager.rb', line 626

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) 


645
646
647
648
 
# File 'lib/snmp/manager.rb', line 645

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) 


656
657
658
659
 
# File 'lib/snmp/manager.rb', line 656

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