org.atmosphere.gwt.server.GwtResponseWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atmosphere-gwt-server Show documentation
There is a newer version: 1.1.0.RC5
Show newest version
/*
 * Copyright 2012 Jean-Francois Arcand
 *
 * 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.
 */
/*
 * Copyright 2009 Richard Zschech.
 * 
 * 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.gwt.server;

import java.io.IOException;
import java.io.Serializable;
import java.util.List;


/**
 * A Comet response provides methods for sending messages using the associated HTTP response. It also provides methods
 * for setting up Comet sessions.
 *
 * @author Richard Zschech
 */
public interface GwtResponseWriter {

    /**
     * Write a single message to the associated HTTP response.
     *
     * @param message
     * @throws IOException
     */
    public void write(Serializable message) throws IOException, SerializationException;

    /**
     * Write a single message to the associated HTTP response. Flush the HTTP output stream if flush is true.
     *
     * @param message
     * @param flush
     * @throws IOException
     */
    public void write(Serializable message, boolean flush) throws IOException, SerializationException;

    /**
     * Write a list of message to the associated HTTP response. This method may be more optimal to the single message
     * version.
     *
     * @param messages
     * @throws IOException
     */
    public void write(List messages) throws IOException, SerializationException;

    /**
     * Write a list of message to the associated HTTP response. This method may be more optimal to the single message
     * version. Flush the HTTP output stream if flush is true.
     *
     * @param messages
     * @param flush
     * @throws IOException
     */
    public void write(List messages, boolean flush) throws IOException, SerializationException;

    /**
     * Write a heartbeat message to the associated HTTP response.
     *
     * @throws IOException
     */
    public void heartbeat() throws IOException;

    /**
     * Write a terminate message to the associated HTTP response and close the HTTP output stream/
     *
     * @throws IOException
     */
    public void terminate() throws IOException;

    /**
     * Test if this Comet response has been terminated by calling the {@link #terminate()} method or terminated from the
     * HTTP client disconnecting.
     *
     * @return if this Comet response has been terminated
     */
    public boolean isTerminated();

    /**
     * Returns the last time a write has been performed
     *
     * @return
     */
    public long getLastWriteTime();

    /**
     * Send an error before the response is sent.
     *
     * @param statusCode
     * @throws IOException
     */
    public void sendError(int statusCode) throws IOException;

    /**
     * Send an error before the response is sent.
     *
     * @param statusCode
     * @param message
     * @throws IOException
     */
    public void sendError(int statusCode, String message) throws IOException;
}