RealWebSocket

java.lang.Object
- okhttp3.internal.ws.RealWebSocket

All Implemented Interfaces:: WebSocketReader.FrameCallback, WebSocket

public final class RealWebSocket
extends java.lang.Object
implements WebSocket, WebSocketReader.FrameCallback

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`RealWebSocket.CancelRunnable`
`(package private) static class`	`RealWebSocket.Close`
`(package private) static class`	`RealWebSocket.Message`
`private class`	`RealWebSocket.PingRunnable`
`static class`	`RealWebSocket.Streams`

Nested classes/interfaces inherited from interface okhttp3.WebSocket
WebSocket.Factory

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`awaitingPong` True if we have sent a ping that is still awaiting a reply.
`private Call`	`call` Non-null for client web sockets.
`private static long`	`CANCEL_AFTER_CLOSE_MILLIS` The maximum amount of time after the client calls `close(int, java.lang.String)` to wait for a graceful shutdown.
`private java.util.concurrent.ScheduledFuture<?>`	`cancelFuture` When executed this will cancel this websocket.
`private boolean`	`enqueuedClose` True if we've enqueued a close frame.
`private java.util.concurrent.ScheduledExecutorService`	`executor` Null until this web socket is connected.
`private boolean`	`failed` True if this web socket failed and the listener has been notified.
`private java.lang.String`	`key`
`(package private) WebSocketListener`	`listener`
`private static long`	`MAX_QUEUE_SIZE` The maximum number of bytes to enqueue.
`private java.util.ArrayDeque<java.lang.Object>`	`messageAndCloseQueue` Outgoing messages and close frames in the order they should be written.
`private static java.util.List<Protocol>`	`ONLY_HTTP1`
`private Request`	`originalRequest` The application's original request unadulterated by web socket headers.
`private long`	`pingIntervalMillis`
`private java.util.ArrayDeque<okio.ByteString>`	`pongQueue` Outgoing pongs in the order they should be written.
`private long`	`queueSize` The total size in bytes of enqueued but not yet transmitted messages.
`private java.util.Random`	`random`
`private WebSocketReader`	`reader` Null until this web socket is connected.
`private int`	`receivedCloseCode` The close code from the peer, or -1 if this web socket has not yet read a close frame.
`private java.lang.String`	`receivedCloseReason` The close reason from the peer, or null if this web socket has not yet read a close frame.
`private int`	`receivedPingCount` Total number of pings received by this web socket.
`private int`	`receivedPongCount` Total number of pongs received by this web socket.
`private int`	`sentPingCount` Total number of pings sent by this web socket.
`private RealWebSocket.Streams`	`streams` The streams held by this web socket.
`private WebSocketWriter`	`writer` Null until this web socket is connected.
`private java.lang.Runnable`	`writerRunnable` This runnable processes the outgoing queues.

Constructor Summary

