Package io.vertx.reactivex.core.http

Interface WebSocketBase

All Superinterfaces:

ReadStream<Buffer>, StreamBase, WriteStream<Buffer>

All Known Implementing Classes:

ServerWebSocket, WebSocket

public interface WebSocketBase
extends ReadStream<Buffer>, WriteStream<Buffer>

Base WebSocket implementation.

It implements both and so it can be used with Pipe to pipe data with flow control.

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

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.
WebSocketBase	binaryMessageHandler(Handler<Buffer> handler)	Set a binary message handler on the connection.
void	close()	Same as 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 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 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 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 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 close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
WebSocketBase	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.
WebSocketBase	drainHandler(Handler<Void> handler)	Set a drain handler on the stream.
void	end()	Calls close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
void	end(Handler<AsyncResult<Void>> handler)	Calls 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
WebSocketBase	endHandler(Handler<Void> endHandler)	Set an end handler.
WebSocketBase	exceptionHandler(Handler<Throwable> handler)	Set an exception handler on the read stream.
WebSocketBase	fetch(long amount)	Fetch the specified amount of elements.
WebSocketBase	frameHandler(Handler<WebSocketFrame> handler)	Set a frame handler on the connection.
WebSocketBase	getDelegate()
WebSocketBase	handler(Handler<Buffer> handler)	Set a data handler.
MultiMap	headers()	Returns the HTTP headers when the WebSocket is first obtained in the handler.
boolean	isClosed()
boolean	isSsl()
SocketAddress	localAddress()
static WebSocketBase	newInstance(WebSocketBase arg)
WebSocketBase	pause()	Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
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.
WebSocketBase	pongHandler(Handler<Buffer> handler)	Set a pong frame handler on the connection.
SocketAddress	remoteAddress()
WebSocketBase	resume()	Resume reading, and sets the buffer in flowing mode.
io.reactivex.Completable	rxClose()	Same as 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 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 close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
io.reactivex.Completable	rxEnd()	Calls 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 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 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 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 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 writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
WebSocketBase	setWriteQueueMaxSize(int maxSize)	Set the maximum size of the write queue to maxSize.
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.
WebSocketBase	textMessageHandler(Handler<String> handler)	Set a text message handler on the connection.
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
WebSocketBase	writeBinaryMessage(Buffer data)	Same as 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
WebSocketBase	writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)	Same as 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
WebSocketBase	writeFinalBinaryFrame(Buffer data)	Same as 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
WebSocketBase	writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)	Same as 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
WebSocketBase	writeFinalTextFrame(String text)	Same as writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
WebSocketBase	writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)	Same as writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
WebSocketBase	writeFrame(WebSocketFrame frame)	Same as 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
WebSocketBase	writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)	Same as 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
WebSocketBase	writePing(Buffer data)	Writes a ping frame to the connection.
WebSocketBase	writePing(Buffer data, Handler<AsyncResult<Void>> handler)	Writes a ping frame to the connection.
WebSocketBase	writePong(Buffer data)	Writes a pong frame to the connection.
WebSocketBase	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 setWriteQueueMaxSize(int)
WebSocketBase	writeTextMessage(String text)	Same as writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but with an handler called when the operation completes
WebSocketBase	writeTextMessage(String text, Handler<AsyncResult<Void>> handler)	Same as 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 interface io.vertx.reactivex.core.streams.ReadStream

toFlowable, toObservable

Method Detail

getDelegate

WebSocketBase getDelegate()

Specified by:

getDelegate in interface ReadStream<Buffer>

Specified by:

getDelegate in interface StreamBase

Specified by:

getDelegate in interface WriteStream<Buffer>

pipe

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>

Returns:

a pipe

pipeTo

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>

Parameters:

dst - the destination write stream

handler -

pipeTo

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>

Parameters:

dst - the destination write stream

rxPipeTo

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>

Parameters:

dst - the destination write stream

Returns:

write

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

Same as but with an handler called when the operation completes

Specified by:

write in interface WriteStream<Buffer>

Parameters:

data -

handler -

write

void write(Buffer data)

Same as but with an handler called when the operation completes

Specified by:

write in interface WriteStream<Buffer>

Parameters:

data -

rxWrite

io.reactivex.Completable rxWrite(Buffer data)

Same as but with an handler called when the operation completes

Specified by:

rxWrite in interface WriteStream<Buffer>

Parameters:

data -

Returns:

end

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

Same as but with an handler called when the operation completes

Specified by:

end in interface WriteStream<Buffer>

Parameters:

data -

handler -

end

void end(Buffer data)

Same as but with an handler called when the operation completes

Specified by:

end in interface WriteStream<Buffer>

Parameters:

data -

rxEnd

io.reactivex.Completable rxEnd(Buffer data)

Same as but with an handler called when the operation completes

Specified by:

rxEnd in interface WriteStream<Buffer>

Parameters:

data -

Returns:

writeQueueFull

boolean writeQueueFull()

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

Specified by:

writeQueueFull in interface WriteStream<Buffer>

Returns:

true if write queue is full

exceptionHandler

WebSocketBase 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 WriteStream<Buffer>

