com.squareup.okhttp.recipes

Class WebSocketEcho

java.lang.Object

com.squareup.okhttp.recipes.WebSocketEcho

All Implemented Interfaces:

WebSocketListener

public final class WebSocketEcho
extends Object
implements WebSocketListener

Constructor Summary

Constructors

Constructor and Description
WebSocketEcho()

Method Summary

Modifier and Type	Method and Description
static void	main(String... args)
void	onClose(int code, String reason) Called when the server sends a close message.
void	onFailure(IOException e, Response response) Called when the transport or protocol layer of this web socket errors during communication.
void	onMessage(ResponseBody message) Called when a server message is received.
void	onOpen(WebSocket webSocket, Response response) Called when the request has successfully been upgraded to a web socket.
void	onPong(okio.Buffer payload) Called when a server pong is received.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketEcho

public WebSocketEcho()

Method Detail

onOpen

public void onOpen(WebSocket webSocket,
                   Response response)

Description copied from interface: WebSocketListener

Called when the request has successfully been upgraded to a web socket. This method is called on the message reading thread to allow setting up any state before the message, pong, and close callbacks start.

Do not use this callback to write to the web socket. Start a new thread or use another thread in your application.

Specified by:

onOpen in interface WebSocketListener

onMessage

public void onMessage(ResponseBody message)
               throws IOException

Description copied from interface: WebSocketListener

Called when a server message is received. The type indicates whether the payload should be interpreted as UTF-8 text or binary data.

Implementations must call source.close() before returning. This indicates completion of parsing the message payload and will consume any remaining bytes in the message.

The content type of message will be either WebSocket.TEXT or WebSocket.BINARY which indicates the format of the message.

Specified by:

onMessage in interface WebSocketListener

Throws:

IOException

onPong

public void onPong(okio.Buffer payload)

Description copied from interface: WebSocketListener

Called when a server pong is received. This is usually a result of calling WebSocket.sendPing(Buffer) but might also be unsolicited.

Specified by:

onPong in interface WebSocketListener

onClose

public void onClose(int code,
                    String reason)

Description copied from interface: WebSocketListener

Called when the server sends a close message. This may have been initiated from a call to close() or as an unprompted message from the server.

Specified by:

onClose in interface WebSocketListener

Parameters:

code - The RFC-compliant status code.

reason - Reason for close or an empty string.

onFailure

public void onFailure(IOException e,
                      Response response)

Description copied from interface: WebSocketListener

Called when the transport or protocol layer of this web socket errors during communication.

Specified by:

onFailure in interface WebSocketListener

response - Present when the failure is a direct result of the response (e.g., failed upgrade, non-101 response code, etc.). null otherwise.

main

public static void main(String... args)
                 throws IOException

Throws:

IOException