okhttp3.internal.ws

Class WebSocketReader

java.lang.Object

okhttp3.internal.ws.WebSocketReader

final class WebSocketReader
extends java.lang.Object

An RFC 6455-compatible WebSocket frame reader.

This class is not thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WebSocketReader.FrameCallback

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	closed
private okio.Buffer	controlFrameBuffer
(package private) WebSocketReader.FrameCallback	frameCallback
(package private) long	frameLength
(package private) boolean	isClient
(package private) boolean	isControlFrame
(package private) boolean	isFinalFrame
private okio.Buffer.UnsafeCursor	maskCursor
private byte[]	maskKey
private okio.Buffer	messageFrameBuffer
(package private) int	opcode
(package private) okio.BufferedSource	source

Constructor Summary

Constructors

Constructor and Description
WebSocketReader(boolean isClient, okio.BufferedSource source, WebSocketReader.FrameCallback frameCallback)

Method Summary

Modifier and Type	Method and Description
(package private) void	processNextFrame() Process the next protocol frame.
private void	readControlFrame()
private void	readHeader()
private void	readMessage() Reads a message body into across one or more frames.
private void	readMessageFrame()
private void	readUntilNonControlFrame() Read headers and process any control frames until we reach a non-control frame.

Methods inherited from class java.lang.Object

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

Field Detail

isClient

final boolean isClient

source

final okio.BufferedSource source

frameCallback

final WebSocketReader.FrameCallback frameCallback

closed

boolean closed

opcode

int opcode

frameLength

long frameLength

isFinalFrame

boolean isFinalFrame

isControlFrame

boolean isControlFrame

controlFrameBuffer

private final okio.Buffer controlFrameBuffer

messageFrameBuffer

private final okio.Buffer messageFrameBuffer

maskKey

private final byte[] maskKey

maskCursor

private final okio.Buffer.UnsafeCursor maskCursor

Constructor Detail

WebSocketReader

WebSocketReader(boolean isClient,
                okio.BufferedSource source,
                WebSocketReader.FrameCallback frameCallback)

Method Detail

processNextFrame

void processNextFrame()
               throws java.io.IOException

Process the next protocol frame.

• If it is a control frame this will result in a single call to WebSocketReader.FrameCallback.
• If it is a message frame this will result in a single call to WebSocketReader.FrameCallback.onReadMessage(java.lang.String). If the message spans multiple frames, each interleaved control frame will result in a corresponding call to WebSocketReader.FrameCallback.

Throws:

java.io.IOException

readHeader

private void readHeader()
                 throws java.io.IOException

Throws:

java.io.IOException

readControlFrame

private void readControlFrame()
                       throws java.io.IOException

Throws:

java.io.IOException

readMessageFrame

private void readMessageFrame()
                       throws java.io.IOException

Throws:

java.io.IOException

readUntilNonControlFrame

private void readUntilNonControlFrame()
                               throws java.io.IOException

Read headers and process any control frames until we reach a non-control frame.

Throws:

java.io.IOException

readMessage

private void readMessage()
                  throws java.io.IOException

Reads a message body into across one or more frames. Control frames that occur between fragments will be processed. If the message payload is masked this will unmask as it's being processed.

Throws:

java.io.IOException