|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Session
Session defines a common interface for all classes that
implement SNMP protocol operations based on SNMP4J.
| Method Summary | |
|---|---|
void |
cancel(PDU request,
ResponseListener listener)
Cancels an asynchronous request. |
void |
close()
Closes the session and frees any allocated resources, i.e. sockets. |
ResponseEvent |
send(PDU pdu,
Target target)
Sends a PDU to the given target and returns the received
response PDU. |
void |
send(PDU pdu,
Target target,
java.lang.Object userHandle,
ResponseListener listener)
Asynchronously sends a PDU to the given target. |
ResponseEvent |
send(PDU pdu,
Target target,
TransportMapping transport)
Sends a PDU to the given target and returns the received
response PDU encapsulated in a ResponseEvent
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). |
void |
send(PDU pdu,
Target target,
TransportMapping transport,
java.lang.Object userHandle,
ResponseListener listener)
Asynchronously sends a PDU to the given target. |
| Method Detail |
|---|
void close()
throws java.io.IOException
Session has been closed it must
be used.
java.io.IOException - if the session could not free all resources.
ResponseEvent send(PDU pdu,
Target target)
throws java.io.IOException
PDU to the given target and returns the received
response PDU.
pdu - the PDU to send.target - the Target instance that specifies how and where to send
the PDU.
ResponseEvent
instance. To obtain the received response PDU call
ResponseEvent.getResponse(). If the request timed out,
that method will return null. If the sent pdu
is an unconfirmed PDU (notification, response, or report), then
null will be returned.
java.io.IOException - if the message could not be send.
void send(PDU pdu,
Target target,
java.lang.Object userHandle,
ResponseListener listener)
throws java.io.IOException
PDU to the given target. The response
is then returned by calling the supplied ResponseListener
instance.
pdu - the PDU instance to send.target - the Target instance representing the target SNMP engine where to send
the pdu.userHandle - an user defined handle that is returned when the request is returned
via the listener object.listener - a ResponseListener instance that is called when
pdu is a confirmed PDU and the request is either answered
or timed out.
java.io.IOException - if the message could not be send.
ResponseEvent send(PDU pdu,
Target target,
TransportMapping transport)
throws java.io.IOException
PDU to the given target and returns the received
response PDU encapsulated in a ResponseEvent
object that also includes:
Target information of the target,
PDU,
PDU (if any).
pdu - the PDU instance to send.target - the Target instance representing the target SNMP engine where to send
the pdu.transport - specifies the TransportMapping to be used when sending
the PDU. If transport is null, the associated
message dispatcher will try to determine the transport mapping by the
target's address.
ResponseEvent
instance. To obtain the received response PDU call
ResponseEvent.getResponse(). If the request timed out,
that method will return null. If the sent pdu
is an unconfirmed PDU (notification, response, or report), then
null will be returned.
java.io.IOException - if the message could not be send.
void send(PDU pdu,
Target target,
TransportMapping transport,
java.lang.Object userHandle,
ResponseListener listener)
throws java.io.IOException
PDU to the given target. The response
is then returned by calling the supplied ResponseListener
instance.
pdu - the PDU instance to send.target - the Target instance representing the target SNMP engine where to send
the pdu.transport - specifies the TransportMapping to be used when sending
the PDU. If transport is null, the associated
message dispatcher will try to determine the transport mapping by the
target's address.userHandle - an user defined handle that is returned when the request is returned
via the listener object.listener - a ResponseListener instance that is called when
pdu is a confirmed PDU and the request is either answered
or timed out.
java.io.IOException - if the message could not be send.
void cancel(PDU request,
ResponseListener listener)
ResponseEvent indicates an error.
request - a request PDU as sent via send(PDU pdu, Target target,
Object userHandle, ResponseListener listener) or any .listener - a ResponseListener instance.
|
Copyright 2003-2009 Frank Fock and Jochen Katz (SNMP4J.org) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||