com.squareup.okhttp.internal.ws

Class WebSocketWriter

java.lang.Object

com.squareup.okhttp.internal.ws.WebSocketWriter

public final class WebSocketWriter
extends Object

An RFC 6455-compatible WebSocket frame writer.

This class is partially thread safe. Only a single "main" thread should be sending messages via calls to newMessageSink(com.squareup.okhttp.internal.ws.WebSocket.PayloadType) or sendMessage(com.squareup.okhttp.internal.ws.WebSocket.PayloadType, okio.Buffer) as well as any calls to writePing(okio.Buffer) or writeClose(int, java.lang.String). Other threads may call writePing(okio.Buffer), writePong(okio.Buffer), or writeClose(int, java.lang.String) which will interleave on the wire with frames from the main thread.

Constructor Summary

Constructors

Constructor and Description
WebSocketWriter(boolean isClient, okio.BufferedSink sink, Random random)

Method Summary

Modifier and Type	Method and Description
boolean	isClosed()
okio.BufferedSink	newMessageSink(WebSocket.PayloadType type) Stream a message payload as a series of frames.
void	sendMessage(WebSocket.PayloadType type, okio.Buffer payload) Send a message payload as a single frame.
void	writeClose(okio.Buffer payload) Send a close frame with optional payload.
void	writeClose(int code, String reason) Send a close frame with optional code and reason.
void	writePing(okio.Buffer payload) Send a ping with the supplied payload.
void	writePong(okio.Buffer payload) Send a pong with the supplied payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketWriter

public WebSocketWriter(boolean isClient,
                       okio.BufferedSink sink,
                       Random random)

Method Detail

isClosed

public boolean isClosed()

writePing

public void writePing(okio.Buffer payload)
               throws IOException

Send a ping with the supplied payload. Payload may be null

Throws:

IOException

writePong

public void writePong(okio.Buffer payload)
               throws IOException

Send a pong with the supplied payload. Payload may be null

Throws:

IOException

writeClose

public void writeClose(int code,
                       String reason)
                throws IOException

Send a close frame with optional code and reason.

Parameters:

code - Status code as defined by Section 7.4 of RFC 6455 or 0.

reason - Reason for shutting down or null. code is required if set.

Throws:

IOException

writeClose

public void writeClose(okio.Buffer payload)
                throws IOException

Send a close frame with optional payload. This is used when echoing a close and its payload back to the other peer.

Throws:

IOException

newMessageSink

public okio.BufferedSink newMessageSink(WebSocket.PayloadType type)

Stream a message payload as a series of frames. This allows control frames to be interleaved between parts of the message.

sendMessage

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

Send a message payload as a single frame. This will block any control frames that need sent until it is completed.

Throws:

IOException