Package io.vertx.reactivex.core.http

Class ClientWebSocket

java.lang.Object

io.vertx.reactivex.core.http.WebSocket

io.vertx.reactivex.core.http.ClientWebSocket

All Implemented Interfaces:

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

public class ClientWebSocket
extends WebSocket

Represents a client-side WebSocket initially not connected.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field	Description
static TypeArg<ClientWebSocket>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
ClientWebSocket(ClientWebSocket delegate)
ClientWebSocket(Object delegate)

Method Summary

Modifier and Type	Method	Description
String	binaryHandlerID()	When a WebSocket is created, it may register an event handler with the event bus - the ID of that handler is given by this method.
ClientWebSocket	binaryMessageHandler(Handler<Buffer> handler)	Set a binary message handler on the connection.
void	close()	Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
void	close(short statusCode)	Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
void	close(short statusCode, Handler<AsyncResult<Void>> handler)	Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
void	close(short statusCode, String reason)	Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
void	close(short statusCode, String reason, Handler<AsyncResult<Void>> handler)	Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
void	close(Handler<AsyncResult<Void>> handler)	Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	closeHandler(Handler<Void> handler)	Set a close handler.
String	closeReason()	Returns the close reason message from the remote endpoint or null when not yet received.
Short	closeStatusCode()	Returns the close status code received from the remote endpoint or null when not yet received.
void	connect(int port, String host, String requestURI)	Connect a WebSocket to the specified port, host and relative request URI
void	connect(int port, String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)	Connect a WebSocket to the specified port, host and relative request URI
void	connect(WebSocketConnectOptions options)	Connect a WebSocket with the specified options.
void	connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)	Connect a WebSocket with the specified options.
void	connect(String requestURI)	Connect this WebSocket at the relative request URI using the default host and port.
void	connect(String requestURI, Handler<AsyncResult<WebSocket>> handler)	Connect this WebSocket at the relative request URI using the default host and port.
void	connect(String host, String requestURI)	Connect this WebSocket to the host and relative request URI and default port.
void	connect(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)	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.
void	end()	Calls WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
void	end(Handler<AsyncResult<Void>> handler)	Calls WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
void	end(Buffer data)	Same as but with an handler called when the operation completes
void	end(Buffer data, Handler<AsyncResult<Void>> handler)	Same as but with an handler called when the operation completes
ClientWebSocket	endHandler(Handler<Void> endHandler)	Set an end handler.
boolean	equals(Object o)
ClientWebSocket	exceptionHandler(Handler<Throwable> handler)	Set an exception handler on the read stream.
ClientWebSocket	frameHandler(Handler<WebSocketFrame> handler)	Set a frame handler on the connection.
ClientWebSocket	getDelegate()
ClientWebSocket	handler(Handler<Buffer> handler)	Set a data handler.
int	hashCode()
MultiMap	headers()	Returns the HTTP headers when the WebSocket is first obtained in the handler.
boolean	isClosed()
boolean	isSsl()
SocketAddress	localAddress()
static ClientWebSocket	newInstance(ClientWebSocket arg)
Pipe<Buffer>	pipe()	Pause this stream and return a to transfer the elements of this stream to a destination .
void	pipeTo(WriteStream<Buffer> dst)	Pipe this ReadStream to the WriteStream.
void	pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)	Pipe this ReadStream to the WriteStream.
ClientWebSocket	pongHandler(Handler<Buffer> handler)	Set a pong frame handler on the connection.
SocketAddress	remoteAddress()
io.reactivex.Completable	rxClose()	Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
io.reactivex.Completable	rxClose(short statusCode)	Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
io.reactivex.Completable	rxClose(short statusCode, String reason)	Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
io.reactivex.Single<WebSocket>	rxConnect(int port, String host, String requestURI)	Connect a WebSocket to the specified port, host and relative request URI
io.reactivex.Single<WebSocket>	rxConnect(WebSocketConnectOptions options)	Connect a WebSocket with the specified options.
io.reactivex.Single<WebSocket>	rxConnect(String requestURI)	Connect this WebSocket at the relative request URI using the default host and port.
io.reactivex.Single<WebSocket>	rxConnect(String host, String requestURI)	Connect this WebSocket to the host and relative request URI and default port.
io.reactivex.Completable	rxEnd()	Calls WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
io.reactivex.Completable	rxEnd(Buffer data)	Same as but with an handler called when the operation completes
io.reactivex.Completable	rxPipeTo(WriteStream<Buffer> dst)	Pipe this ReadStream to the WriteStream.
io.reactivex.Completable	rxWrite(Buffer data)	Same as but with an handler called when the operation completes
io.reactivex.Completable	rxWriteBinaryMessage(Buffer data)	Same as WebSocketBase.writeBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
io.reactivex.Completable	rxWriteFinalBinaryFrame(Buffer data)	Same as WebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
io.reactivex.Completable	rxWriteFinalTextFrame(String text)	Same as WebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
io.reactivex.Completable	rxWriteFrame(WebSocketFrame frame)	Same as WebSocketBase.writeFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
io.reactivex.Completable	rxWritePing(Buffer data)	Writes a ping frame to the connection.
io.reactivex.Completable	rxWritePong(Buffer data)	Writes a pong frame to the connection.
io.reactivex.Completable	rxWriteTextMessage(String text)	Same as WebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
SSLSession	sslSession()
String	subProtocol()	Returns the WebSocket sub protocol selected by the WebSocket handshake.
String	textHandlerID()	When a WebSocket is created, it may register an event handler with the eventbus, the ID of that handler is given by textHandlerID.
ClientWebSocket	textMessageHandler(Handler<String> handler)	Set a text message handler on the connection.
io.reactivex.Flowable<Buffer>	toFlowable()
io.reactivex.Observable<Buffer>	toObservable()
WriteStreamObserver<Buffer>	toObserver()
String	toString()
WriteStreamSubscriber<Buffer>	toSubscriber()
void	write(Buffer data)	Same as but with an handler called when the operation completes
void	write(Buffer data, Handler<AsyncResult<Void>> handler)	Same as but with an handler called when the operation completes
ClientWebSocket	writeBinaryMessage(Buffer data)	Same as WebSocketBase.writeBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)	Same as WebSocketBase.writeBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	writeFinalBinaryFrame(Buffer data)	Same as WebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)	Same as WebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	writeFinalTextFrame(String text)	Same as WebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)	Same as WebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	writeFrame(WebSocketFrame frame)	Same as WebSocketBase.writeFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)	Same as WebSocketBase.writeFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	writePing(Buffer data)	Writes a ping frame to the connection.
ClientWebSocket	writePing(Buffer data, Handler<AsyncResult<Void>> handler)	Writes a ping frame to the connection.
ClientWebSocket	writePong(Buffer data)	Writes a pong frame to the connection.
ClientWebSocket	writePong(Buffer data, Handler<AsyncResult<Void>> handler)	Writes a pong frame to the connection.
boolean	writeQueueFull()	This will return true if there are more bytes in the write queue than the value set using WebSocket.setWriteQueueMaxSize(int)
ClientWebSocket	writeTextMessage(String text)	Same as WebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
ClientWebSocket	writeTextMessage(String text, Handler<AsyncResult<Void>> handler)	Same as WebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Methods inherited from class io.vertx.reactivex.core.http.WebSocket

