Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	WebSocketImpl.ReceiveTask
private class	WebSocketImpl.SignallingMessageConsumer
pack-priv static enum	WebSocketImpl.State

Field Summary

Modifier and Type	Field and Description
private ByteBuffer	binaryData
private final Executor	clientExecutor
private static final Logger	debug
private final Demand	demand
private final MinimalFuture<WebSocket>	DONE
private final AtomicReference<Throwable>	error
private volatile boolean	inputClosed
private boolean	last
private final AtomicReference<ByteBuffer>	lastAutomaticPong
private final WebSocket.Listener	listener
private final AtomicBoolean	outputClosed
private final AtomicBoolean	pendingPingOrPong
private final AtomicBoolean	pendingTextOrBinary
private String	reason
private final AtomicLong	receiveCounter
private final SequentialScheduler	receiveScheduler
private final AtomicLong	sendCounter
private final AtomicReference<WebSocketImpl.State>	state
private int	statusCode
private final String	subprotocol
private CharSequence	text
private final Transport	transport
private final URI	uri

Constructor Summary

Access	Constructor and Description
private	WebSocketImpl(URI uri, HttpClient client, String subprotocol, WebSocket.Listener listener, TransportFactory transportFactory)

Method Summary

Modifier and Type	Method and Description
public void	abort() Implements java.net.http.WebSocket.abort. Closes this WebSocket's input and output abruptly.
private ByteBuffer	clearAutomaticPong()
private void	clearPendingPingOrPong()
private void	clearPendingTextOrBinary()
private void	close()
public String	getSubprotocol() Implements java.net.http.WebSocket.getSubprotocol. Returns the subprotocol used by this WebSocket.
public boolean	isInputClosed() Implements java.net.http.WebSocket.isInputClosed. Tells whether this WebSocket's input is closed.
private static boolean	isLegalReason(String reason)
public boolean	isOutputClosed() Implements java.net.http.WebSocket.isOutputClosed. Tells whether this WebSocket's output is closed.
pack-priv static WebSocketImpl	newInstance(URI uri, HttpClient client, String subprotocol, WebSocket.Listener listener, TransportFactory transport)
public static CompletableFuture<WebSocket>	newInstanceAsync(BuilderImpl b)
private void	processCloseError(Throwable e)
private CompletableFuture<WebSocket>	replaceNull(CompletableFuture<WebSocket> cf)
public void	request(long n) Implements java.net.http.WebSocket.request. Increments the counter of invocations of receive methods.
public CompletableFuture<WebSocket>	sendBinary(ByteBuffer message, boolean last) Implements java.net.http.WebSocket.sendBinary. Sends binary data with bytes from the given buffer.
public CompletableFuture<WebSocket>	sendClose(int statusCode, String reason) Implements java.net.http.WebSocket.sendClose. Initiates an orderly closure of this WebSocket's output by sending a Close message with the given status code and the reason.
private CompletableFuture<WebSocket>	sendClose0(int statusCode, String reason)
private void	sendCloseSilently(int statusCode)
public CompletableFuture<WebSocket>	sendPing(ByteBuffer message) Implements java.net.http.WebSocket.sendPing. Sends a Ping message with bytes from the given buffer.
public CompletableFuture<WebSocket>	sendPong(ByteBuffer message) Implements java.net.http.WebSocket.sendPong. Sends a Pong message with bytes from the given buffer.
public CompletableFuture<WebSocket>	sendText(CharSequence message, boolean last) Implements java.net.http.WebSocket.sendText. Sends textual data with characters from the given character sequence.
private boolean	setPendingPingOrPong()
private boolean	setPendingTextOrBinary()
private void	signalClose(int statusCode, String reason)
private void	signalError(Throwable error)
private void	signalOpen()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected Transport	transport()
private boolean	tryChangeState(WebSocketImpl.State expectedState, WebSocketImpl.State newState)
private boolean	trySetState(WebSocketImpl.State newState)
private boolean	trySwapAutomaticPong(ByteBuffer copy)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

binaryData	back to summary
private ByteBuffer binaryData

clientExecutor	back to summary
private final Executor clientExecutor

debug	back to summary
private static final Logger debug

demand	back to summary
private final Demand demand

DONE	back to summary
private final MinimalFuture<WebSocket> DONE

error	back to summary
private final AtomicReference<Throwable> error

inputClosed	back to summary
private volatile boolean inputClosed

last	back to summary
private boolean last

lastAutomaticPong	back to summary
private final AtomicReference<ByteBuffer> lastAutomaticPong

