Interface ClientWebSocket

All Superinterfaces:

ReadStream<Buffer>, StreamBase, WebSocket, WebSocketBase, WriteStream<Buffer>

public interface ClientWebSocket
extends WebSocket

Represents a client-side WebSocket.

Author:

Tim Fox

Method Summary

Modifier and Type	Method	Description
ClientWebSocket	binaryMessageHandler(Handler<Buffer> handler)	Set a binary message handler on the connection.
ClientWebSocket	closeHandler(Handler<Void> handler)	Set a close handler.
default Future<WebSocket>	connect(int port, String host, String requestURI)	Connect this WebSocket to the specified port, host and relative request URI.
Future<WebSocket>	connect(WebSocketConnectOptions options)	Connect this WebSocket with the specified options.
default Future<WebSocket>	connect(String requestURI)	Connect this WebSocket at the relative request URI using the default host and port.
default Future<WebSocket>	connect(String host, String requestURI)	Connect this WebSocket to the host and relative request URI and default port.
ClientWebSocket	drainHandler(Handler<Void> handler)	Set a drain handler on the stream.
ClientWebSocket	endHandler(Handler<Void> endHandler)	Set an end handler.
ClientWebSocket	exceptionHandler(Handler<Throwable> handler)	Set an exception handler on the read stream.
ClientWebSocket	fetch(long amount)	Fetch the specified amount of elements.
ClientWebSocket	frameHandler(Handler<WebSocketFrame> handler)	Set a frame handler on the connection.
ClientWebSocket	handler(Handler<Buffer> handler)	Set a data handler.
ClientWebSocket	pause()	Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
ClientWebSocket	pongHandler(Handler<Buffer> handler)	Set a pong frame handler on the connection.
default ClientWebSocket	resume()	Resume reading, and sets the buffer in flowing mode.
ClientWebSocket	setWriteQueueMaxSize(int maxSize)	Set the maximum size of the write queue to maxSize.
ClientWebSocket	textMessageHandler(Handler<String> handler)	Set a text message handler on the connection.

Methods inherited from interface ReadStream

blockingStream, collect, pipe, pipeTo

Methods inherited from interface WebSocket

shutdownHandler

Methods inherited from interface WebSocketBase

binaryHandlerID, close, close, close, closeReason, closeStatusCode, end, headers, isClosed, isSsl, localAddress, peerCertificates, remoteAddress, shutdown, shutdown, shutdown, shutdown, shutdown, shutdown, shutdown, shutdown, shutdown, sslSession, subProtocol, textHandlerID, writeBinaryMessage, writeFinalBinaryFrame, writeFinalTextFrame, writeFrame, writePing, writePong, writeTextMessage

Methods inherited from interface WriteStream

end, write, writeQueueFull

Method Details

connect

Future<WebSocket> connect(WebSocketConnectOptions options)

Connect this WebSocket with the specified options.

Parameters:

options - the request options

Returns:

a future notified when the WebSocket when connected

connect

default Future<WebSocket> connect(int port,
 String host,
 String requestURI)

Connect this WebSocket to the specified port, host and relative request URI.

Parameters:

port - the port

host - the host

requestURI - the relative URI

Returns:

a future notified when the WebSocket when connected

connect

default Future<WebSocket> connect(String host,
 String requestURI)

Connect this WebSocket to the host and relative request URI and default port.

Parameters:

host - the host

requestURI - the relative URI

Returns:

a future notified when the WebSocket when connected

connect

default Future<WebSocket> connect(String requestURI)

Connect this WebSocket at the relative request URI using the default host and port.

Parameters:

requestURI - the relative URI

Returns:

a future notified when the WebSocket when connected

pause

ClientWebSocket pause()

Description copied from interface: ReadStream

Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

While it's paused, no data will be sent to the data handler.

Specified by:

pause in interface ReadStream<Buffer>

Specified by:

pause in interface WebSocket

Specified by:

pause in interface WebSocketBase

Returns:

a reference to this, so the API can be used fluently

resume

default ClientWebSocket resume()

Description copied from interface: ReadStream

Resume reading, and sets the buffer in flowing mode.

If the ReadStream has been paused, reading will recommence on it.

Specified by:

resume in interface ReadStream<Buffer>

Specified by:

resume in interface WebSocket

Specified by:

resume in interface WebSocketBase

Returns:

a reference to this, so the API can be used fluently

fetch

ClientWebSocket fetch(long amount)

Description copied from interface: ReadStream

Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.

Specified by:

fetch in interface ReadStream<Buffer>

Specified by:

fetch in interface WebSocket

Specified by:

fetch in interface WebSocketBase

Returns:

a reference to this, so the API can be used fluently

