Package org.snmp4j.agent.agentx.event

Class PingEvent<A extends org.snmp4j.smi.Address>

java.lang.Object

java.util.EventObject

org.snmp4j.agent.agentx.event.PingEvent<A>

All Implemented Interfaces:

Serializable

public class PingEvent<A extends org.snmp4j.smi.Address>
extends EventObject

The PingEvent object describes an AgentX ping result.

Version:

3.1.0

Author:

Frank Fock

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
PingEvent(Object source, AgentXSession<A> pingedSession, Exception error)	Creates a new PingEvent from a session and a ping response.
PingEvent(Object source, AgentXSession<A> pingedSession, AgentXResponsePDU pingResponse)	Creates a new PingEvent from a session and a ping response.

Method Summary

Modifier and Type	Method	Description
Exception	getError()	Gets the exception that caused on error.
AgentXResponsePDU	getResponse()	Gets the ping response.
AgentXSession<A>	getSession()	Gets the AgentXSession.
boolean	isCloseSession()	Checks if the session is closing.
boolean	isResetSession()	Checks if the session is resetting.
void	setCloseSession(boolean closeSession)	Request closing of the session.
void	setResetSession(boolean resetSession)	Request resetting of the session.
String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Details

PingEvent

public PingEvent(Object source,
 AgentXSession<A> pingedSession,
 AgentXResponsePDU pingResponse)

Creates a new PingEvent from a session and a ping response.

Parameters:

source - the event source.

pingedSession - the pinged AgentXSession.

pingResponse - the ping response.

PingEvent

public PingEvent(Object source,
 AgentXSession<A> pingedSession,
 Exception error)

Creates a new PingEvent from a session and a ping response.

Parameters:

source - the event source.

pingedSession - the pinged AgentXSession.

error - an exception.

Method Details

getResponse

public AgentXResponsePDU getResponse()

Gets the ping response.

Returns:

a AgentXResponsePDU.

getSession

public AgentXSession<A> getSession()

Gets the AgentXSession.

Returns:

a AgentXSession.

isCloseSession

public boolean isCloseSession()

Checks if the session is closing.

Returns:

true if the session is closed or closing (see setCloseSession(boolean).

isResetSession

public boolean isResetSession()

Checks if the session is resetting.

Returns:

true if the session is resetting or resetted (see setResetSession(boolean).

getError

public Exception getError()

Gets the exception that caused on error.

Returns:

an exception.

setCloseSession

public void setCloseSession(boolean closeSession)

Request closing of the session.

Parameters:

closeSession - true to request closing the session.

setResetSession

public void setResetSession(boolean resetSession)

Request resetting of the session.

Parameters:

resetSession - true to request a reset of the session.

toString

public String toString()

Overrides:

toString in class EventObject