View Javadoc

1   package org.eclipse.jetty.continuation;
2   //========================================================================
3   //Copyright 2011-2012 Mort Bay Consulting Pty. Ltd.
4   //------------------------------------------------------------------------
5   //All rights reserved. This program and the accompanying materials
6   //are made available under the terms of the Eclipse Public License v1.0
7   //and Apache License v2.0 which accompanies this distribution.
8   //The Eclipse Public License is available at
9   //http://www.eclipse.org/legal/epl-v10.html
10  //The Apache License v2.0 is available at
11  //http://www.opensource.org/licenses/apache2.0.php
12  //You may elect to redistribute this code under either of these licenses.
13  //========================================================================
14  
15  import java.util.EventListener;
16  
17  import javax.servlet.ServletRequestListener;
18  
19  
20  /* ------------------------------------------------------------ */
21  /** A Continuation Listener
22   * <p>
23   * A ContinuationListener may be registered with a call to
24   * {@link Continuation#addContinuationListener(ContinuationListener)}.
25   * 
26   */
27  public interface ContinuationListener extends EventListener 
28  {    
29      /* ------------------------------------------------------------ */
30      /**
31       * Called when a continuation life cycle is complete and after
32       * any calls to {@link ServletRequestListener#requestDestroyed(javax.servlet.ServletRequestEvent)}
33       * The response may still be written to during the call.
34       * 
35       * @param continuation
36       */
37      public void onComplete(Continuation continuation);
38      
39      /* ------------------------------------------------------------ */
40      /**
41       * Called when a suspended continuation has timed out.
42       * The response may be written to and the methods 
43       * {@link Continuation#resume()} or {@link Continuation#complete()} 
44       * may be called by a onTimeout implementation,
45       * @param continuation
46       */
47      public void onTimeout(Continuation continuation);
48  
49  }