com.squareup.okhttp.ws

Interface WebSocketListener

public interface WebSocketListener

Listener for server-initiated messages on a connected WebSocket.

Method Summary

Modifier and Type	Method and Description
void	onClose(int code, String reason) Called when the server sends a close message.
void	onFailure(IOException e) Called when the transport or protocol layer of this web socket errors during communication.
void	onMessage(okio.BufferedSource payload, WebSocket.PayloadType type) Called when a server message is received.
void	onOpen(WebSocket webSocket, Request request, Response response)
void	onPong(okio.Buffer payload) Called when a server pong is received.

Method Detail

onOpen

void onOpen(WebSocket webSocket,
            Request request,
            Response response)
     throws IOException

Throws:

IOException

onMessage

void onMessage(okio.BufferedSource payload,
               WebSocket.PayloadType type)
        throws IOException

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.

Throws:

IOException

onPong

void onPong(okio.Buffer payload)

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

onClose

void onClose(int code,
             String reason)

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.

Parameters:

code - The RFC-compliant status code.

reason - Reason for close or an empty string.

onFailure

void onFailure(IOException e)

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