Class: NETSNMP::Session

Inherits:
Object
  • Object
show all
Defined in:
lib/netsnmp/session.rb

Overview

Let’s just remind that there is no session in snmp, this is just an abstraction.

Direct Known Subclasses

V3Session

Defined Under Namespace

Classes: Transport

Constant Summary collapse

TIMEOUT = 
2

Instance Method Summary collapse

Constructor Details

#initialize(version: 1, community: "public", **options) ⇒ Session

Returns a new instance of Session.

Parameters:

  • opts (Hash) —

    the options set



10
11
12
13
14
 
# File 'lib/netsnmp/session.rb', line 10

def initialize(version: 1, community: "public", **options)
  @version   = version
  @community = community
  validate(options)
end

Instance Method Details

#build_pdu(type, *vars) ⇒ NETSNMP::PDU

Returns a pdu.

Parameters:

  • type (Symbol) —

    the type of PDU (:get, :set, :getnext)

  • vars (Array<Hashes>) —

    collection of options to generate varbinds (see NETSMP::Varbind.new for all the possible options)

Returns:



28
29
30
 
# File 'lib/netsnmp/session.rb', line 28

def build_pdu(type, *vars)
  PDU.build(type, headers: [@version, @community], varbinds: vars)
end

#close ⇒ Object

Closes the session



17
18
19
20
21
 
# File 'lib/netsnmp/session.rb', line 17

def close
  # if the transport came as an argument,
  # then let the outer realm care for its lifecycle
  @transport.close unless @proxy
end

#send(pdu) ⇒ NETSNMP::PDU

send a pdu, receives a pdu

Parameters:

Returns:



38
39
40
41
42
 
# File 'lib/netsnmp/session.rb', line 38

def send(pdu)
  encoded_request = encode(pdu)
  encoded_response = @transport.send(encoded_request)
  decode(encoded_response)
end