javax.websocket.Endpoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javaee-api Show documentation

There is a newer version: 8.0-6

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package javax.websocket;

public abstract class Endpoint {

    /**
     * Event that is triggered when a new session starts.
     *
     * @param session   The new session.
     * @param config    The configuration with which the Endpoint was
     *                  configured.
     */
    public abstract void onOpen(Session session, EndpointConfig config);

    /**
     * Event that is triggered when a session has closed.
     *
     * @param session       The session
     * @param closeReason   Why the session was closed
     */
    public void onClose(Session session, CloseReason closeReason) {
        // NO-OP by default
    }

    /**
     * Event that is triggered when a protocol error occurs.
     *
     * @param session   The session.
     * @param throwable The exception.
     */
    public void onError(Session session, Throwable throwable) {
        // NO-OP by default
    }
}