com.ning.http.client.websocket

Class DefaultWebSocketListener

java.lang.Object

com.ning.http.client.websocket.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 and Description
protected WebSocket	webSocket

Constructor Summary

Constructors

Constructor and Description
DefaultWebSocketListener()

Method Summary

Methods

Modifier and Type	Method and Description
void	onClose(WebSocket websocket) Invoked when the WebSocket is close.
void	onError(Throwable t) Invoked when the WebSocket is open.
void	onFragment(byte[] fragment, boolean last) Invoked when bytes of a fragmented message are available.
void	onFragment(String fragment, boolean last) Invoked when WebSocket text fragments are received.
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 Detail

webSocket

protected WebSocket webSocket

Constructor Detail

DefaultWebSocketListener

public DefaultWebSocketListener()

Method Detail

onMessage

public void onMessage(byte[] message)

Invoked when bytes are available.

Specified by:

onMessage in interface WebSocketByteListener

Parameters:

message - a byte array.

onFragment

public void onFragment(byte[] fragment,
              boolean last)

Invoked when bytes of a fragmented message are available.

Specified by:

onFragment in interface WebSocketByteListener

Parameters:

fragment - byte[] fragment.

last - if this fragment is the last in the series.

onPing

public void onPing(byte[] message)

Invoked when a ping message is received

Specified by:

onPing in interface WebSocketPingListener

Parameters:

message - a byte array

onPong

public void onPong(byte[] message)

Invoked when a pong message is received

Specified by:

onPong in interface WebSocketPongListener

Parameters:

message - a byte array

onMessage

public void onMessage(String message)

Invoked when WebSocket text message are received.

Specified by:

onMessage in interface WebSocketTextListener

Parameters:

message - a String message

onFragment

public void onFragment(String fragment,
              boolean last)

Invoked when WebSocket text fragments are received.

Specified by:

onFragment in interface WebSocketTextListener

Parameters:

fragment - text fragment

last - if this fragment is the last of the series.

onOpen

public void onOpen(WebSocket websocket)

Invoked when the WebSocket is open.

Specified by:

onOpen in interface WebSocketListener

onClose

public void onClose(WebSocket websocket)

Invoked when the WebSocket is close.

Specified by:

onClose in interface WebSocketListener

onError

public void onError(Throwable t)

Invoked when the WebSocket is open.

Specified by:

onError in interface WebSocketListener

Parameters:

t - a Throwable