Class AbstractEndpoint

java/org/apache/tomcat/util/net/AbstractEndpoint.java:76–2529

Abstract endpoint implementation. @param The type used by the socket wrapper associated with this endpoint. Might be the same as U. @param The type of the underlying socket used by this endpoint. Might be the same as S.

 * @param <U> The type of the underlying socket used by this endpoint. Might be the same as S.
 */
public abstract class AbstractEndpoint<S, U> {

    /**
     * Construct and return an endpoint.
     */
    public AbstractEndpoint() {
    }

    // -------------------------------------------------------------- Constants

    /**
     * String manager for this package.
     */
    protected static final StringManager sm = StringManager.getManager(AbstractEndpoint.class);

    /**
     * Interface for handlers used by an endpoint.
     *
     * @param <S> The type of the socket wrapper
     */
    public interface Handler<S> {

        /**
         * Different types of socket states to react upon.
         */
        enum SocketState {
            // TODO Add a new state to the AsyncStateMachine and remove
            // ASYNC_END (if possible)
            /**
             * The socket is open and ready for processing.
             */
            OPEN,
            /**
             * The socket has been closed.
             */
            CLOSED,
            /**
             * The connection is long-running (e.g., keep-alive).
             */
            LONG,
            /**
             * The asynchronous processing phase has ended.
             */
            ASYNC_END,
            /**
             * Send file processing is in progress.
             */
            SENDFILE,
            /**
             * The connection is being upgraded (e.g., WebSocket upgrade).
             */
            UPGRADING,
            /**
             * The connection has been upgraded.
             */
            UPGRADED,
            /**
             * Asynchronous I/O is in progress.