Constructors
Constructor and Description
`RealWebSocket(Request request, WebSocketListener listener, java.util.Random random, long pingIntervalMillis)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`awaitTermination(int timeout, java.util.concurrent.TimeUnit timeUnit)` For testing: wait until the web socket's executor has terminated.
`void`	`cancel()` Immediately and violently release resources held by this web socket, discarding any enqueued messages.
`(package private) void`	`checkResponse(Response response)`
`boolean`	`close(int code, java.lang.String reason)` Attempts to initiate a graceful shutdown of this web socket.
`(package private) boolean`	`close(int code, java.lang.String reason, long cancelAfterCloseMillis)`
`void`	`connect(OkHttpClient client)`
`void`	`failWebSocket(java.lang.Exception e, Response response)`
`void`	`initReaderAndWriter(java.lang.String name, RealWebSocket.Streams streams)`
`void`	`loopReader()` Receive frames until there are no more.
`void`	`onReadClose(int code, java.lang.String reason)`
`void`	`onReadMessage(okio.ByteString bytes)`
`void`	`onReadMessage(java.lang.String text)`
`void`	`onReadPing(okio.ByteString payload)`
`void`	`onReadPong(okio.ByteString buffer)`
`(package private) boolean`	`pong(okio.ByteString payload)`
`(package private) boolean`	`processNextFrame()` For testing: receive a single frame and return true if there are more frames to read.
`long`	`queueSize()` Returns the size in bytes of all messages enqueued to be transmitted to the server.
`(package private) int`	`receivedPingCount()`
`(package private) int`	`receivedPongCount()`
`Request`	`request()` Returns the original request that initiated this web socket.
`private void`	`runWriter()`
`boolean`	`send(okio.ByteString bytes)` Attempts to enqueue `bytes` to be sent as a the data of a binary (type `0x2`) message.
`private boolean`	`send(okio.ByteString data, int formatOpcode)`
`boolean`	`send(java.lang.String text)` Attempts to enqueue `text` to be UTF-8 encoded and sent as a the data of a text (type `0x1`) message.
`(package private) int`	`sentPingCount()`
`(package private) void`	`tearDown()` For testing: force this web socket to release its threads.
`(package private) boolean`	`writeOneFrame()` Attempts to remove a single frame from a queue and send it.
`(package private) void`	`writePingFrame()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ONLY_HTTP1
```
private static final java.util.List<Protocol> ONLY_HTTP1
```
  - MAX_QUEUE_SIZE
```
private static final long MAX_QUEUE_SIZE
```
    The maximum number of bytes to enqueue. Rather than enqueueing beyond this limit we tear down the web socket! It's possible that we're writing faster than the peer can read.
    
    See Also:
    
    Constant Field Values
  - CANCEL_AFTER_CLOSE_MILLIS
```
private static final long CANCEL_AFTER_CLOSE_MILLIS
```
    The maximum amount of time after the client calls close(int, java.lang.String) to wait for a graceful shutdown. If the server doesn't respond the websocket will be canceled.
    
    See Also:
    
    Constant Field Values
  - originalRequest
```
private final Request originalRequest
```
    The application's original request unadulterated by web socket headers.
  - listener
```
final WebSocketListener listener
```
  - random
```
private final java.util.Random random
```
  - pingIntervalMillis
```
private final long pingIntervalMillis
```
  - key
```
private final java.lang.String key
```
  - call
```
private Call call
```
    Non-null for client web sockets. These can be canceled.
  - writerRunnable
```
private final java.lang.Runnable writerRunnable
```
    This runnable processes the outgoing queues. Call runWriter() to after enqueueing.
  - reader
```
private WebSocketReader reader
```
    Null until this web socket is connected. Only accessed by the reader thread.
  - writer
```
private WebSocketWriter writer
```
    Null until this web socket is connected. Note that messages may be enqueued before that.
  - executor
```
private java.util.concurrent.ScheduledExecutorService executor
```
    Null until this web socket is connected. Used for writes, pings, and close timeouts.
  - streams
```
private RealWebSocket.Streams streams
```
    The streams held by this web socket. This is non-null until all incoming messages have been read and all outgoing messages have been written. It is closed when both reader and writer are exhausted, or if there is any failure.
  - pongQueue
```
private final java.util.ArrayDeque<okio.ByteString> pongQueue
```
    Outgoing pongs in the order they should be written.
  - messageAndCloseQueue
```
private final java.util.ArrayDeque<java.lang.Object> messageAndCloseQueue
```
    Outgoing messages and close frames in the order they should be written.
  - queueSize
```
private long queueSize
```
    The total size in bytes of enqueued but not yet transmitted messages.
  - enqueuedClose
```
private boolean enqueuedClose
```
    True if we've enqueued a close frame. No further message frames will be enqueued.
  - cancelFuture
```
private java.util.concurrent.ScheduledFuture<?> cancelFuture
```
    When executed this will cancel this websocket. This future itself should be canceled if that is unnecessary because the web socket is already closed or canceled.
  - receivedCloseCode
```
private int receivedCloseCode
```
    The close code from the peer, or -1 if this web socket has not yet read a close frame.
  - receivedCloseReason
