Package org.snmp4j
Interface Session
- All Known Implementing Classes:
Snmp
public interface Session
Session
defines a common interface for all classes that
implement SNMP protocol operations based on SNMP4J.- Version:
- 1.2
- Author:
- Frank Fock
-
Method Summary
Modifier and TypeMethodDescriptionvoid
cancel
(PDU request, ResponseListener listener) Cancels an asynchronous request.void
close()
Closes the session and frees any allocated resources, i.e.Sends aPDU
to the given target and returns the received responsePDU
.void
send
(PDU pdu, Target target, Object userHandle, ResponseListener listener) Asynchronously sends aPDU
to the given target.send
(PDU pdu, Target target, TransportMapping transport) Sends aPDU
to the given target and returns the received responsePDU
encapsulated in aResponseEvent
object that also includes: the transport address of the response sending peer, theTarget
information of the target, the requestPDU
, the responsePDU
(if any).void
send
(PDU pdu, Target target, TransportMapping transport, Object userHandle, ResponseListener listener) Asynchronously sends aPDU
to the given target.
-
Method Details
-
close
Closes the session and frees any allocated resources, i.e. sockets. After aSession
has been closed it must be used.- Throws:
IOException
- if the session could not free all resources.
-
send
Sends aPDU
to the given target and returns the received responsePDU
.- Parameters:
pdu
- thePDU
to send.target
- theTarget
instance that specifies how and where to send the PDU.- Returns:
- the received response encapsulated in a
ResponseEvent
instance. To obtain the received responsePDU
callResponseEvent.getResponse()
. If the request timed out, that method will returnnull
. If the sentpdu
is an unconfirmed PDU (notification, response, or report), thennull
will be returned. - Throws:
IOException
- if the message could not be send.
-
send
Asynchronously sends aPDU
to the given target. The response is then returned by calling the suppliedResponseListener
instance.- Parameters:
pdu
- the PDU instance to send.target
- the Target instance representing the target SNMP engine where to send thepdu
.userHandle
- an user defined handle that is returned when the request is returned via thelistener
object.listener
- aResponseListener
instance that is called whenpdu
is a confirmed PDU and the request is either answered or timed out.- Throws:
IOException
- if the message could not be send.
-
send
Sends aPDU
to the given target and returns the received responsePDU
encapsulated in aResponseEvent
object that also includes:- the transport address of the response sending peer,
- the
Target
information of the target, - the request
PDU
, - the response
PDU
(if any).
- Parameters:
pdu
- the PDU instance to send.target
- the Target instance representing the target SNMP engine where to send thepdu
.transport
- specifies theTransportMapping
to be used when sending the PDU. Iftransport
isnull
, the associated message dispatcher will try to determine the transport mapping by thetarget
's address.- Returns:
- the received response encapsulated in a
ResponseEvent
instance. To obtain the received responsePDU
callResponseEvent.getResponse()
. If the request timed out, that method will returnnull
. If the sentpdu
is an unconfirmed PDU (notification, response, or report), thennull
will be returned. - Throws:
IOException
- if the message could not be send.
-
send
void send(PDU pdu, Target target, TransportMapping transport, Object userHandle, ResponseListener listener) throws IOException Asynchronously sends aPDU
to the given target. The response is then returned by calling the suppliedResponseListener
instance.- Parameters:
pdu
- the PDU instance to send.target
- the Target instance representing the target SNMP engine where to send thepdu
.transport
- specifies theTransportMapping
to be used when sending the PDU. Iftransport
isnull
, the associated message dispatcher will try to determine the transport mapping by thetarget
's address.userHandle
- an user defined handle that is returned when the request is returned via thelistener
object.listener
- aResponseListener
instance that is called whenpdu
is a confirmed PDU and the request is either answered or timed out.- Throws:
IOException
- if the message could not be send.
-
cancel
Cancels an asynchronous request. Any asynchronous request must be canceled when the supplied response listener is being called, even if theResponseEvent
indicates an error.- Parameters:
request
- a request PDU as sent viasend(PDU pdu, Target target, Object userHandle, ResponseListener listener)
or any .listener
- a ResponseListener instance.
-