fetch, newInstance, pause, resume, setWriteQueueMaxSize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<ClientWebSocket> __TYPE_ARG

Constructor Detail

ClientWebSocket

public ClientWebSocket(ClientWebSocket delegate)

ClientWebSocket

public ClientWebSocket(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class WebSocket

equals

public boolean equals(Object o)

Overrides:

equals in class WebSocket

hashCode

public int hashCode()

Overrides:

hashCode in class WebSocket

getDelegate

public ClientWebSocket getDelegate()

Specified by:

getDelegate in interface ReadStream<Buffer>

Specified by:

getDelegate in interface StreamBase

Specified by:

getDelegate in interface WebSocketBase

Specified by:

getDelegate in interface WriteStream<Buffer>

Overrides:

getDelegate in class WebSocket

toObservable

public io.reactivex.Observable<Buffer> toObservable()

Specified by:

toObservable in interface ReadStream<Buffer>

Overrides:

toObservable in class WebSocket

toFlowable

public io.reactivex.Flowable<Buffer> toFlowable()

Specified by:

toFlowable in interface ReadStream<Buffer>

Overrides:

toFlowable in class WebSocket

toObserver

public WriteStreamObserver<Buffer> toObserver()

Overrides:

toObserver in class WebSocket

toSubscriber

public WriteStreamSubscriber<Buffer> toSubscriber()

Overrides:

toSubscriber in class WebSocket

write

public void write(Buffer data,
                  Handler<AsyncResult<Void>> handler)

Same as but with an handler called when the operation completes

Specified by:

write in interface WebSocketBase

Specified by:

write in interface WriteStream<Buffer>

Overrides:

write in class WebSocket

Parameters:

data -

handler -

write

public void write(Buffer data)

Same as but with an handler called when the operation completes

Specified by:

write in interface WebSocketBase

Specified by:

write in interface WriteStream<Buffer>

Overrides:

write in class WebSocket

Parameters:

data -

rxWrite

public io.reactivex.Completable rxWrite(Buffer data)

Same as but with an handler called when the operation completes

Specified by:

rxWrite in interface WebSocketBase

Specified by:

rxWrite in interface WriteStream<Buffer>

Overrides:

rxWrite in class WebSocket

Parameters:

data -

Returns:

end

public void end(Buffer data,
                Handler<AsyncResult<Void>> handler)

Same as but with an handler called when the operation completes

Specified by:

end in interface WebSocketBase

Specified by:

end in interface WriteStream<Buffer>

Overrides:

end in class WebSocket

Parameters:

data -

handler -

end

public void end(Buffer data)

Same as but with an handler called when the operation completes

Specified by:

end in interface WebSocketBase

Specified by:

end in interface WriteStream<Buffer>

Overrides:

end in class WebSocket

Parameters:

data -

rxEnd

public io.reactivex.Completable rxEnd(Buffer data)

Same as but with an handler called when the operation completes

Specified by:

rxEnd in interface WebSocketBase

Specified by:

rxEnd in interface WriteStream<Buffer>

Overrides:

rxEnd in class WebSocket

Parameters:

data -

Returns:

writeQueueFull

public boolean writeQueueFull()

This will return true if there are more bytes in the write queue than the value set using WebSocket.setWriteQueueMaxSize(int)

Specified by:

writeQueueFull in interface WebSocketBase

Specified by:

writeQueueFull in interface WriteStream<Buffer>

Overrides:

writeQueueFull in class WebSocket

Returns:

true if write queue is full

pipe

public Pipe<Buffer> pipe()

Pause this stream and return a to transfer the elements of this stream to a destination .

The stream will be resumed when the pipe will be wired to a WriteStream.

Specified by:

pipe in interface ReadStream<Buffer>

Specified by:

pipe in interface WebSocketBase

Overrides:

pipe in class WebSocket

Returns:

a pipe

pipeTo

public void pipeTo(WriteStream<Buffer> dst,
                   Handler<AsyncResult<Void>> handler)

Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.

Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Specified by:

pipeTo in interface ReadStream<Buffer>

Specified by:

pipeTo in interface WebSocketBase

Overrides:

pipeTo in class WebSocket

Parameters:

dst - the destination write stream

handler -

pipeTo

public void pipeTo(WriteStream<Buffer> dst)

Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.

Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Specified by:

pipeTo in interface ReadStream<Buffer>

Specified by:

pipeTo in interface WebSocketBase

Overrides:

pipeTo in class WebSocket

Parameters:

dst - the destination write stream

rxPipeTo

public io.reactivex.Completable rxPipeTo(WriteStream<Buffer> dst)

Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.

Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Specified by:

rxPipeTo in interface ReadStream<Buffer>

Specified by:

rxPipeTo in interface WebSocketBase

Overrides:

rxPipeTo in class WebSocket

Parameters:

dst - the destination write stream

Returns:

binaryHandlerID

public String binaryHandlerID()

When a WebSocket is created, it may register an event handler with the event bus - the ID of that handler is given by this method.

By default, no handler is registered, the feature must be enabled via WebSocketConnectOptions or HttpServerOptions.

Given this ID, a different event loop can send a binary frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

Specified by:

binaryHandlerID in interface WebSocketBase

Overrides:

binaryHandlerID in class WebSocket

Returns:

the binary handler id

textHandlerID

public String textHandlerID()

When a WebSocket is created, it may register an event handler with the eventbus, the ID of that handler is given by textHandlerID.

By default, no handler is registered, the feature must be enabled via WebSocketConnectOptions or HttpServerOptions.

Given this ID, a different event loop can send a text frame to that event handler using the event bus and that buffer will be received by this instance in its own event loop and written to the underlying connection. This allows you to write data to other WebSockets which are owned by different event loops.

Specified by:

textHandlerID in interface WebSocketBase

Overrides:

textHandlerID in class WebSocket

Returns:

the text handler id

subProtocol

public String subProtocol()

Returns the WebSocket sub protocol selected by the WebSocket handshake.

On the server, the value will be null when the handler receives the WebSocket callback as the handshake will not be completed yet.

Specified by:

subProtocol in interface WebSocketBase

Overrides:

subProtocol in class WebSocket

Returns:

closeStatusCode

public Short closeStatusCode()

Returns the close status code received from the remote endpoint or null when not yet received.

Specified by:

closeStatusCode in interface WebSocketBase

Overrides:

closeStatusCode in class WebSocket

Returns:

closeReason

public String closeReason()

Returns the close reason message from the remote endpoint or null when not yet received.

Specified by:

closeReason in interface WebSocketBase

Overrides:

closeReason in class WebSocket

Returns:

headers

public MultiMap headers()

Returns the HTTP headers when the WebSocket is first obtained in the handler.

The headers will be null on subsequent interactions.

Specified by:

headers in interface WebSocketBase

Overrides:

headers in class WebSocket

Returns:

the headers

end

public void end(Handler<AsyncResult<Void>> handler)

Calls WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)

