Package io.vertx.mutiny.core.http

Interface WebSocketBase

All Superinterfaces:

MutinyDelegate, ReadStream<io.vertx.core.buffer.Buffer>, StreamBase, WriteStream<io.vertx.core.buffer.Buffer>

All Known Implementing Classes:

ClientWebSocket, ServerWebSocket, WebSocket, WebSocketBase.WebSocketBaseImpl

public interface WebSocketBase
extends ReadStream<io.vertx.core.buffer.Buffer>, WriteStream<io.vertx.core.buffer.Buffer>, MutinyDelegate

Base WebSocket implementation.

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

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:

Tim Fox

See Also:

• WebSocketBase

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebSocketBase.WebSocketBaseImpl

Nested classes/interfaces inherited from interface io.vertx.mutiny.core.streams.ReadStream

ReadStream.ReadStreamImpl<T>

Nested classes/interfaces inherited from interface io.vertx.mutiny.core.streams.StreamBase

StreamBase.StreamBaseImpl

Nested classes/interfaces inherited from interface io.vertx.mutiny.core.streams.WriteStream

WriteStream.WriteStreamImpl<T>

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(Consumer<io.vertx.core.buffer.Buffer> handler)	Set a binary message handler on the connection.
io.smallrye.mutiny.Uni<Void>	close()	Close the WebSocket sending the default close frame.
io.smallrye.mutiny.Uni<Void>	close(short statusCode)	Close the WebSocket sending a close frame with specified status code.
io.smallrye.mutiny.Uni<Void>	close(short statusCode, String reason)	Close sending a close frame with specified status code and reason.
WebSocketBase	closeHandler(Runnable 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(Runnable handler)	Set a drain handler on the stream.
io.smallrye.mutiny.Uni<Void>	end()	Ends the stream.
io.smallrye.mutiny.Uni<Void>	end(io.vertx.core.buffer.Buffer arg0)	Same as end() but writes some data to the stream before ending.
WebSocketBase	endHandler(Runnable endHandler)	Set an end handler.
WebSocketBase	exceptionHandler(Consumer<Throwable> handler)	Set an exception handler on the read stream.
WebSocketBase	fetch(long amount)	Fetch the specified amount of elements.
WebSocketBase	frameHandler(Consumer<io.vertx.core.http.WebSocketFrame> handler)	Set a frame handler on the connection.
io.vertx.core.http.WebSocketBase	getDelegate()
WebSocketBase	handler(Consumer<io.vertx.core.buffer.Buffer> handler)	Set a data handler.
io.vertx.core.MultiMap	headers()	Returns the HTTP headers.
boolean	isClosed()
boolean	isSsl()
io.vertx.core.net.SocketAddress	localAddress()
static WebSocketBase	newInstance(io.vertx.core.http.WebSocketBase delegate)	Creates a new instance of the WebSocketBase.
WebSocketBase	pause()	Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
Pipe<io.vertx.core.buffer.Buffer>	pipe()	Pause this stream and return a Pipe to transfer the elements of this stream to a destination WriteStream.
io.smallrye.mutiny.Uni<Void>	pipeTo(WriteStream<io.vertx.core.buffer.Buffer> arg0)	Pipe this ReadStream to the WriteStream.
WebSocketBase	pongHandler(Consumer<io.vertx.core.buffer.Buffer> handler)	Set a pong frame handler on the connection.
io.vertx.core.net.SocketAddress	remoteAddress()
WebSocketBase	resume()	Resume reading, and sets the buffer in flowing mode.
WebSocketBase	setWriteQueueMaxSize(int maxSize)	Set the maximum size of the write queue to maxSize.
io.smallrye.mutiny.Uni<Void>	shutdown()	Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout, the status code 1000 a null reason.
io.smallrye.mutiny.Uni<Void>	shutdown(long timeout, TimeUnit unit)	Calls shutdown(long, TimeUnit, short, String) with the status code 1000 and a null reason.
io.smallrye.mutiny.Uni<Void>	shutdown(long timeout, TimeUnit unit, short statusCode)	Calls shutdown(long, TimeUnit, short, String) with a null reason.
io.smallrye.mutiny.Uni<Void>	shutdown(long timeout, TimeUnit unit, short statusCode, String reason)	Calls shutdown(Duration, short, String)
io.smallrye.mutiny.Uni<Void>	shutdown(short statusCode)	Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout and a null reason.
io.smallrye.mutiny.Uni<Void>	shutdown(short statusCode, String reason)	Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.
io.smallrye.mutiny.Uni<Void>	shutdown(Duration timeout)	Calls shutdown(Duration, short, String) with the status code 1000 and a null reason.
io.smallrye.mutiny.Uni<Void>	shutdown(Duration timeout, short statusCode)	Calls shutdown(Duration, short, String) with a null reason.
io.smallrye.mutiny.Uni<Void>	shutdown(Duration timeout, short statusCode, String reason)	Initiate a graceful WebSocket shutdown, the shutdown handler is notified and shall close the WebSocket, otherwise after a timeout the WebSocket will be closed.
WebSocketBase	shutdownHandler(Runnable handler)	Set a handler notified when the WebSocket is shutdown: the client or server will close the connection within a certain amount of time.
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.
WebSocketBase	textMessageHandler(Consumer<String> handler)	Set a text message handler on the connection.
io.smallrye.mutiny.Multi<io.vertx.core.buffer.Buffer>	toMulti()
io.smallrye.mutiny.Uni<Void>	write(io.vertx.core.buffer.Buffer arg0)	Write some data to the stream.
io.smallrye.mutiny.Uni<Void>	writeBinaryMessage(io.vertx.core.buffer.Buffer data)	Writes a (potentially large) piece of binary data to the connection.
io.smallrye.mutiny.Uni<Void>	writeFinalBinaryFrame(io.vertx.core.buffer.Buffer data)	Write a final WebSocket binary frame to the connection
io.smallrye.mutiny.Uni<Void>	writeFinalTextFrame(String text)	Write a final WebSocket text frame to the connection
io.smallrye.mutiny.Uni<Void>	writeFrame(io.vertx.core.http.WebSocketFrame frame)	Write a WebSocket frame to the connection
io.smallrye.mutiny.Uni<Void>	writePing(io.vertx.core.buffer.Buffer data)	Writes a ping frame to the connection.
io.smallrye.mutiny.Uni<Void>	writePong(io.vertx.core.buffer.Buffer data)	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)
io.smallrye.mutiny.Uni<Void>	writeTextMessage(String text)	Writes a (potentially large) piece of text data to the connection.

