okhttp3.internal.ws

Class WebSocketWriter

java.lang.Object

okhttp3.internal.ws.WebSocketWriter

final class WebSocketWriter
extends java.lang.Object

An RFC 6455-compatible WebSocket frame writer.

This class is not thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	WebSocketWriter.FrameSink

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	activeWriter
(package private) okio.Buffer	buffer
(package private) WebSocketWriter.FrameSink	frameSink
(package private) boolean	isClient
private okio.Buffer.UnsafeCursor	maskCursor
private byte[]	maskKey
(package private) java.util.Random	random
(package private) okio.BufferedSink	sink
(package private) okio.Buffer	sinkBuffer The Buffer of sink.
(package private) boolean	writerClosed

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
(package private) okio.Sink	newMessageSink(int formatOpcode, long contentLength) Stream a message payload as a series of frames.
(package private) void	writeClose(int code, okio.ByteString reason) Send a close frame with optional code and reason.
private void	writeControlFrame(int opcode, okio.ByteString payload)
(package private) void	writeMessageFrame(int formatOpcode, long byteCount, boolean isFirstFrame, boolean isFinal)
(package private) void	writePing(okio.ByteString payload) Send a ping with the supplied payload.
(package private) void	writePong(okio.ByteString 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

Field Detail

isClient

final boolean isClient

random

final java.util.Random random

sink

final okio.BufferedSink sink

sinkBuffer

final okio.Buffer sinkBuffer

The Buffer of sink. Write to this and then flush/emit sink.

writerClosed

boolean writerClosed

buffer

final okio.Buffer buffer

frameSink

final WebSocketWriter.FrameSink frameSink

activeWriter

boolean activeWriter

maskKey

private final byte[] maskKey

maskCursor

private final okio.Buffer.UnsafeCursor maskCursor

Constructor Detail

WebSocketWriter

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

Method Detail

writePing

void writePing(okio.ByteString payload)
        throws java.io.IOException

Send a ping with the supplied payload.

Throws:

java.io.IOException

writePong

void writePong(okio.ByteString payload)
        throws java.io.IOException

Send a pong with the supplied payload.

Throws:

java.io.IOException

writeClose

void writeClose(int code,
                okio.ByteString reason)
         throws java.io.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.

Throws:

java.io.IOException

writeControlFrame

private void writeControlFrame(int opcode,
                               okio.ByteString payload)
                        throws java.io.IOException

Throws:

java.io.IOException

newMessageSink

okio.Sink newMessageSink(int formatOpcode,
                         long contentLength)

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

writeMessageFrame

void writeMessageFrame(int formatOpcode,
                       long byteCount,
                       boolean isFirstFrame,
                       boolean isFinal)
                throws java.io.IOException

Throws:

java.io.IOException