listener	back to summary
private final WebSocket.Listener listener

outputClosed	back to summary
private final AtomicBoolean outputClosed

pendingPingOrPong	back to summary
private final AtomicBoolean pendingPingOrPong

pendingTextOrBinary	back to summary
private final AtomicBoolean pendingTextOrBinary

reason	back to summary
private String reason

receiveCounter	back to summary
private final AtomicLong receiveCounter

receiveScheduler	back to summary
private final SequentialScheduler receiveScheduler

sendCounter	back to summary
private final AtomicLong sendCounter

state	back to summary
private final AtomicReference<WebSocketImpl.State> state

statusCode	back to summary
private int statusCode

subprotocol	back to summary
private final String subprotocol

text	back to summary
private CharSequence text

transport	back to summary
private final Transport transport

uri	back to summary
private final URI uri

Constructor Detail

WebSocketImpl	back to summary
private WebSocketImpl(URI uri, HttpClient client, String subprotocol, WebSocket.Listener listener, TransportFactory transportFactory)

Method Detail

abort back to summary

abort	back to summary
public void abort() Implements java.net.http.WebSocket.abort. Doc from java.net.http.WebSocket.abort. Closes this WebSocket's input and output abruptly. When this method returns both the input and the output will have been closed. Any pending send operations will fail with `IOException`. Subsequent invocations of `abort` will have no effect. Annotations @Override

public void abort()

Implements java.net.http.WebSocket.abort.

Doc from java.net.http.WebSocket.abort.

Closes this WebSocket's input and output abruptly.

When this method returns both the input and the output will have been closed. Any pending send operations will fail with IOException. Subsequent invocations of abort will have no effect.

Annotations

@Override

clearAutomaticPong	back to summary
private ByteBuffer clearAutomaticPong()

clearPendingPingOrPong	back to summary
private void clearPendingPingOrPong()

clearPendingTextOrBinary	back to summary
private void clearPendingTextOrBinary()

close	back to summary
private void close()

getSubprotocol	back to summary
public String getSubprotocol() Implements java.net.http.WebSocket.getSubprotocol. Doc from java.net.http.WebSocket.getSubprotocol. Returns the subprotocol used by this WebSocket. Annotations @Override

getSubprotocol

back to summary

public String getSubprotocol()

Implements java.net.http.WebSocket.getSubprotocol.

Doc from java.net.http.WebSocket.getSubprotocol.

Returns the subprotocol used by this WebSocket.

Annotations

@Override

isInputClosed back to summary

isInputClosed	back to summary
public boolean isInputClosed() Implements java.net.http.WebSocket.isInputClosed. Doc from java.net.http.WebSocket.isInputClosed. Tells whether this WebSocket's input is closed. If this method returns `true`, subsequent invocations will also return `true`. Annotations @Override

public boolean isInputClosed()

Implements java.net.http.WebSocket.isInputClosed.

Doc from java.net.http.WebSocket.isInputClosed.

Tells whether this WebSocket's input is closed.

If this method returns true, subsequent invocations will also return true.

Annotations

@Override

isLegalReason	back to summary
private static boolean isLegalReason(String reason)

isOutputClosed back to summary

isOutputClosed	back to summary
public boolean isOutputClosed() Implements java.net.http.WebSocket.isOutputClosed. Doc from java.net.http.WebSocket.isOutputClosed. Tells whether this WebSocket's output is closed. If this method returns `true`, subsequent invocations will also return `true`. Annotations @Override

public boolean isOutputClosed()

Implements java.net.http.WebSocket.isOutputClosed.

Doc from java.net.http.WebSocket.isOutputClosed.

Tells whether this WebSocket's output is closed.

If this method returns true, subsequent invocations will also return true.

Annotations

@Override

newInstance	back to summary
pack-priv static WebSocketImpl newInstance(URI uri, HttpClient client, String subprotocol, WebSocket.Listener listener, TransportFactory transport)

newInstanceAsync	back to summary
public static CompletableFuture<WebSocket> newInstanceAsync(BuilderImpl b)

processCloseError	back to summary
private void processCloseError(Throwable e)

replaceNull	back to summary
private CompletableFuture<WebSocket> replaceNull(CompletableFuture<WebSocket> cf)

request back to summary

request	back to summary
public void request(long n) Implements java.net.http.WebSocket.request. Doc from java.net.http.WebSocket.request. Increments the counter of invocations of receive methods. This WebSocket will invoke `onText`, `onBinary`, `onPing`, `onPong` or `onClose` methods on the associated listener (i.e. receive methods) up to `n` more times. Annotations @Override