setWriteQueueMaxSize

ClientWebSocket setWriteQueueMaxSize(int maxSize)

Description copied from interface: WriteStream

Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize items in the write queue. This is used as an indicator by classes such as Pipe to provide flow control.

The value is defined by the implementation of the stream, e.g in bytes for a NetSocket, etc...

Specified by:

setWriteQueueMaxSize in interface WebSocket

Specified by:

setWriteQueueMaxSize in interface WebSocketBase

Specified by:

setWriteQueueMaxSize in interface WriteStream<Buffer>

Parameters:

maxSize - the max size of the write stream

Returns:

a reference to this, so the API can be used fluently

handler

ClientWebSocket handler(Handler<Buffer> handler)

Description copied from interface: ReadStream

Set a data handler. As data is read, the handler will be called with the data.

Specified by:

handler in interface ReadStream<Buffer>

Specified by:

handler in interface WebSocket

Specified by:

handler in interface WebSocketBase

Returns:

a reference to this, so the API can be used fluently

endHandler

ClientWebSocket endHandler(Handler<Void> endHandler)

Description copied from interface: ReadStream

Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

Specified by:

endHandler in interface ReadStream<Buffer>

Specified by:

endHandler in interface WebSocket

Specified by:

endHandler in interface WebSocketBase

Returns:

a reference to this, so the API can be used fluently

drainHandler

ClientWebSocket drainHandler(Handler<Void> handler)

Description copied from interface: WriteStream

Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue is ready to accept buffers again. See Pipe for an example of this being used.

The stream implementation defines when the drain handler, for example it could be when the queue size has been reduced to maxSize / 2.

Specified by:

drainHandler in interface WebSocket

Specified by:

drainHandler in interface WebSocketBase

Specified by:

drainHandler in interface WriteStream<Buffer>

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

closeHandler

ClientWebSocket closeHandler(Handler<Void> handler)

Description copied from interface: WebSocketBase

Set a close handler. This will be called when the WebSocket is closed.

After this callback, no more messages are expected. When the WebSocket received a close frame, the WebSocketBase.closeStatusCode() will return the status code and WebSocketBase.closeReason() will return the reason.

Specified by:

closeHandler in interface WebSocket

Specified by:

closeHandler in interface WebSocketBase

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

frameHandler

ClientWebSocket frameHandler(Handler<WebSocketFrame> handler)

Description copied from interface: WebSocketBase

Set a frame handler on the connection. This handler will be called when frames are read on the connection.

Specified by:

frameHandler in interface WebSocket

Specified by:

frameHandler in interface WebSocketBase

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

textMessageHandler

ClientWebSocket textMessageHandler(Handler<String> handler)

Description copied from interface: WebSocketBase

Set a text message handler on the connection. This handler will be called similar to the WebSocketBase.binaryMessageHandler(Handler), but the buffer will be converted to a String first

Specified by:

textMessageHandler in interface WebSocket

Specified by:

textMessageHandler in interface WebSocketBase

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

binaryMessageHandler

ClientWebSocket binaryMessageHandler(Handler<Buffer> handler)

Description copied from interface: WebSocketBase

Set a binary message handler on the connection. This handler serves a similar purpose to WebSocketBase.handler(Handler) except that if a message comes into the socket in multiple frames, the data from the frames will be aggregated into a single buffer before calling the handler (using WebSocketFrame.isFinal() to find the boundaries).

Specified by:

binaryMessageHandler in interface WebSocket

Specified by:

binaryMessageHandler in interface WebSocketBase

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

pongHandler

ClientWebSocket pongHandler(Handler<Buffer> handler)

Description copied from interface: WebSocketBase

Set a pong frame handler on the connection. This handler will be invoked every time a pong frame is received on the server, and can be used by both clients and servers since the RFC 6455 section 5.5.2 and section 5.5.3 do not specify whether the client or server sends a ping.

Pong frames may be at most 125 bytes (octets).

There is no ping handler since ping frames should immediately be responded to with a pong frame with identical content

Pong frames may be received unsolicited.

Specified by:

pongHandler in interface WebSocket

Specified by:

pongHandler in interface WebSocketBase

Parameters:

handler - the handler

Returns:

a reference to this, so the API can be used fluently

exceptionHandler

ClientWebSocket exceptionHandler(Handler<Throwable> handler)

Description copied from interface: ReadStream

Set an exception handler on the read stream.

Specified by:

exceptionHandler in interface ReadStream<Buffer>

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WebSocket

Specified by:

exceptionHandler in interface WebSocketBase

Specified by:

exceptionHandler in interface WriteStream<Buffer>

Parameters:

handler - the exception handler

Returns:

a reference to this, so the API can be used fluently