Module org.snmp4j

Package org.snmp4j.event

Class ResponseEvent<A extends Address>

java.lang.Object

java.util.EventObject

org.snmp4j.event.ResponseEvent<A>

Type Parameters:

A - type of the peer Address.

All Implemented Interfaces:

Serializable

public class ResponseEvent<A extends Address>
extends 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 Exception	error
private A	peerAddress
private PDU	request
private PDU	response
private static final long	serialVersionUID
private Object	userObject

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ResponseEvent(Object source, A peerAddress, PDU request, PDU response, Object userObject)	Creates an ResponseEvent instance.
ResponseEvent(Object source, A peerAddress, PDU request, PDU response, Object userObject, Exception error)	Creates an ResponseEvent instance with an exception object indicating a message processing error.

Method Summary

Modifier and Type	Method	Description
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.
Object	getUserObject()	Gets the user object that has been supplied to the asynchronous request Session.send(PDU pdu, org.snmp4j.Target target, Object userHandle, ResponseListener listener).
protected final void	setPeerAddress(A peerAddress)
protected final void	setRequest(PDU request)
protected final void	setResponse(PDU response)
protected final void	setUserObject(Object userObject)

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

peerAddress

private A extends Address peerAddress

request

private PDU request

response

private PDU response

userObject

private Object userObject

error

private Exception error

Constructor Details

ResponseEvent

public ResponseEvent(Object source,
 A peerAddress,
 PDU request,
 PDU response,
 Object userObject)

Creates an ResponseEvent instance.

Parameters:

source - the event source.

peerAddress - the transport address of the entity that send the response.

request - the request PDU (must not be null).

response - the response PDU or null if the request timed out.

userObject - an optional user object.

ResponseEvent

public ResponseEvent(Object source,
 A peerAddress,
 PDU request,
 PDU response,
 Object userObject,
 Exception error)

Creates an ResponseEvent 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 be null).

response - the response PDU or null if the request timed out.

userObject - an optional user object.

error - an Exception.

Method Details

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(Object userObject)

getUserObject

public Object getUserObject()

Gets the user object that has been supplied to the asynchronous request Session.send(PDU pdu, org.snmp4j.Target target, Object userHandle, ResponseListener listener).

Returns:

an Object.

getError

public 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, or null if no response has been received within the time-out interval or if an error occured (see getError()).