public void request(long n)

Implements java.net.http.WebSocket.request.

Doc from java.net.http.WebSocket.request.

Increments the counter of invocations of receive methods.

This WebSocket will invoke onText, onBinary, onPing, onPong or onClose methods on the associated listener (i.e. receive methods) up to n more times.

Annotations

@Override

sendBinary back to summary

sendBinary	back to summary
public CompletableFuture<WebSocket> sendBinary(ByteBuffer message, boolean last) Implements java.net.http.WebSocket.sendBinary. Doc from java.net.http.WebSocket.sendBinary. Sends binary data with bytes from the given buffer. The data is located in bytes from the buffer's position to its limit. Upon normal completion of a `CompletableFuture` returned from this method the buffer will have no remaining bytes. The buffer must not be accessed until after that. The `CompletableFuture` returned from this method can complete exceptionally with: `IllegalStateException` - if there is a pending text or binary send operation or if the previous textual data does not complete the message `IOException` - if an I/O error occurs, or if the output is closed Annotations @Override

public CompletableFuture<WebSocket> sendBinary(ByteBuffer message, boolean last)

Implements java.net.http.WebSocket.sendBinary.

Doc from java.net.http.WebSocket.sendBinary.

Sends binary data with bytes from the given buffer.

The data is located in bytes from the buffer's position to its limit. Upon normal completion of a CompletableFuture returned from this method the buffer will have no remaining bytes. The buffer must not be accessed until after that.

The CompletableFuture returned from this method can complete exceptionally with:

IllegalStateException - if there is a pending text or binary send operation or if the previous textual data does not complete the message
IOException - if an I/O error occurs, or if the output is closed

Annotations

@Override

sendClose back to summary

sendClose	back to summary
public CompletableFuture<WebSocket> sendClose(int statusCode, String reason) Implements java.net.http.WebSocket.sendClose. Doc from java.net.http.WebSocket.sendClose. Initiates an orderly closure of this WebSocket's output by sending a Close message with the given status code and the reason. The `statusCode` is an integer from the range `1000 <= code <= 4999`. Status codes `1002`, `1003`, `1006`, `1007`, `1009`, `1010`, `1012`, `1013` and `1015` are illegal. Behaviour in respect to other status codes is implementation-specific. A legal `reason` is a string that has a UTF-8 representation not longer than `123` bytes. A `CompletableFuture` returned from this method can complete exceptionally with: `IllegalArgumentException` - if `statusCode` is illegal, or if `reason` is illegal `IOException` - if an I/O error occurs, or if the output is closed Unless the `CompletableFuture` returned from this method completes with `IllegalArgumentException`, or the method throws `NullPointerException`, the output will be closed. If not already closed, the input remains open until a Close message received, or `abort` is invoked, or an error occurs. Annotations @Override

public CompletableFuture<WebSocket> sendClose(int statusCode, String reason)

Implements java.net.http.WebSocket.sendClose.

Doc from java.net.http.WebSocket.sendClose.

Initiates an orderly closure of this WebSocket's output by sending a Close message with the given status code and the reason.

The statusCode is an integer from the range 1000 <= code <= 4999. Status codes 1002, 1003, 1006, 1007, 1009, 1010, 1012, 1013 and 1015 are illegal. Behaviour in respect to other status codes is implementation-specific. A legal reason is a string that has a UTF-8 representation not longer than 123 bytes.

A CompletableFuture returned from this method can complete exceptionally with:

IllegalArgumentException - if statusCode is illegal, or if reason is illegal
IOException - if an I/O error occurs, or if the output is closed

Unless the CompletableFuture returned from this method completes with IllegalArgumentException, or the method throws NullPointerException, the output will be closed.

If not already closed, the input remains open until a Close message received, or abort is invoked, or an error occurs.

Annotations

@Override

sendClose0	back to summary
private CompletableFuture<WebSocket> sendClose0(int statusCode, String reason)

sendCloseSilently	back to summary
private void sendCloseSilently(int statusCode)

sendPing back to summary

sendPing	back to summary
public CompletableFuture<WebSocket> sendPing(ByteBuffer message) Implements java.net.http.WebSocket.sendPing. Doc from java.net.http.WebSocket.sendPing. Sends a Ping message with bytes from the given buffer. The message consists of not more than `125` bytes from the buffer's position to its limit. Upon normal completion of a `CompletableFuture` returned from this method the buffer will have no remaining bytes. The buffer must not be accessed until after that. The `CompletableFuture` returned from this method can complete exceptionally with: `IllegalStateException` - if there is a pending ping or pong send operation `IllegalArgumentException` - if the message is too long `IOException` - if an I/O error occurs, or if the output is closed Annotations @Override

