com.sun.grizzly.comet.CometHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grizzly-comet
There is a newer version: 1.9.65
/*
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 *
 */

package com.sun.grizzly.comet;

import java.io.IOException;

/**
 * This interface allow Java components part of an HTTP request to be polled
 * by the Grizzly Asynchronous Request Mechanism. Components that implement
 * this interface will be notified when another {@link CometHandler} 
 * notify them using CometContext.notify.
 *
 * With Servlet, it is recommended to attach the HTTPServletResponse
 * and use this object to push back bytes to the client.
 *
 * @author Jeanfrancois Arcand
 */
public interface CometHandler {

    /**
     * Attach an intance of E to this class.
     */
    public void attach(E attachment);
    
    
    /**
     * Receive {@link CometEvent} notification.
     */
    public void onEvent(CometEvent event) throws IOException;
    
    
    /**
     * Receive {@link CometEvent} notification when the underlying 
     * tcp communication is started by the client
     */
    public void onInitialize(CometEvent event) throws IOException;
    
    
    /**
     * Receive {@link CometEvent} notification when the underlying 
     * tcp communication is closed by the {@link CometHandler}
     */
    public void onTerminate(CometEvent event) throws IOException;    
    
    
    /**
     * Receive {@link CometEvent} notification when the underlying 
     * tcp communication is resumed by the Grizzly ARP.
     */
    public void onInterrupt(CometEvent event) throws IOException;
    
}