Parameters:

handler - the exception handler

Returns:

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

handler

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

Returns:

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

pause

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

Returns:

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

resume

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

Returns:

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

fetch

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

Returns:

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

endHandler

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

Returns:

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

setWriteQueueMaxSize

WebSocketBase 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 WriteStream<Buffer>

Parameters:

maxSize - the max size of the write stream

Returns:

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

drainHandler

WebSocketBase 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 WriteStream<Buffer>

Parameters:

handler - the handler

Returns:

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

binaryHandlerID

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.

Returns:

the binary handler id

textHandlerID

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.

Returns:

the text handler id

subProtocol

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.

Returns:

closeStatusCode

Short closeStatusCode()

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

Returns:

closeReason

String closeReason()

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

Returns:

headers

MultiMap headers()

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

The headers will be null on subsequent interactions.

Returns:

the headers

writeFrame

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

Same as 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

Parameters:

frame -

handler -

Returns:

writeFrame

WebSocketBase writeFrame(WebSocketFrame frame)

Same as 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

Parameters:

frame -

Returns:

rxWriteFrame

io.reactivex.Completable rxWriteFrame(WebSocketFrame frame)

Same as 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

Parameters:

frame -

Returns:

writeFinalTextFrame

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

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

Parameters:

text -

handler -

Returns:

writeFinalTextFrame

WebSocketBase writeFinalTextFrame(String text)

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

Parameters:

text -

Returns:

rxWriteFinalTextFrame

io.reactivex.Completable rxWriteFinalTextFrame(String text)

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

Parameters:

text -

Returns:

writeFinalBinaryFrame

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

Same as 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

Parameters:

data -

handler -

Returns:

writeFinalBinaryFrame

WebSocketBase writeFinalBinaryFrame(Buffer data)

Same as 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

Parameters:

data -

Returns:

rxWriteFinalBinaryFrame

io.reactivex.Completable rxWriteFinalBinaryFrame(Buffer data)

Same as 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

Parameters:

data -

Returns:

writeBinaryMessage

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

Same as 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

Parameters:

data -

handler -

Returns:

writeBinaryMessage

WebSocketBase writeBinaryMessage(Buffer data)

Same as 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

Parameters:

data -

Returns:

rxWriteBinaryMessage

io.reactivex.Completable rxWriteBinaryMessage(Buffer data)

Same as 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

Parameters:

data -

Returns:

writeTextMessage

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

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

Parameters:

text -

handler -

Returns:

writeTextMessage

WebSocketBase writeTextMessage(String text)

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

Parameters:

text -

Returns:

rxWriteTextMessage

io.reactivex.Completable rxWriteTextMessage(String text)

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

Parameters:

text -

Returns:

writePing

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

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.

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

WebSocketBase writePing(Buffer data)

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.

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

io.reactivex.Completable rxWritePing(Buffer data)

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.

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

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

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.

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

WebSocketBase writePong(Buffer data)

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.

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

io.reactivex.Completable rxWritePong(Buffer data)

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.

Parameters:

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

Returns:

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

closeHandler

WebSocketBase closeHandler(Handler<Void> handler)

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 closeStatusCode() will return the status code and closeReason() will return the reason.

Parameters:

handler - the handler

Returns:

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

frameHandler

WebSocketBase frameHandler(Handler<WebSocketFrame> handler)

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

Parameters:

handler - the handler

Returns:

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

textMessageHandler

WebSocketBase textMessageHandler(Handler<String> handler)

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

Parameters:

handler - the handler

Returns:

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

binaryMessageHandler

WebSocketBase binaryMessageHandler(Handler<Buffer> handler)

Set a binary message handler on the connection. This handler serves a similar purpose to 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).

Parameters:

handler - the handler

Returns:

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

pongHandler

WebSocketBase pongHandler(Handler<Buffer> handler)

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.

Parameters:

handler - the handler

Returns:

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

end

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

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

Specified by:

end in interface WriteStream<Buffer>

Parameters:

handler -

end

void end()

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

Specified by:

end in interface WriteStream<Buffer>

rxEnd

io.reactivex.Completable rxEnd()

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

Specified by:

rxEnd in interface WriteStream<Buffer>

Returns:

close

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

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

Parameters:

handler -

close

void close()

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

rxClose

io.reactivex.Completable rxClose()

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

Returns:

close

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

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

Parameters:

statusCode -

handler -

close

void close(short statusCode)

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

Parameters:

statusCode -

rxClose

io.reactivex.Completable rxClose(short statusCode)

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

Parameters:

statusCode -

Returns:

close

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

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

Parameters:

statusCode -

reason -

handler -

close

void close(short statusCode,
           String reason)

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

Parameters:

statusCode -

reason -

rxClose

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

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

Parameters:

statusCode -

reason -

Returns:

remoteAddress

SocketAddress remoteAddress()

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

SocketAddress localAddress()

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

boolean isSsl()

Returns:

true if this HttpConnection is encrypted via SSL/TLS.

isClosed

boolean isClosed()

Returns:

true if the WebSocket is closed

newInstance

static WebSocketBase newInstance(WebSocketBase arg)