Method Details

getDelegate

io.vertx.core.http.WebSocketBase getDelegate()

Specified by:

getDelegate in interface MutinyDelegate

Specified by:

getDelegate in interface ReadStream<io.vertx.core.buffer.Buffer>

Specified by:

getDelegate in interface StreamBase

Specified by:

getDelegate in interface WriteStream<io.vertx.core.buffer.Buffer>

Returns:

the delegate used by this Mutiny object of generated type

writeFrame

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> writeFrame(io.vertx.core.http.WebSocketFrame frame)

Write a WebSocket frame to the connection

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

frame - the frame to write

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.writeFrame(WebSocketFrame)

writeFinalTextFrame

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> writeFinalTextFrame(String text)

Write a final WebSocket text frame to the connection

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

text - The text to write

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.writeFinalTextFrame(String)

writeFinalBinaryFrame

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> writeFinalBinaryFrame(io.vertx.core.buffer.Buffer data)

Write a final WebSocket binary frame to the connection

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

data - The data to write

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.writeFinalBinaryFrame(Buffer)

writeBinaryMessage

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> writeBinaryMessage(io.vertx.core.buffer.Buffer data)

Writes a (potentially large) piece of binary data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

data - the data to write

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.writeBinaryMessage(Buffer)

writeTextMessage

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> writeTextMessage(String text)

