WebSocketHandler.java

/*
 * Copyright 2015 Netflix, Inc.
 *
 * Licensed 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 io.reactivex.netty.protocol.http.ws.server;

import io.reactivex.netty.protocol.http.ws.WebSocketConnection;
import rx.Observable;

/**
 * A handler for {@link WebSocketConnection} upon a successful upgrade from an HTTP request.
 */
public interface WebSocketHandler {

    /**
     * Processes the passed connection.
     *
     * @param wsConnection Connection to process.
     *
     * @return {@code Observable} representing the processing termination.
     */
    Observable<Void> handle(WebSocketConnection wsConnection);

}