- java.lang.Object
-
- java.util.EventObject
-
- org.snmp4j.event.ResponseEvent<A>
-
- Type Parameters:
A
- type of the peerAddress
.
- All Implemented Interfaces:
java.io.Serializable
public class ResponseEvent<A extends Address> extends java.util.EventObject
ResponseEvent
associates a request PDU with the corresponding response and an optional user object.- Version:
- 3.1.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.Exception
error
private A
peerAddress
private PDU
request
private PDU
response
private static long
serialVersionUID
private java.lang.Object
userObject
-
Constructor Summary
Constructors Constructor Description ResponseEvent(java.lang.Object source, A peerAddress, PDU request, PDU response, java.lang.Object userObject)
Creates anResponseEvent
instance.ResponseEvent(java.lang.Object source, A peerAddress, PDU request, PDU response, java.lang.Object userObject, java.lang.Exception error)
Creates anResponseEvent
instance with an exception object indicating a message processing error.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Exception
getError()
Gets the exception object from the exception that has been generated when the request processing has failed due to an error.A
getPeerAddress()
Gets the transport address of the response sender.PDU
getRequest()
Gets the request PDU.PDU
getResponse()
Gets the response PDU.java.lang.Object
getUserObject()
Gets the user object that has been supplied to the asynchronous requestSession.send(PDU pdu, org.snmp4j.Target target, Object userHandle, ResponseListener listener)
.protected void
setPeerAddress(A peerAddress)
protected void
setRequest(PDU request)
protected void
setResponse(PDU response)
protected void
setUserObject(java.lang.Object userObject)
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
request
private PDU request
-
response
private PDU response
-
userObject
private java.lang.Object userObject
-
error
private java.lang.Exception error
-
-
Constructor Detail
-
ResponseEvent
public ResponseEvent(java.lang.Object source, A peerAddress, PDU request, PDU response, java.lang.Object userObject)
Creates anResponseEvent
instance.- Parameters:
source
- the event source.peerAddress
- the transport address of the entity that send the response.request
- the request PDU (must not benull
).response
- the response PDU ornull
if the request timed out.userObject
- an optional user object.
-
ResponseEvent
public ResponseEvent(java.lang.Object source, A peerAddress, PDU request, PDU response, java.lang.Object userObject, java.lang.Exception error)
Creates anResponseEvent
instance with an exception object indicating a message processing error.- Parameters:
source
- the event source.peerAddress
- the transport address of the entity that send the response.request
- the request PDU (must not benull
).response
- the response PDU ornull
if the request timed out.userObject
- an optional user object.error
- anException
.
-
-
Method Detail
-
getRequest
public PDU getRequest()
Gets the request PDU.- Returns:
- a
PDU
.
-
setPeerAddress
protected final void setPeerAddress(A peerAddress)
-
setRequest
protected final void setRequest(PDU request)
-
setResponse
protected final void setResponse(PDU response)
-
getResponse
public PDU getResponse()
Gets the response PDU.- Returns:
- a PDU instance if a response has been received. If the request timed out then
null
will be returned.
-
setUserObject
protected final void setUserObject(java.lang.Object userObject)
-
getUserObject
public java.lang.Object getUserObject()
Gets the user object that has been supplied to the asynchronous requestSession.send(PDU pdu, org.snmp4j.Target target, Object userHandle, ResponseListener listener)
.- Returns:
- an Object.
-
getError
public java.lang.Exception getError()
Gets the exception object from the exception that has been generated when the request processing has failed due to an error.- Returns:
- an
Exception
instance.
-
getPeerAddress
public A getPeerAddress()
Gets the transport address of the response sender.- Returns:
- the transport
Address
of the command responder that send this response, ornull
if no response has been received within the time-out interval or if an error occured (seegetError()
).
-
-