Module org.snmp4j

Package org.snmp4j.transport

Class TransportStateEvent

java.lang.Object

java.util.EventObject

org.snmp4j.transport.TransportStateEvent

All Implemented Interfaces:

Serializable

public class TransportStateEvent
extends EventObject

The TransportStateEvent describes a state change for a transport connection. Optionally, connection establishment can be cancelled.

Since:

1.7

Version:

2.4

Author:

Frank Fock

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	STATE_CLOSED
static int	STATE_CONNECTED
static int	STATE_DISCONNECTED_REMOTELY
static int	STATE_DISCONNECTED_TIMEOUT
static int	STATE_UNKNOWN

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
TransportStateEvent(AbstractTransportMapping<?> source, Address peerAddress, int newState, IOException causingException)
TransportStateEvent(AbstractTransportMapping<?> source, Address peerAddress, int newState, IOException causingException, List<byte[]> discardedMessages)

Method Summary

Modifier and Type	Method	Description
IOException	getCausingException()
List<byte[]>	getDiscardedMessages()	Gets the messages that were discarded due to a state change of the transport connection.
int	getNewState()
Address	getPeerAddress()
boolean	isCancelled()	Indicates whether this event has been canceled.
void	setCancelled(boolean cancelled)	Sets the canceled state of the transport event.
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

Field Detail

STATE_UNKNOWN

public static final int STATE_UNKNOWN

See Also:

Constant Field Values

STATE_CONNECTED

public static final int STATE_CONNECTED

See Also:

Constant Field Values

STATE_DISCONNECTED_REMOTELY

public static final int STATE_DISCONNECTED_REMOTELY

See Also:

Constant Field Values

STATE_DISCONNECTED_TIMEOUT

public static final int STATE_DISCONNECTED_TIMEOUT

See Also:

Constant Field Values

STATE_CLOSED

public static final int STATE_CLOSED

See Also:

Constant Field Values

Constructor Detail

TransportStateEvent

public TransportStateEvent(AbstractTransportMapping<?> source,
                           Address peerAddress,
                           int newState,
                           IOException causingException)

TransportStateEvent

public TransportStateEvent(AbstractTransportMapping<?> source,
                           Address peerAddress,
                           int newState,
                           IOException causingException,
                           List<byte[]> discardedMessages)

Method Detail

getCausingException

public IOException getCausingException()

getNewState

public int getNewState()

getPeerAddress

public Address getPeerAddress()

getDiscardedMessages

public List<byte[]> getDiscardedMessages()

Gets the messages that were discarded due to a state change of the transport connection.

Returns:

a (possibly empty) list of messages that were discarded or null if the event has not terminated the transport connection.

Since:

2.4.0

isCancelled

public boolean isCancelled()

Indicates whether this event has been canceled. Only STATE_CONNECTED events can be canceled.

Returns:

true if the event has been canceled.

Since:

1.8

toString

public String toString()

Overrides:

toString in class EventObject

setCancelled

public void setCancelled(boolean cancelled)

Sets the canceled state of the transport event. Only STATE_CONNECTED events can be canceled.

Parameters:

cancelled - true if the event should be canceled, i.e. a connection attempt should be rejected.

Since:

1.8