com.squareup.okhttp.ws

Interface WebSocket

public interface WebSocket

Blocking interface to connect and write to a web socket.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocket.PayloadType The format of a message payload.

Method Summary

Modifier and Type	Method and Description
void	close(int code, String reason) Send a close frame to the server.
okio.BufferedSink	newMessageSink(WebSocket.PayloadType type) Stream a message payload to the server of the specified {code type}.
void	sendMessage(WebSocket.PayloadType type, okio.Buffer payload) Send a message payload to the server of the specified type.
void	sendPing(okio.Buffer payload) Send a ping to the server with optional payload.

Method Detail

newMessageSink

okio.BufferedSink newMessageSink(WebSocket.PayloadType type)

Stream a message payload to the server of the specified {code type}.

You must call close() to complete the message. Calls to flush() write a frame fragment. The message may be empty.

Throws:

IllegalStateException - if not connected, already closed, or another writer is active.

sendMessage

void sendMessage(WebSocket.PayloadType type,
                 okio.Buffer payload)
          throws IOException

Send a message payload to the server of the specified type.

Throws:

IllegalStateException - if not connected, already closed, or another writer is active.

IOException

sendPing

void sendPing(okio.Buffer payload)
       throws IOException

Send a ping to the server with optional payload.

Throws:

IllegalStateException - if already closed.

IOException

close

void close(int code,
           String reason)
    throws IOException

Send a close frame to the server.

The corresponding WebSocketListener will continue to get messages until its onClose() method is called.

It is an error to call this method before calling close on an active writer. Calling this method more than once has no effect.

Throws:

IllegalStateException - if already closed.

IOException