public CompletableFuture<WebSocket> sendPing(ByteBuffer message)

Implements java.net.http.WebSocket.sendPing.

Doc from java.net.http.WebSocket.sendPing.

Sends a Ping message with bytes from the given buffer.

The message consists of not more than 125 bytes from the buffer's position to its limit. Upon normal completion of a CompletableFuture returned from this method the buffer will have no remaining bytes. The buffer must not be accessed until after that.

The CompletableFuture returned from this method can complete exceptionally with:

IllegalStateException - if there is a pending ping or pong send operation
IllegalArgumentException - if the message is too long
IOException - if an I/O error occurs, or if the output is closed

Annotations

@Override

sendPong back to summary

sendPong	back to summary
public CompletableFuture<WebSocket> sendPong(ByteBuffer message) Implements java.net.http.WebSocket.sendPong. Doc from java.net.http.WebSocket.sendPong. Sends a Pong message with bytes from the given buffer. The message consists of not more than `125` bytes from the buffer's position to its limit. Upon normal completion of a `CompletableFuture` returned from this method the buffer will have no remaining bytes. The buffer must not be accessed until after that. Given that the WebSocket implementation will automatically send a reciprocal pong when a ping is received, it is rarely required to send a pong message explicitly. The `CompletableFuture` returned from this method can complete exceptionally with: `IllegalStateException` - if there is a pending ping or pong send operation `IllegalArgumentException` - if the message is too long `IOException` - if an I/O error occurs, or if the output is closed Annotations @Override

public CompletableFuture<WebSocket> sendPong(ByteBuffer message)

Implements java.net.http.WebSocket.sendPong.

Doc from java.net.http.WebSocket.sendPong.

Sends a Pong message with bytes from the given buffer.

Given that the WebSocket implementation will automatically send a reciprocal pong when a ping is received, it is rarely required to send a pong message explicitly.

The CompletableFuture returned from this method can complete exceptionally with:

IllegalStateException - if there is a pending ping or pong send operation
IllegalArgumentException - if the message is too long
IOException - if an I/O error occurs, or if the output is closed

Annotations

@Override

sendText back to summary

sendText	back to summary
public CompletableFuture<WebSocket> sendText(CharSequence message, boolean last) Implements java.net.http.WebSocket.sendText. Doc from java.net.http.WebSocket.sendText. Sends textual data with characters from the given character sequence. The character sequence must not be modified until the `CompletableFuture` returned from this method has completed. A `CompletableFuture` returned from this method can complete exceptionally with: `IllegalStateException` - if there is a pending text or binary send operation or if the previous binary data does not complete the message `IOException` - if an I/O error occurs, or if the output is closed Annotations @Override

public CompletableFuture<WebSocket> sendText(CharSequence message, boolean last)

Implements java.net.http.WebSocket.sendText.

Doc from java.net.http.WebSocket.sendText.

Sends textual data with characters from the given character sequence.

The character sequence must not be modified until the CompletableFuture returned from this method has completed.

A CompletableFuture returned from this method can complete exceptionally with:

IllegalStateException - if there is a pending text or binary send operation or if the previous binary data does not complete the message
IOException - if an I/O error occurs, or if the output is closed

Annotations

@Override

setPendingPingOrPong	back to summary
private boolean setPendingPingOrPong()

setPendingTextOrBinary	back to summary
private boolean setPendingTextOrBinary()

signalClose	back to summary
private void signalClose(int statusCode, String reason)

signalError	back to summary
private void signalError(Throwable error)

signalOpen	back to summary
private void signalOpen()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

transport	back to summary
protected Transport transport()

tryChangeState	back to summary
private boolean tryChangeState(WebSocketImpl.State expectedState, WebSocketImpl.State newState)

trySetState	back to summary
private boolean trySetState(WebSocketImpl.State newState)

trySwapAutomaticPong	back to summary
private boolean trySwapAutomaticPong(ByteBuffer copy)

jdk.internal.net.http.websocket back to summary

private Class WebSocketImpl.ReceiveTask

Class Inheritance

extends CompleteRestartableTask

java.lang.Object
jdk.internal.net.http.common.SequentialScheduler.CompleteRestartableTask
jdk.internal.net.http.websocket.WebSocketImpl.ReceiveTask

Constructor Summary

Access	Constructor and Description
private	ReceiveTask()

Method Summary

