org.atmosphere.vibe.transport.TransportServer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vibe-server Show documentation

The newest version!

/*
 * Copyright 2014 The Vibe Project
 *
 * 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 org.atmosphere.vibe.transport;

import org.atmosphere.vibe.platform.action.Action;
import org.atmosphere.vibe.platform.http.ServerHttpExchange;
import org.atmosphere.vibe.platform.ws.ServerWebSocket;

/**
 * Interface used to interact with transports.
 * 
 * {@code TransportServer} consumes resource like {@link ServerHttpExchange} or
 * {@link ServerWebSocket} and produces {@link ServerTransport} following the
 * corresponding Vibe transport protocol.
 * 
 * Instances may be accessed by multiple threads.
 * 
 * @author Donghwan Kim
 */
public interface TransportServer extends Action {

    /**
     * Registers an action to be called when the transport has been opened.
     */
    TransportServer transportAction(Action action);

}