Interface WebSocketBase
-
- All Superinterfaces:
ReadStream<Buffer>
,StreamBase
,WriteStream<Buffer>
- All Known Implementing Classes:
ClientWebSocket
,ServerWebSocket
,WebSocket
public interface WebSocketBase extends ReadStream<Buffer>, WriteStream<Buffer>
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description String
binaryHandlerID()
When aWebSocket
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 asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
close(short statusCode)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
close(short statusCode, Handler<AsyncResult<Void>> handler)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
close(short statusCode, String reason)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
close(short statusCode, String reason, Handler<AsyncResult<Void>> handler)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
close(Handler<AsyncResult<Void>> handler)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
closeHandler(Handler<Void> handler)
Set a close handler.String
closeReason()
Returns the close reason message from the remote endpoint ornull
when not yet received.Short
closeStatusCode()
Returns the close status code received from the remote endpoint ornull
when not yet received.WebSocketBase
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.void
end()
void
end(Handler<AsyncResult<Void>> handler)
void
end(Buffer data)
Same as but with anhandler
called when the operation completesvoid
end(Buffer data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completesWebSocketBase
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 specifiedamount
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 theReadStream
, it sets the buffer infetch
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 thisReadStream
to theWriteStream
.void
pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
Pipe thisReadStream
to theWriteStream
.WebSocketBase
pongHandler(Handler<Buffer> handler)
Set a pong frame handler on the connection.SocketAddress
remoteAddress()
WebSocketBase
resume()
Resume reading, and sets the buffer inflowing
mode.io.reactivex.Completable
rxClose()
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxClose(short statusCode)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxClose(short statusCode, String reason)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxEnd()
io.reactivex.Completable
rxEnd(Buffer data)
Same as but with anhandler
called when the operation completesio.reactivex.Completable
rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStream
to theWriteStream
.io.reactivex.Completable
rxWrite(Buffer data)
Same as but with anhandler
called when the operation completesio.reactivex.Completable
rxWriteBinaryMessage(Buffer data)
Same aswriteBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxWriteFinalBinaryFrame(Buffer data)
Same aswriteFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxWriteFinalTextFrame(String text)
Same aswriteFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxWriteFrame(WebSocketFrame frame)
Same aswriteFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.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 aswriteTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue tomaxSize
.String
subProtocol()
Returns the WebSocket sub protocol selected by the WebSocket handshake.String
textHandlerID()
When aWebSocket
is created, it may register an event handler with the eventbus, the ID of that handler is given bytextHandlerID
.WebSocketBase
textMessageHandler(Handler<String> handler)
Set a text message handler on the connection.void
write(Buffer data)
Same as but with anhandler
called when the operation completesvoid
write(Buffer data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completesWebSocketBase
writeBinaryMessage(Buffer data)
Same aswriteBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
Same aswriteBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
writeFinalBinaryFrame(Buffer data)
Same aswriteFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
Same aswriteFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
writeFinalTextFrame(String text)
Same aswriteFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)
Same aswriteFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
writeFrame(WebSocketFrame frame)
Same aswriteFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
Same aswriteFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
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 returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
WebSocketBase
writeTextMessage(String text)
Same aswriteTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
writeTextMessage(String text, Handler<AsyncResult<Void>> handler)
Same aswriteTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
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 interfaceReadStream<Buffer>
- Specified by:
getDelegate
in interfaceStreamBase
- Specified by:
getDelegate
in interfaceWriteStream<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 aWriteStream
.- Specified by:
pipe
in interfaceReadStream<Buffer>
- Returns:
- a pipe
-
pipeTo
void pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
Pipe thisReadStream
to theWriteStream
.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 interfaceReadStream<Buffer>
- Parameters:
dst
- the destination write streamhandler
-
-
pipeTo
void pipeTo(WriteStream<Buffer> dst)
Pipe thisReadStream
to theWriteStream
.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 interfaceReadStream<Buffer>
- Parameters:
dst
- the destination write stream
-
rxPipeTo
io.reactivex.Completable rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStream
to theWriteStream
.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 interfaceReadStream<Buffer>
- Parameters:
dst
- the destination write stream- Returns:
-
write
void write(Buffer data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Specified by:
write
in interfaceWriteStream<Buffer>
- Parameters:
data
-handler
-
-
write
void write(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
write
in interfaceWriteStream<Buffer>
- Parameters:
data
-
-
rxWrite
io.reactivex.Completable rxWrite(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
rxWrite
in interfaceWriteStream<Buffer>
- Parameters:
data
-- Returns:
-
end
void end(Buffer data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<Buffer>
- Parameters:
data
-handler
-
-
end
void end(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
end
in interfaceWriteStream<Buffer>
- Parameters:
data
-
-
rxEnd
io.reactivex.Completable rxEnd(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
rxEnd
in interfaceWriteStream<Buffer>
- Parameters:
data
-- Returns:
-
writeQueueFull
boolean writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
- Specified by:
writeQueueFull
in interfaceWriteStream<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 interfaceReadStream<Buffer>
- Specified by:
exceptionHandler
in interfaceStreamBase
- Specified by:
exceptionHandler
in interfaceWriteStream<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 interfaceReadStream<Buffer>
- Returns:
- a reference to this, so the API can be used fluently
-
pause
WebSocketBase pause()
Description copied from interface:ReadStream
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.While it's paused, no data will be sent to the data
handler
.- Specified by:
pause
in interfaceReadStream<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 inflowing
mode. If theReadStream
has been paused, reading will recommence on it.- Specified by:
resume
in interfaceReadStream<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 specifiedamount
of elements. If theReadStream
has been paused, reading will recommence with the specifiedamount
of items, otherwise the specifiedamount
will be added to the current stream demand.- Specified by:
fetch
in interfaceReadStream<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 interfaceReadStream<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 tomaxSize
. You will still be able to write to the stream even if there is more thanmaxSize
items in the write queue. This is used as an indicator by classes such asPipe
to provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket
, etc...- Specified by:
setWriteQueueMaxSize
in interfaceWriteStream<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. SeePipe
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 interfaceWriteStream<Buffer>
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
binaryHandlerID
String binaryHandlerID()
When aWebSocket
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
orHttpServerOptions
.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 aWebSocket
is created, it may register an event handler with the eventbus, the ID of that handler is given bytextHandlerID
.By default, no handler is registered, the feature must be enabled via
WebSocketConnectOptions
orHttpServerOptions
.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 benull
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 ornull
when not yet received.- Returns:
-
closeReason
String closeReason()
Returns the close reason message from the remote endpoint ornull
when not yet received.- Returns:
-
headers
MultiMap headers()
Returns the HTTP headers when the WebSocket is first obtained in the handler. The headers will benull
on subsequent interactions.- Returns:
- the headers
-
writeFrame
WebSocketBase writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
Same aswriteFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
frame
-handler
-- Returns:
-
writeFrame
WebSocketBase writeFrame(WebSocketFrame frame)
Same aswriteFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
frame
-- Returns:
-
rxWriteFrame
io.reactivex.Completable rxWriteFrame(WebSocketFrame frame)
Same aswriteFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
frame
-- Returns:
-
writeFinalTextFrame
WebSocketBase writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)
Same aswriteFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
text
-handler
-- Returns:
-
writeFinalTextFrame
WebSocketBase writeFinalTextFrame(String text)
Same aswriteFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
text
-- Returns:
-
rxWriteFinalTextFrame
io.reactivex.Completable rxWriteFinalTextFrame(String text)
Same aswriteFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
text
-- Returns:
-
writeFinalBinaryFrame
WebSocketBase writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
Same aswriteFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
data
-handler
-- Returns:
-
writeFinalBinaryFrame
WebSocketBase writeFinalBinaryFrame(Buffer data)
Same aswriteFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
data
-- Returns:
-
rxWriteFinalBinaryFrame
io.reactivex.Completable rxWriteFinalBinaryFrame(Buffer data)
Same aswriteFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
data
-- Returns:
-
writeBinaryMessage
WebSocketBase writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
Same aswriteBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
data
-handler
-- Returns:
-
writeBinaryMessage
WebSocketBase writeBinaryMessage(Buffer data)
Same aswriteBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
data
-- Returns:
-
rxWriteBinaryMessage
io.reactivex.Completable rxWriteBinaryMessage(Buffer data)
Same aswriteBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
data
-- Returns:
-
writeTextMessage
WebSocketBase writeTextMessage(String text, Handler<AsyncResult<Void>> handler)
Same aswriteTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
text
-handler
-- Returns:
-
writeTextMessage
WebSocketBase writeTextMessage(String text)
Same aswriteTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
text
-- Returns:
-
rxWriteTextMessage
io.reactivex.Completable rxWriteTextMessage(String text)
Same aswriteTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
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 byteshandler
- 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 byteshandler
- 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, thecloseStatusCode()
will return the status code andcloseReason()
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 thebinaryMessageHandler(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 tohandler(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 (usingWebSocketFrame.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)
- Specified by:
end
in interfaceWriteStream<Buffer>
- Parameters:
handler
-
-
end
void end()
- Specified by:
end
in interfaceWriteStream<Buffer>
-
rxEnd
io.reactivex.Completable rxEnd()
- Specified by:
rxEnd
in interfaceWriteStream<Buffer>
- Returns:
-
close
void close(Handler<AsyncResult<Void>> handler)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
handler
-
-
close
void close()
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes
-
rxClose
io.reactivex.Completable rxClose()
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Returns:
-
close
void close(short statusCode, Handler<AsyncResult<Void>> handler)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
statusCode
-handler
-
-
close
void close(short statusCode)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
statusCode
-
-
rxClose
io.reactivex.Completable rxClose(short statusCode)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
statusCode
-- Returns:
-
close
void close(short statusCode, String reason, Handler<AsyncResult<Void>> handler)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
statusCode
-reason
-handler
-
-
close
void close(short statusCode, String reason)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
statusCode
-reason
-
-
rxClose
io.reactivex.Completable rxClose(short statusCode, String reason)
Same asclose(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
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). IfuseProxyProtocol
is set totrue
, 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) IfuseProxyProtocol
is set totrue
, 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)
-
-