Modifier and Type	Method and Description
private void	processBinary()
private void	processClose()
private void	processError()
private void	processOpen()
private void	processPing()
private void	processPong()
private void	processText()
public void	run() Implements abstract jdk.internal.net.http.common.SequentialScheduler.CompleteRestartableTask.run. The body of the task.

Inherited from jdk.internal.net.http.common.SequentialScheduler.CompleteRestartableTask:: run

Constructor Detail

ReceiveTask	back to summary
private ReceiveTask()

Method Detail

processBinary	back to summary
private void processBinary()

processClose	back to summary
private void processClose() throws IOException

processError	back to summary
private void processError() throws IOException

processOpen	back to summary
private void processOpen()

processPing	back to summary
private void processPing()

processPong	back to summary
private void processPong()

processText	back to summary
private void processText()

run

back to summary

public void run()

Implements abstract jdk.internal.net.http.common.SequentialScheduler.CompleteRestartableTask.run.

Doc from jdk.internal.net.http.common.SequentialScheduler.CompleteRestartableTask.run.

The body of the task.

Annotations

@Override

jdk.internal.net.http.websocket back to summary

private Class WebSocketImpl.SignallingMessageConsumer

Class Inheritance

extends Object
implements MessageStreamConsumer

java.lang.Object
jdk.internal.net.http.websocket.WebSocketImpl.SignallingMessageConsumer

All Implemented Interfaces

jdk.internal.net.http.websocket.MessageStreamConsumer

Constructor Summary

Access	Constructor and Description
private	SignallingMessageConsumer()

Method Summary

Modifier and Type	Method and Description
public void	onBinary(ByteBuffer data, boolean last) Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onBinary.
public void	onClose(int statusCode, CharSequence reason) Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onClose.
public void	onComplete() Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onComplete.
public void	onError(Throwable error) Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onError.
public void	onPing(ByteBuffer data) Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onPing.
public void	onPong(ByteBuffer data) Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onPong.
public void	onText(CharSequence data, boolean last) Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onText.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

SignallingMessageConsumer	back to summary
private SignallingMessageConsumer()

Method Detail

onBinary

back to summary

public void onBinary(ByteBuffer data, boolean last)

Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onBinary.

Annotations

@Override

onClose

back to summary

public void onClose(int statusCode, CharSequence reason)

Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onClose.

Annotations

@Override

onComplete

back to summary

public void onComplete()

Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onComplete.

Annotations

@Override

onError

back to summary

public void onError(Throwable error)

Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onError.

Annotations

@Override

onPing

back to summary

public void onPing(ByteBuffer data)

Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onPing.

Annotations

@Override

onPong

back to summary

public void onPong(ByteBuffer data)

Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onPong.

Annotations

@Override

onText

back to summary

public void onText(CharSequence data, boolean last)

Implements jdk.internal.net.http.websocket.MessageStreamConsumer.onText.

Annotations

@Override

jdk.internal.net.http.websocket back to summary

pack-priv final Enum WebSocketImpl.State

Class Inheritance

extends Enum<WebSocketImpl.State>

java.lang.Object
java.lang.Enum
jdk.internal.net.http.websocket.WebSocketImpl.State

Field Summary

Modifier and Type	Field and Description
public static final WebSocketImpl.State	BINARY
public static final WebSocketImpl.State	CLOSE
public static final WebSocketImpl.State	ERROR
public static final WebSocketImpl.State	IDLE
public static final WebSocketImpl.State	OPEN
public static final WebSocketImpl.State	PING
public static final WebSocketImpl.State	PONG
public static final WebSocketImpl.State	TEXT
public static final WebSocketImpl.State	WAITING

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static WebSocketImpl.State	valueOf(String name)
public static WebSocketImpl.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BINARY	back to summary
public static final WebSocketImpl.State BINARY

CLOSE	back to summary
public static final WebSocketImpl.State CLOSE

ERROR	back to summary
public static final WebSocketImpl.State ERROR

IDLE	back to summary
public static final WebSocketImpl.State IDLE

OPEN	back to summary
public static final WebSocketImpl.State OPEN

PING	back to summary
public static final WebSocketImpl.State PING

PONG	back to summary
public static final WebSocketImpl.State PONG

TEXT	back to summary
public static final WebSocketImpl.State TEXT

WAITING	back to summary
public static final WebSocketImpl.State WAITING

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static WebSocketImpl.State valueOf(String name)

values	back to summary
public static WebSocketImpl.State[] values()

public final Class WebSocketImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WebSocketImpl.ReceiveTask

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class WebSocketImpl.SignallingMessageConsumer

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv final Enum WebSocketImpl.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail