View Javadoc

1   // ========================================================================
2   // Copyright (c) 2010 Mort Bay Consulting Pty. Ltd.
3   // ------------------------------------------------------------------------
4   // All rights reserved. This program and the accompanying materials
5   // are made available under the terms of the Eclipse Public License v1.0
6   // and Apache License v2.0 which accompanies this distribution.
7   // The Eclipse Public License is available at 
8   // http://www.eclipse.org/legal/epl-v10.html
9   // The Apache License v2.0 is available at
10  // http://www.opensource.org/licenses/apache2.0.php
11  // You may elect to redistribute this code under either of these licenses. 
12  // ========================================================================
13  
14  package org.eclipse.jetty.websocket;
15  
16  import org.eclipse.jetty.io.Buffer;
17  
18  
19  
20  /* ------------------------------------------------------------ */
21  /**
22   * Parser the WebSocket protocol.
23   *
24   */
25  public interface WebSocketParser
26  {
27      
28      /* ------------------------------------------------------------ */
29      /* ------------------------------------------------------------ */
30      /* ------------------------------------------------------------ */
31      public interface FrameHandler
32      {
33          void onFrame(byte flags, byte opcode, Buffer buffer);
34          void close(int code,String message);
35      }
36  
37      Buffer getBuffer();
38  
39      /**
40       * @return an indication of progress, normally bytes filled plus events parsed, or -1 for EOF
41       */
42      int parseNext();
43  
44      boolean isBufferEmpty();
45  
46      void fill(Buffer buffer);
47  
48  }