com.ibm.carma.transport
Class ConnectionEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.ibm.carma.transport.ConnectionEvent
All Implemented Interfaces:
java.io.Serializable

public class ConnectionEvent
extends java.util.EventObject

Event detailing changes in the CARMA connection state. The event surfaces when the CARMA transport changes connection state between CONNECTED and DISCONNECTED.

See Also:
Serialized Form

Field Summary
static int CONNECTED
          Connection event signal
static java.lang.String COPYRIGHT
           
static int DISCONNECTED
          Disconnect event signal
 
Constructor Summary
ConnectionEvent(com.ibm.carma.transport.internal.CARMATransportConnection source, int state)
          Constructs an exception representing a state change to the provided connection state on the given event source
 
Method Summary
 int getState()
          Returns the new connection state of the connection
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

CONNECTED

public static final int CONNECTED
Connection event signal

See Also:
Constant Field Values

DISCONNECTED

public static final int DISCONNECTED
Disconnect event signal

See Also:
Constant Field Values
Constructor Detail

ConnectionEvent

public ConnectionEvent(com.ibm.carma.transport.internal.CARMATransportConnection source,
                       int state)
Constructs an exception representing a state change to the provided connection state on the given event source

Parameters:
source - the object which issues the ConnectionEvent
state - new connection state
Method Detail

getState

public int getState()
Returns the new connection state of the connection

Returns:
The connection state.