Package com.ning.http.client.ws

Class DefaultWebSocketListener

java.lang.Object

com.ning.http.client.ws.DefaultWebSocketListener

All Implemented Interfaces:

WebSocketByteListener, WebSocketListener, WebSocketPingListener, WebSocketPongListener, WebSocketTextListener

public class DefaultWebSocketListener
extends Object
implements WebSocketByteListener, WebSocketTextListener, WebSocketPingListener, WebSocketPongListener

Default WebSocketListener implementation. Most methods are no-ops. This allows for quick override customization without clutter of methods that the developer isn't interested in dealing with.

Since:

1.7.0

Field Summary

Fields

Modifier and Type	Field	Description
protected WebSocket	webSocket

Constructor Summary

Constructors

Constructor	Description
DefaultWebSocketListener()

Method Summary

Modifier and Type	Method	Description
void	onClose(WebSocket websocket)	Invoked when the WebSocket is close.
void	onError(Throwable t)	Invoked when the WebSocket is open.
void	onMessage(byte[] message)	Invoked when bytes are available.
void	onMessage(String message)	Invoked when WebSocket text message are received.
void	onOpen(WebSocket websocket)	Invoked when the WebSocket is open.
void	onPing(byte[] message)	Invoked when a ping message is received
void	onPong(byte[] message)	Invoked when a pong message is received

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

webSocket

protected WebSocket webSocket

Constructor Details

DefaultWebSocketListener

public DefaultWebSocketListener()

Method Details

onMessage

public void onMessage(byte[] message)

Description copied from interface: WebSocketByteListener

Invoked when bytes are available.

Specified by:

onMessage in interface WebSocketByteListener

Parameters:

message - a byte array.

onPing

public void onPing(byte[] message)

Description copied from interface: WebSocketPingListener

Invoked when a ping message is received

Specified by:

onPing in interface WebSocketPingListener

Parameters:

message - a byte array

onPong

public void onPong(byte[] message)

Description copied from interface: WebSocketPongListener

Invoked when a pong message is received

Specified by:

onPong in interface WebSocketPongListener

Parameters:

message - a byte array

onMessage

public void onMessage(String message)

Description copied from interface: WebSocketTextListener

Invoked when WebSocket text message are received.

Specified by:

onMessage in interface WebSocketTextListener

Parameters:

message - a String message

onOpen

public void onOpen(WebSocket websocket)

Description copied from interface: WebSocketListener

Invoked when the WebSocket is open.

Specified by:

onOpen in interface WebSocketListener

onClose

public void onClose(WebSocket websocket)

Description copied from interface: WebSocketListener

Invoked when the WebSocket is close.

Specified by:

onClose in interface WebSocketListener

onError

public void onError(Throwable t)

Description copied from interface: WebSocketListener

Invoked when the WebSocket is open.

Specified by:

onError in interface WebSocketListener

Parameters:

t - a Throwable