Specified by:

end in interface WebSocketBase

Specified by:

end in interface WriteStream<Buffer>

Overrides:

end in class WebSocket

Parameters:

handler -

end

public void end()

Calls WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)

Specified by:

end in interface WebSocketBase

Specified by:

end in interface WriteStream<Buffer>

Overrides:

end in class WebSocket

rxEnd

public io.reactivex.Completable rxEnd()

Calls WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)

Specified by:

rxEnd in interface WebSocketBase

Specified by:

rxEnd in interface WriteStream<Buffer>

Overrides:

rxEnd in class WebSocket

Returns:

close

public void close(Handler<AsyncResult<Void>> handler)

Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

close in interface WebSocketBase

Overrides:

close in class WebSocket

Parameters:

handler -

close

public void close()

Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

close in interface WebSocketBase

Overrides:

close in class WebSocket

rxClose

public io.reactivex.Completable rxClose()

Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

rxClose in interface WebSocketBase

Overrides:

rxClose in class WebSocket

Returns:

close

public void close(short statusCode,
                  Handler<AsyncResult<Void>> handler)

Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

close in interface WebSocketBase

Overrides:

close in class WebSocket

Parameters:

statusCode -

handler -

close

public void close(short statusCode)

Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

close in interface WebSocketBase

Overrides:

close in class WebSocket

