Package org.simpleframework.transport
Enum TransportEvent
- java.lang.Object
-
- java.lang.Enum<TransportEvent>
-
- org.simpleframework.transport.TransportEvent
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<TransportEvent>
public enum TransportEvent extends java.lang.Enum<TransportEvent>
TheTransportEvent
enum represents various events that can occur with the transport. Events that are available here are typically those that refer to low level I/O operations within the server. If aTrace
has been associated with the socket connection then it will receive these events as they occur.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CERTIFICATE_CHALLENGE
This event occurs when a server challenges for an X509 certificate.CLOSE
This event occurs when the underlying connection is terminated.ERROR
This event occurs when there is an error with the transport.HANDSHAKE_BEGIN
This event occurs with HTTPS when a new SSL handshake starts.HANDSHAKE_DONE
This event occurs with HTTPS when a SSL handshake has finished.HANDSHAKE_FAILED
This event indicates that the handshake failed in some way.READ
This event represents a read operation on the underlying socket.READ_WAIT
This event occurs when there is no more data available to read.WRITE
This event represents a write operation on the underlying socket.WRITE_BLOCKING
This event occurs when a thread must wait for a write to finish.WRITE_BUFFER
This event represents a write buffer operation on the underlying socket.WRITE_WAIT
This event occurs when no more data can be sent over the socket.
-
Constructor Summary
Constructors Modifier Constructor Description private
TransportEvent()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static TransportEvent
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static TransportEvent[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
READ
public static final TransportEvent READ
This event represents a read operation on the underlying socket.
-
READ_WAIT
public static final TransportEvent READ_WAIT
This event occurs when there is no more data available to read.
-
WRITE
public static final TransportEvent WRITE
This event represents a write operation on the underlying socket.
-
WRITE_BUFFER
public static final TransportEvent WRITE_BUFFER
This event represents a write buffer operation on the underlying socket.
-
WRITE_WAIT
public static final TransportEvent WRITE_WAIT
This event occurs when no more data can be sent over the socket.
-
WRITE_BLOCKING
public static final TransportEvent WRITE_BLOCKING
This event occurs when a thread must wait for a write to finish.
-
HANDSHAKE_BEGIN
public static final TransportEvent HANDSHAKE_BEGIN
This event occurs with HTTPS when a new SSL handshake starts.
-
HANDSHAKE_DONE
public static final TransportEvent HANDSHAKE_DONE
This event occurs with HTTPS when a SSL handshake has finished.
-
CERTIFICATE_CHALLENGE
public static final TransportEvent CERTIFICATE_CHALLENGE
This event occurs when a server challenges for an X509 certificate.
-
HANDSHAKE_FAILED
public static final TransportEvent HANDSHAKE_FAILED
This event indicates that the handshake failed in some way.
-
CLOSE
public static final TransportEvent CLOSE
This event occurs when the underlying connection is terminated.
-
ERROR
public static final TransportEvent ERROR
This event occurs when there is an error with the transport.
-
-
Method Detail
-
values
public static TransportEvent[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (TransportEvent c : TransportEvent.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TransportEvent valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-