okhttp3.internal.ws

Class RealWebSocket

java.lang.Object

okhttp3.internal.ws.RealWebSocket

All Implemented Interfaces:

WebSocketReader.FrameCallback, WebSocket

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RealWebSocket.Streams

Nested classes/interfaces inherited from interface okhttp3.WebSocket

WebSocket.Factory

Constructor Summary

Constructors

Constructor and Description
RealWebSocket(Request request, WebSocketListener listener, Random random)

Method Summary

Modifier and Type	Method and Description
void	cancel() Immediately and violently release resources held by this web socket, discarding any enqueued messages.
boolean	close(int code, String reason) Attempts to initiate a graceful shutdown of this web socket.
void	connect(OkHttpClient client)
void	failWebSocket(Exception e, Response response)
void	initReaderAndWriter(String name, long pingIntervalMillis, RealWebSocket.Streams streams)
void	loopReader() Receive frames until there are no more.
void	onReadClose(int code, String reason)
void	onReadMessage(okio.ByteString bytes)
void	onReadMessage(String text)
void	onReadPing(okio.ByteString payload)
void	onReadPong(okio.ByteString buffer)
long	queueSize() Returns the size in bytes of all messages enqueued to be transmitted to the server.
Request	request() Returns the original request that initiated this web socket.
boolean	send(okio.ByteString bytes) Attempts to enqueue bytes to be sent as a the data of a binary (type 0x2) message.
boolean	send(String text) Attempts to enqueue text to be UTF-8 encoded and sent as a the data of a text (type 0x1) message.

Methods inherited from class java.lang.Object

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

Constructor Detail

RealWebSocket

public RealWebSocket(Request request,
                     WebSocketListener listener,
                     Random random)

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)

initReaderAndWriter

public void initReaderAndWriter(String name,
                                long pingIntervalMillis,
                                RealWebSocket.Streams streams)
                         throws IOException

Throws:

IOException

loopReader

public void loopReader()
                throws IOException

Receive frames until there are no more. Invoked only by the reader thread.

Throws:

IOException

onReadMessage

public void onReadMessage(String text)
                   throws IOException

Specified by:

onReadMessage in interface WebSocketReader.FrameCallback

Throws:

IOException

onReadMessage

public void onReadMessage(okio.ByteString bytes)
                   throws IOException

Specified by:

onReadMessage in interface WebSocketReader.FrameCallback

Throws:

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,
                        String reason)

Specified by:

onReadClose in interface WebSocketReader.FrameCallback

send

public boolean send(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 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

close

public boolean close(int code,
                     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 or 0.

reason - Reason for shutting down or null.

failWebSocket

public void failWebSocket(Exception e,
                          Response response)