Parameters:

statusCode -

rxClose

public io.reactivex.Completable rxClose(short statusCode)

Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

rxClose in interface WebSocketBase

Overrides:

rxClose in class WebSocket

Parameters:

statusCode -

Returns:

close

public void close(short statusCode,
                  String reason,
                  Handler<AsyncResult<Void>> handler)

Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

close in interface WebSocketBase

Overrides:

close in class WebSocket

Parameters:

statusCode -

reason -

handler -

close

public void close(short statusCode,
                  String reason)

Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

close in interface WebSocketBase

Overrides:

close in class WebSocket

Parameters:

statusCode -

reason -

rxClose

public io.reactivex.Completable rxClose(short statusCode,
                                        String reason)

Same as WebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

rxClose in interface WebSocketBase

Overrides:

rxClose in class WebSocket

Parameters:

statusCode -

reason -

Returns:

remoteAddress

public SocketAddress remoteAddress()

Specified by:

remoteAddress in interface WebSocketBase

Overrides:

remoteAddress in class WebSocket

Returns:

the remote address for this connection, possibly null (e.g a server bound on a domain socket). If useProxyProtocol is set to true, the address returned will be of the actual connecting client.

localAddress

public SocketAddress localAddress()

Specified by:

localAddress in interface WebSocketBase

Overrides:

