Top Description Fields Constructors Methods
org.apache.tomcat.util.net

public final Enum SocketEvent

extends Enum<SocketEvent>
Class Inheritance
Defines events that occur per socket that require further processing by the container. Usually these events are triggered by the socket implementation but they may be triggered by the container.

Field Summary

Modifier and TypeField and Description
public static final SocketEvent
CONNECT_FAIL

A client attempted to establish a connection but failed.

public static final SocketEvent
DISCONNECT

The client has disconnected.

public static final SocketEvent
ERROR

An error has occurred on a non-container thread and processing needs to return to the container for any necessary clean-up.

public static final SocketEvent
OPEN_READ

Data is available to be read.

public static final SocketEvent
OPEN_WRITE

The socket is ready to be written to.

public static final SocketEvent
STOP

The associated Connector/Endpoint is stopping and the connection/socket needs to be closed cleanly.

public static final SocketEvent
TIMEOUT

A timeout has occurred and the connection needs to be closed cleanly.

Constructor Summary

AccessConstructor and Description
private
SocketEvent()

Method Summary

Modifier and TypeMethod and Description
public static SocketEvent
valueOf(String name)

public static SocketEvent[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CONNECT_FAILback to summary
public static final SocketEvent CONNECT_FAIL

A client attempted to establish a connection but failed. Examples of where this is used include:

  • TLS handshake failures
DISCONNECTback to summary
public static final SocketEvent DISCONNECT

The client has disconnected.

ERRORback to summary
public static final SocketEvent ERROR

An error has occurred on a non-container thread and processing needs to return to the container for any necessary clean-up. Examples of where this is used include:

  • by NIO2 to signal the failure of a completion handler
  • by the container to signal an I/O error on a non-container thread during Servlet 3.0 asynchronous processing.
OPEN_READback to summary
public static final SocketEvent OPEN_READ

Data is available to be read.

OPEN_WRITEback to summary
public static final SocketEvent OPEN_WRITE

The socket is ready to be written to.

STOPback to summary
public static final SocketEvent STOP

The associated Connector/Endpoint is stopping and the connection/socket needs to be closed cleanly.

TIMEOUTback to summary
public static final SocketEvent TIMEOUT

A timeout has occurred and the connection needs to be closed cleanly. Currently this is only used by the Servlet 3.0 async processing.

Constructor Detail

SocketEventback to summary
private SocketEvent()

Method Detail

valueOfback to summary
public static SocketEvent valueOf(String name)
valuesback to summary
public static SocketEvent[] values()