Writes a (potentially large) piece of text data to the connection. This data might be written as multiple frames if it exceeds the maximum WebSocket frame size.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

text - the data to write

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.writeTextMessage(String)

writePing

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> writePing(io.vertx.core.buffer.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.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

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

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.writePing(Buffer)

writePong

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> writePong(io.vertx.core.buffer.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.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

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

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.writePong(Buffer)

end

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> end()

Ends the stream.

Once the stream has ended, it cannot be used any more.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Calls close()

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Specified by:

end in interface WriteStream<io.vertx.core.buffer.Buffer>

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.end()

close

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> close()

Close the WebSocket sending the default close frame.

No more messages can be sent.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.close()

close

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> close(short statusCode)

Close the WebSocket sending a close frame with specified status code. You can give a look at various close payloads here: RFC6455 section 7.4.1

No more messages can be sent.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

statusCode - the status code

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.close(short)

close

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> close(short statusCode,
 String reason)

Close sending a close frame with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1

No more messages can be sent.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

statusCode - the status code

reason - reason of closure. Can be null.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.close(short, String)

shutdown

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> shutdown()

Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout, the status code 1000 a null reason.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.shutdown()

shutdown

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> shutdown(short statusCode)

Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout and a null reason.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.shutdown(short)

shutdown

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> shutdown(short statusCode,
 String reason)

Like shutdown(long, TimeUnit, short, String) with a 30 seconds timeout.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.shutdown(short, String)

shutdown

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> shutdown(long timeout,
 TimeUnit unit)

Calls shutdown(long, TimeUnit, short, String) with the status code 1000 and a null reason.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.shutdown(long, TimeUnit)

shutdown

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> shutdown(Duration timeout)

Calls shutdown(Duration, short, String) with the status code 1000 and a null reason.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.shutdown(Duration)

shutdown

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> shutdown(long timeout,
 TimeUnit unit,
 short statusCode)

Calls shutdown(long, TimeUnit, short, String) with a null reason.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.shutdown(long, TimeUnit, short)

shutdown

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> shutdown(Duration timeout,
 short statusCode)

Calls shutdown(Duration, short, String) with a null reason.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.shutdown(Duration, short)

shutdown

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> shutdown(long timeout,
 TimeUnit unit,
 short statusCode,
 String reason)

Calls shutdown(Duration, short, String)

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.shutdown(long, TimeUnit, short, String)

shutdown

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> shutdown(Duration timeout,
 short statusCode,
 String reason)

Initiate a graceful WebSocket shutdown, the shutdown handler is notified and shall close the WebSocket, otherwise after a timeout the WebSocket will be closed.

The WebSocket is closed with specified status code and reason. You can give a look at various close payloads here: RFC6455 section 7.4.1

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Parameters:

timeout - the amount of time after which all resources are forcibly closed

statusCode - the status code

reason - reason of closure. Can be null.

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WebSocketBase.shutdown(Duration, short, String)

write

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> write(io.vertx.core.buffer.Buffer arg0)

Write some data to the stream.

The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull() method before writing. This is done automatically if using a Pipe.

When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the uni is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Specified by:

write in interface WriteStream<io.vertx.core.buffer.Buffer>

Parameters:

data - the data to write

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WriteStream.write(T)

pipeTo

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> pipeTo(WriteStream<io.vertx.core.buffer.Buffer> arg0)

Pipe this ReadStream to the WriteStream.

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

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Specified by:

pipeTo in interface ReadStream<io.vertx.core.buffer.Buffer>

Parameters:

dst - the destination write stream

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• io.vertx.core.http.WebSocketBase#pipeTo(WriteStream)

end

@CheckReturnValue
io.smallrye.mutiny.Uni<Void> end(io.vertx.core.buffer.Buffer arg0)

Same as end() but writes some data to the stream before ending.

Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

Don't forget to subscribe on it to trigger the operation.

Specified by:

end in interface WriteStream<io.vertx.core.buffer.Buffer>

Parameters:

data - the data to write

Returns:

A Uni representing the asynchronous result of this operation.

See Also:

• WriteStream.end(T)

exceptionHandler

WebSocketBase exceptionHandler(Consumer<Throwable> handler)

Description copied from interface: ReadStream

Set an exception handler on the read stream.

Specified by:

exceptionHandler in interface ReadStream<io.vertx.core.buffer.Buffer>

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WriteStream<io.vertx.core.buffer.Buffer>

Parameters:

handler - the exception handler. Can be null.

Returns:

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

handler

WebSocketBase handler(Consumer<io.vertx.core.buffer.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<io.vertx.core.buffer.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<io.vertx.core.buffer.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<io.vertx.core.buffer.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<io.vertx.core.buffer.Buffer>

Returns:

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

endHandler

WebSocketBase endHandler(Runnable 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<io.vertx.core.buffer.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<io.vertx.core.buffer.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(Runnable 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<io.vertx.core.buffer.Buffer>

Parameters:

handler - the handler. Can be null.

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#setRegisterWriteHandlers(boolean) or HttpServerOptions#setRegisterWebSocketWriteHandlers(boolean).

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

See Also:

• WebSocketConnectOptions#setRegisterWriteHandlers(boolean)
• HttpServerOptions#setRegisterWebSocketWriteHandlers(boolean)

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#setRegisterWriteHandlers(boolean) or HttpServerOptions#setRegisterWebSocketWriteHandlers(boolean).

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

See Also:

• WebSocketConnectOptions#setRegisterWriteHandlers(boolean)
• HttpServerOptions#setRegisterWebSocketWriteHandlers(boolean)

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.

closeStatusCode

Short closeStatusCode()

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

closeReason

String closeReason()

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

headers

io.vertx.core.MultiMap headers()

Returns the HTTP headers.

Returns:

the headers

closeHandler

WebSocketBase closeHandler(Runnable 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. Can be null.

Returns:

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

shutdownHandler

WebSocketBase shutdownHandler(Runnable handler)

Set a handler notified when the WebSocket is shutdown: the client or server will close the connection within a certain amount of time. This gives the opportunity to the handler to close the WebSocket gracefully before the WebSocket is forcefully closed.

Parameters:

handler - the handler notified with the remaining shutdown. Can be null.

Returns:

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

frameHandler

WebSocketBase frameHandler(Consumer<io.vertx.core.http.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. Can be null.

Returns:

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

textMessageHandler

WebSocketBase textMessageHandler(Consumer<String> handler)

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

Parameters:

handler - the handler. Can be null.

Returns:

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

binaryMessageHandler

WebSocketBase binaryMessageHandler(Consumer<io.vertx.core.buffer.Buffer> handler)

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

Parameters:

handler - the handler. Can be null.

Returns:

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

pongHandler

WebSocketBase pongHandler(Consumer<io.vertx.core.buffer.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. Can be null.

Returns:

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

remoteAddress

io.vertx.core.net.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

io.vertx.core.net.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 cannot be used to send message anymore

sslSession

SSLSession sslSession()

Returns:

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

See Also:

• SSLSession

pipe

Pipe<io.vertx.core.buffer.Buffer> pipe()

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

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

Specified by:

pipe in interface ReadStream<io.vertx.core.buffer.Buffer>

Returns:

a pipe

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<io.vertx.core.buffer.Buffer>

Returns:

true if write queue is full

newInstance

static WebSocketBase newInstance(io.vertx.core.http.WebSocketBase delegate)

Creates a new instance of the WebSocketBase.

toMulti

io.smallrye.mutiny.Multi<io.vertx.core.buffer.Buffer> toMulti()