localAddress in class WebSocket

Returns:

the local address for this connection, possibly null (e.g a server bound on a domain socket) If useProxyProtocol is set to true, the address returned will be of the proxy.

isSsl

public boolean isSsl()

Specified by:

isSsl in interface WebSocketBase

Overrides:

isSsl in class WebSocket

Returns:

true if this HttpConnection is encrypted via SSL/TLS.

isClosed

public boolean isClosed()

Specified by:

isClosed in interface WebSocketBase

Overrides:

isClosed in class WebSocket

Returns:

true if the WebSocket is closed

connect

public void connect(int port,
                    String host,
                    String requestURI,
                    Handler<AsyncResult<WebSocket>> handler)

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

Parameters:

port - the port

host - the host

requestURI - the relative URI

handler - handler that will be called with the WebSocket when connected

connect

public void connect(int port,
                    String host,
                    String requestURI)

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

Parameters:

port - the port

host - the host

requestURI - the relative URI

rxConnect

public io.reactivex.Single<WebSocket> rxConnect(int port,
                                                String host,
                                                String requestURI)

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

Parameters:

port - the port

host - the host

requestURI - the relative URI

Returns:

connect

public void connect(WebSocketConnectOptions options,
                    Handler<AsyncResult<WebSocket>> handler)

Connect a WebSocket with the specified options.

Parameters:

options - the request options

handler - handler that will be called with the WebSocket when connected

connect

public void connect(WebSocketConnectOptions options)

Connect a WebSocket with the specified options.

Parameters:

options - the request options

rxConnect

public io.reactivex.Single<WebSocket> rxConnect(WebSocketConnectOptions options)

Connect a WebSocket with the specified options.

Parameters:

options - the request options

Returns:

connect

public void connect(String host,
                    String requestURI,
                    Handler<AsyncResult<WebSocket>> handler)

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

Parameters:

host - the host

requestURI - the relative URI

handler - handler that will be called with the WebSocket when connected

connect

public void 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

rxConnect