```
private java.lang.String receivedCloseReason
```
    The close reason from the peer, or null if this web socket has not yet read a close frame.
  - failed
```
private boolean failed
```
    True if this web socket failed and the listener has been notified.
  - sentPingCount
```
private int sentPingCount
```
    Total number of pings sent by this web socket.
  - receivedPingCount
```
private int receivedPingCount
```
    Total number of pings received by this web socket.
  - receivedPongCount
```
private int receivedPongCount
```
    Total number of pongs received by this web socket.
  - awaitingPong
```
private boolean awaitingPong
```
    True if we have sent a ping that is still awaiting a reply.
- Constructor Detail
  - RealWebSocket
```
public RealWebSocket(Request request,
                     WebSocketListener listener,
                     java.util.Random random,
                     long pingIntervalMillis)
```
- Method Detail
  - request
```
public Request request()
```
    Description copied from interface: WebSocket
    
    Returns the original request that initiated this web socket.
    
    Specified by:
    
    request in interface WebSocket
  - queueSize
```
public long queueSize()
```
    Description copied from interface: WebSocket
    
    Returns the size in bytes of all messages enqueued to be transmitted to the server. This doesn't include framing overhead. It also doesn't include any bytes buffered by the operating system or network intermediaries. This method returns 0 if no messages are waiting in the queue. If may return a nonzero value after the web socket has been canceled; this indicates that enqueued messages were not transmitted.
    
    Specified by:
    
    queueSize in interface WebSocket
  - cancel
```
public void cancel()
```
    Description copied from interface: WebSocket
    
    Immediately and violently release resources held by this web socket, discarding any enqueued messages. This does nothing if the web socket has already been closed or canceled.
    
    Specified by:
    
    cancel in interface WebSocket
  - connect
```
public void connect(OkHttpClient client)
```
  - checkResponse
```
void checkResponse(Response response)
            throws java.net.ProtocolException
```
    Throws:
    
    java.net.ProtocolException
  - initReaderAndWriter
```
public void initReaderAndWriter(java.lang.String name,
                                RealWebSocket.Streams streams)
                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - loopReader
```
public void loopReader()
                throws java.io.IOException
```
    Receive frames until there are no more. Invoked only by the reader thread.
    
    Throws:
    
    java.io.IOException
  - processNextFrame
```
boolean processNextFrame()
                  throws java.io.IOException
```
    For testing: receive a single frame and return true if there are more frames to read. Invoked only by the reader thread.
    
    Throws:
    
    java.io.IOException
  - awaitTermination
```
void awaitTermination(int timeout,
                      java.util.concurrent.TimeUnit timeUnit)
               throws java.lang.InterruptedException
```
    For testing: wait until the web socket's executor has terminated.
    
    Throws:
    
    java.lang.InterruptedException
  - tearDown
```
void tearDown()
       throws java.lang.InterruptedException
```
    For testing: force this web socket to release its threads.
    
    Throws:
    
    java.lang.InterruptedException
  - sentPingCount
```
int sentPingCount()
```
  - receivedPingCount
```
int receivedPingCount()
```
  - receivedPongCount
```
int receivedPongCount()
```
  - onReadMessage
```
public void onReadMessage(java.lang.String text)
                   throws java.io.IOException
```
    Specified by:
    
    onReadMessage in interface WebSocketReader.FrameCallback
    
    Throws:
    
    java.io.IOException
  - onReadMessage
```
public void onReadMessage(okio.ByteString bytes)
                   throws java.io.IOException
```
    Specified by:
    
    onReadMessage in interface WebSocketReader.FrameCallback
    
    Throws:
    
    java.io.IOException
  - onReadPing
```
public void onReadPing(okio.ByteString payload)
```
    Specified by:
    
    onReadPing in interface WebSocketReader.FrameCallback
  - onReadPong
```
public void onReadPong(okio.ByteString buffer)
```
    Specified by:
    
    onReadPong in interface WebSocketReader.FrameCallback
  - onReadClose
```
public void onReadClose(int code,
                        java.lang.String reason)
