Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 2007-2010 Oracle and/or its affiliates. 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_1_1.html
  * or packager/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 packager/legal/LICENSE.txt.
  *
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  *
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [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.enterprise.web.connector.grizzly.comet;
 
This interface represents a suspended connection (or response). Passing an instance of this class to CometContext.addCometListener automatically tells Grizzly Comet to suspend the underlying connection and to avoid commiting the response. Since the response is not commited, the connection is considered as suspended and can be resumed later when an event happens by invoking, from onEvent(com.sun.enterprise.web.connector.grizzly.comet.CometEvent) or eveyrwhere, the CometContext.resumeCometHandler(com.sun.enterprise.web.connector.grizzly.comet.CometHandler), which resume the connection by commiting the response. As an example, a browser icons will spins when a connection is suspended, as the complete response hasn't been sent back. Components that implement this interface will be notified when another CometHandler notify them using java.lang.Object.notify() With Servlet, it is recommended to attach the HTTPServletResponse and use this object to push back messages to the client.

Author(s):
Jeanfrancois Arcand
 
 public interface CometHandler<E> {

    
Attach an intance of E to this class.
 
     public void attach(E attachment);
    
    
    
Receive CometEvent notification. This method will be invoked everytime a java.lang.Object.notify() is invoked. The CometEvent will contains the message that can be pushed back to the remote client, cached or ignored. This method can also be used to resume a connection once a notified by invoking CometContext.resumeCometHandler(com.sun.enterprise.web.connector.grizzly.comet.CometHandler).
 
     public void onEvent(CometEvent eventthrows IOException;
    
    
    
Receive CometEvent notification when Grizzly is about to suspend the connection. This method is always invoked during the processing of CometContext.addCometHandler(com.sun.enterprise.web.connector.grizzly.comet.CometHandler) operations.
 
     public void onInitialize(CometEvent eventthrows IOException;
    
    
    
Receive CometEvent notification when the response is resumed by a CometHandler or by the CometContext
 
     public void onTerminate(CometEvent eventthrows IOException;    
    
    
    
Receive CometEvent notification when the underlying tcp communication is resumed by the Grizzly ARP. This happens when the CometContext.setExpirationDelay(long) expires or when the remote client close the connection.
    public void onInterrupt(CometEvent eventthrows IOException;
    
New to GrepCode? Check out our FAQ X