View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2013 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   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.websocket;
20  
21  import org.eclipse.jetty.io.Buffer;
22  
23  
24  
25  /* ------------------------------------------------------------ */
26  /**
27   * Parser the WebSocket protocol.
28   *
29   */
30  public interface WebSocketParser
31  {
32      
33      /* ------------------------------------------------------------ */
34      /* ------------------------------------------------------------ */
35      /* ------------------------------------------------------------ */
36      public interface FrameHandler
37      {
38          void onFrame(byte flags, byte opcode, Buffer buffer);
39          void close(int code,String message);
40      }
41  
42      Buffer getBuffer();
43  
44      /**
45       * @return an indication of progress, normally bytes filled plus events parsed, or -1 for EOF
46       */
47      int parseNext();
48  
49      boolean isBufferEmpty();
50  
51      void fill(Buffer buffer);
52  
53  }