```
    Specified by:
    
    onReadClose in interface WebSocketReader.FrameCallback
  - send
```
public boolean send(java.lang.String text)
```
    Description copied from interface: WebSocket
    
    Attempts to enqueue text to be UTF-8 encoded and sent as a the data of a text (type 0x1) message.
    This method returns true if the message was enqueued. Messages that would overflow the outgoing message buffer will be rejected and trigger a graceful shutdown of this web socket. This method returns false in that case, and in any other case where this web socket is closing, closed, or canceled.
    This method returns immediately.
    
    Specified by:
    
    send in interface WebSocket
  - send
```
public boolean send(okio.ByteString bytes)
```
    Description copied from interface: WebSocket
    
    Attempts to enqueue bytes to be sent as a the data of a binary (type 0x2) message.
    This method returns true if the message was enqueued. Messages that would overflow the outgoing message buffer (16 MiB) will be rejected and trigger a graceful shutdown of this web socket. This method returns false in that case, and in any other case where this web socket is closing, closed, or canceled.
    This method returns immediately.
    
    Specified by:
    
    send in interface WebSocket
  - send
```
private boolean send(okio.ByteString data,
                     int formatOpcode)
```
  - pong
```
boolean pong(okio.ByteString payload)
```
  - close
```
public boolean close(int code,
                     java.lang.String reason)
```
    Description copied from interface: WebSocket
    
    Attempts to initiate a graceful shutdown of this web socket. Any already-enqueued messages will be transmitted before the close message is sent but subsequent calls to WebSocket.send(java.lang.String) will return false and their messages will not be enqueued.
    This returns true if a graceful shutdown was initiated by this call. It returns false and if a graceful shutdown was already underway or if the web socket is already closed or canceled.
    
    Specified by:
    
    close in interface WebSocket
    
    Parameters:
    
    code - Status code as defined by Section 7.4 of RFC 6455.
    
    reason - Reason for shutting down or null.
  - close
```
boolean close(int code,
              java.lang.String reason,
              long cancelAfterCloseMillis)
```
  - runWriter
```
private void runWriter()
```
  - writeOneFrame
```
boolean writeOneFrame()
               throws java.io.IOException
```
    Attempts to remove a single frame from a queue and send it. This prefers to write urgent pongs before less urgent messages and close frames. For example it's possible that a caller will enqueue messages followed by pongs, but this sends pongs followed by messages. Pongs are always written in the order they were enqueued.
    If a frame cannot be sent - because there are none enqueued or because the web socket is not connected - this does nothing and returns false. Otherwise this returns true and the caller should immediately invoke this method again until it returns false.
    This method may only be invoked by the writer thread. There may be only thread invoking this method at a time.
    
    Throws:
    
    java.io.IOException
  - writePingFrame
```
void writePingFrame()
```
  - failWebSocket
```
public void failWebSocket(java.lang.Exception e,
                          @Nullable
                          Response response)
```

Class RealWebSocket

Nested Class Summary

Nested classes/interfaces inherited from interface okhttp3.WebSocket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ONLY_HTTP1

MAX_QUEUE_SIZE

CANCEL_AFTER_CLOSE_MILLIS

originalRequest

listener

random

pingIntervalMillis

key

call

writerRunnable

reader

writer

executor

streams

pongQueue

messageAndCloseQueue

queueSize

enqueuedClose

cancelFuture

receivedCloseCode

receivedCloseReason

failed

sentPingCount

receivedPingCount

receivedPongCount

awaitingPong

Constructor Detail

RealWebSocket

Method Detail

request

queueSize

cancel

connect

checkResponse

initReaderAndWriter

loopReader

processNextFrame

awaitTermination

tearDown

sentPingCount

receivedPingCount

receivedPongCount

onReadMessage

onReadMessage

onReadPing

onReadPong

onReadClose

send

send

send

pong

close

close

runWriter

writeOneFrame

writePingFrame

failWebSocket