public io.reactivex.Single<WebSocket> rxConnect(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:

connect

public void connect(String requestURI,
                    Handler<AsyncResult<WebSocket>> handler)

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

Parameters:

requestURI - the relative URI

handler - handler that will be called with the WebSocket when connected

connect

public void connect(String requestURI)

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

Parameters:

requestURI - the relative URI

rxConnect

public io.reactivex.Single<WebSocket> rxConnect(String requestURI)

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

Parameters:

requestURI - the relative URI

Returns:

handler

public 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 WebSocketBase

Overrides:

handler in class WebSocket

Returns:

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

endHandler

public 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 WebSocketBase

Overrides:

endHandler in class WebSocket

Returns:

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

drainHandler

public 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 WebSocketBase

Specified by:

drainHandler in interface WriteStream<Buffer>

Overrides:

drainHandler in class WebSocket

Parameters:

handler - the handler

Returns:

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

closeHandler

public 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 WebSocketBase

Overrides:

closeHandler in class WebSocket

Parameters:

handler - the handler

Returns:

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

frameHandler

public 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 WebSocketBase

Overrides:

frameHandler in class WebSocket

Parameters:

handler - the handler

Returns:

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

textMessageHandler

public ClientWebSocket textMessageHandler(Handler<String> handler)

Description copied from class: WebSocket

Set a text message handler on the connection. This handler will be called similar to the WebSocketBase.binaryMessageHandler(io.vertx.core.Handler<io.vertx.reactivex.core.buffer.Buffer>), but the buffer will be converted to a String first

Specified by:

textMessageHandler in interface WebSocketBase

Overrides:

textMessageHandler in class WebSocket

Parameters:

handler - the handler

Returns:

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

binaryMessageHandler

public ClientWebSocket binaryMessageHandler(Handler<Buffer> handler)

Description copied from class: WebSocket

Set a binary message handler on the connection. This handler serves a similar purpose to WebSocket.handler(io.vertx.core.Handler<io.vertx.reactivex.core.buffer.Buffer>) 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 WebSocketBase

Overrides:

binaryMessageHandler in class WebSocket

Parameters:

handler - the handler

Returns:

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

pongHandler

public ClientWebSocket pongHandler(Handler<Buffer> handler)

Description copied from class: WebSocket

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 WebSocketBase

Overrides:

pongHandler in class WebSocket

Parameters:

handler - the handler

Returns:

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

exceptionHandler

public 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 WebSocketBase

Specified by:

exceptionHandler in interface WriteStream<Buffer>

Overrides:

exceptionHandler in class WebSocket

Parameters:

handler - the exception handler

Returns:

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

writeFrame

public ClientWebSocket writeFrame(WebSocketFrame frame,
                                  Handler<AsyncResult<Void>> handler)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeFrame in interface WebSocketBase

Overrides:

writeFrame in class WebSocket

Returns:

writeFrame

public ClientWebSocket writeFrame(WebSocketFrame frame)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeFrame in interface WebSocketBase

Overrides:

writeFrame in class WebSocket

Returns:

rxWriteFrame

public io.reactivex.Completable rxWriteFrame(WebSocketFrame frame)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

rxWriteFrame in interface WebSocketBase

Overrides:

rxWriteFrame in class WebSocket

Returns:

writeFinalTextFrame

public ClientWebSocket writeFinalTextFrame(String text,
                                           Handler<AsyncResult<Void>> handler)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeFinalTextFrame in interface WebSocketBase

Overrides:

writeFinalTextFrame in class WebSocket

Returns:

writeFinalTextFrame

public ClientWebSocket writeFinalTextFrame(String text)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeFinalTextFrame in interface WebSocketBase

Overrides:

writeFinalTextFrame in class WebSocket

Returns:

rxWriteFinalTextFrame

public io.reactivex.Completable rxWriteFinalTextFrame(String text)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

rxWriteFinalTextFrame in interface WebSocketBase

Overrides:

rxWriteFinalTextFrame in class WebSocket

Returns:

writeFinalBinaryFrame

public ClientWebSocket writeFinalBinaryFrame(Buffer data,
                                             Handler<AsyncResult<Void>> handler)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeFinalBinaryFrame in interface WebSocketBase

Overrides:

writeFinalBinaryFrame in class WebSocket

Returns:

writeFinalBinaryFrame

public ClientWebSocket writeFinalBinaryFrame(Buffer data)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeFinalBinaryFrame in interface WebSocketBase

Overrides:

writeFinalBinaryFrame in class WebSocket

Returns:

rxWriteFinalBinaryFrame

public io.reactivex.Completable rxWriteFinalBinaryFrame(Buffer data)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

rxWriteFinalBinaryFrame in interface WebSocketBase

Overrides:

rxWriteFinalBinaryFrame in class WebSocket

Returns:

writeBinaryMessage

public ClientWebSocket writeBinaryMessage(Buffer data,
                                          Handler<AsyncResult<Void>> handler)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeBinaryMessage in interface WebSocketBase

Overrides:

writeBinaryMessage in class WebSocket

Returns:

writeBinaryMessage

public ClientWebSocket writeBinaryMessage(Buffer data)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeBinaryMessage in interface WebSocketBase

Overrides:

writeBinaryMessage in class WebSocket

Returns:

rxWriteBinaryMessage

public io.reactivex.Completable rxWriteBinaryMessage(Buffer data)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

rxWriteBinaryMessage in interface WebSocketBase

Overrides:

rxWriteBinaryMessage in class WebSocket

Returns:

writeTextMessage

public ClientWebSocket writeTextMessage(String text,
                                        Handler<AsyncResult<Void>> handler)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeTextMessage in interface WebSocketBase

Overrides:

writeTextMessage in class WebSocket

Returns:

writeTextMessage

public ClientWebSocket writeTextMessage(String text)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

writeTextMessage in interface WebSocketBase

Overrides:

writeTextMessage in class WebSocket

Returns:

rxWriteTextMessage

public io.reactivex.Completable rxWriteTextMessage(String text)

Description copied from interface: WebSocketBase

Same as WebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes

Specified by:

rxWriteTextMessage in interface WebSocketBase

Overrides:

rxWriteTextMessage in class WebSocket

Returns:

writePing

public ClientWebSocket writePing(Buffer data,
                                 Handler<AsyncResult<Void>> handler)

Description copied from interface: WebSocketBase

Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.

There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.

Specified by:

writePing in interface WebSocketBase

Overrides:

writePing in class WebSocket

Parameters:

data - the data to write, may be at most 125 bytes

handler - called when the ping frame has been successfully written

Returns:

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

writePing

public ClientWebSocket writePing(Buffer data)

Description copied from interface: WebSocketBase

Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.

There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.

Specified by:

writePing in interface WebSocketBase

Overrides:

writePing in class WebSocket

Parameters:

data - the data to write, may be at most 125 bytes

Returns:

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

rxWritePing

public io.reactivex.Completable rxWritePing(Buffer data)

Description copied from interface: WebSocketBase

Writes a ping frame to the connection. This will be written in a single frame. Ping frames may be at most 125 bytes (octets).

This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 Section section 5.5.2.

There is no handler for ping frames because RFC 6455 clearly states that the only response to a ping frame is a pong frame with identical contents.

Specified by:

rxWritePing in interface WebSocketBase

Overrides:

rxWritePing in class WebSocket

Parameters:

data - the data to write, may be at most 125 bytes

Returns:

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

writePong

public ClientWebSocket writePong(Buffer data,
                                 Handler<AsyncResult<Void>> handler)

Description copied from interface: WebSocketBase

Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.

There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.

Specified by:

writePong in interface WebSocketBase

Overrides:

writePong in class WebSocket

Parameters:

data - the data to write, may be at most 125 bytes

handler - called when the pong frame has been successfully written

Returns:

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

writePong

public ClientWebSocket writePong(Buffer data)

Description copied from interface: WebSocketBase

Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.

There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.

Specified by:

writePong in interface WebSocketBase

Overrides:

writePong in class WebSocket

Parameters:

data - the data to write, may be at most 125 bytes

Returns:

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

rxWritePong

public io.reactivex.Completable rxWritePong(Buffer data)

Description copied from interface: WebSocketBase

Writes a pong frame to the connection. This will be written in a single frame. Pong frames may be at most 125 bytes (octets).

This method should not be used to write application data and should only be used for implementing a keep alive or to ensure the client is still responsive, see RFC 6455 section 5.5.2.

There is no need to manually write a pong frame, as the server and client both handle responding to a ping from with a pong from automatically and this is exposed to users. RFC 6455 section 5.5.3 states that pongs may be sent unsolicited in order to implement a one way heartbeat.

Specified by:

rxWritePong in interface WebSocketBase

Overrides:

rxWritePong in class WebSocket

Parameters:

data - the data to write, may be at most 125 bytes

Returns:

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

sslSession

public SSLSession sslSession()

Overrides:

sslSession in class WebSocket

Returns:

SSLSession associated with the underlying socket. Returns null if connection is not SSL.

newInstance

public static ClientWebSocket newInstance(ClientWebSocket arg)