View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2016 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.api;
20  
21  /**
22   * Basic WebSocket Listener interface for incoming WebSocket message events.
23   */
24  public interface WebSocketListener extends WebSocketConnectionListener
25  {
26      /**
27       * A WebSocket binary frame has been received.
28       * 
29       * @param payload
30       *            the raw payload array received
31       * @param offset
32       *            the offset in the payload array where the data starts
33       * @param len
34       *            the length of bytes in the payload
35       */
36      void onWebSocketBinary(byte payload[], int offset, int len);
37  
38      /**
39       * A WebSocket Text frame was received.
40       * 
41       * @param message the message
42       */
43      void onWebSocketText(String message);
44  }