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

Constant Summary collapse

DefaultConfig = 
{
:Port => 162,
:Community => 'public',
:ServerTransport => UDPServerTransport,
:MaxReceiveBytes => 8000}
NULL_HANDLER = 
Proc.new {}

Instance Method Summary collapse

Constructor Details

#initialize(config = {}, &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



550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/snmp/manager.rb', line 550

def initialize(config={}, &block)
    @config = DefaultConfig.dup.update(config)
    @transport = @config[:ServerTransport].new(@config[:Port])
    @max_bytes = @config[:MaxReceiveBytes]
    @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 Method Details

#exit ⇒ Object Also known as: kill, terminate

Stops the trap handler thread and releases the socket.

See also Thread#exit.



615
616
617
618
 
# File 'lib/snmp/manager.rb', line 615

def exit
    @handler_thread.exit
    @transport.close
end

#join ⇒ Object

Joins the current thread to the trap handler thread.

See also Thread#join.



606
607
608
 
# File 'lib/snmp/manager.rb', line 606

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) 


578
579
580
581
 
# File 'lib/snmp/manager.rb', line 578

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) 


568
569
570
571
 
# File 'lib/snmp/manager.rb', line 568

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) 


587
588
589
590
 
# File 'lib/snmp/manager.rb', line 587

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.

Raises:

  • (ArgumentError) 


596
597
598
599
 
# File 'lib/snmp/manager.rb', line 596

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