org.eclipse.jetty.websocket.api.WebSocketListener Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2018 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.websocket.api;
/**
* Basic WebSocket Listener interface for incoming WebSocket events.
*/
public interface WebSocketListener
{
/**
* A WebSocket binary frame has been received.
*
* @param payload
* the raw payload array received
* @param offset
* the offset in the payload array where the data starts
* @param len
* the length of bytes in the payload
*/
void onWebSocketBinary(byte payload[], int offset, int len);
/**
* A Close Event was received.
*
* The underlying Connection will be considered closed at this point.
*
* @param statusCode
* the close status code. (See {@link StatusCode})
* @param reason
* the optional reason for the close.
*/
void onWebSocketClose(int statusCode, String reason);
/**
* A WebSocket {@link Session} has connected successfully and is ready to be used.
*
* Note: It is a good idea to track this session as a field in your object so that you can write messages back via the {@link RemoteEndpoint}
*
* @param session
* the websocket session.
*/
void onWebSocketConnect(Session session);
/**
* A WebSocket exception has occurred.
*
* This is a way for the internal implementation to notify of exceptions occured during the processing of websocket.
*
* Usually this occurs from bad / malformed incoming packets. (example: bad UTF8 data, frames that are too big, violations of the spec)
*
* This will result in the {@link Session} being closed by the implementing side.
*
* @param error
* the error that occurred.
*/
void onWebSocketError(Throwable cause);
/**
* A WebSocket Text frame was received.
*
* @param message
*/
void onWebSocketText(String message);
}