Interface WebSocketBase
- All Superinterfaces:
MutinyDelegate
,ReadStream<Buffer>
,StreamBase
,WriteStream<Buffer>
- All Known Implementing Classes:
ClientWebSocket
,ServerWebSocket
,WebSocket
It implements both and so it can be used with
Pipe
to pipe data with flow control.
original
non Mutiny-ified interface using Vert.x codegen.-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionbinaryMessageHandler
(Consumer<Buffer> handler) io.smallrye.mutiny.Uni<Void>
close()
Same asclose()
but with anhandler
called when the operation completesio.smallrye.mutiny.Uni<Void>
close
(short statusCode) Same asclose()
but with anhandler
called when the operation completesio.smallrye.mutiny.Uni<Void>
Same asclose()
but with anhandler
called when the operation completesBlocking variant ofclose()
.closeAndAwait
(short statusCode) Blocking variant ofclose(short)
.closeAndAwait
(short statusCode, String reason) Blocking variant ofclose(short,String)
.void
Variant ofclose()
that ignores the result of the operation.void
closeAndForget
(short statusCode) Variant ofclose(short)
that ignores the result of the operation.void
closeAndForget
(short statusCode, String reason) Variant ofclose(short,String)
that ignores the result of the operation.closeHandler
(Runnable handler) drainHandler
(Runnable handler) io.smallrye.mutiny.Uni<Void>
end()
Callsclose()
io.smallrye.mutiny.Uni<Void>
Same as but with anhandler
called when the operation completesBlocking variant ofend(io.vertx.mutiny.core.buffer.Buffer)
.endAndAwait
(Buffer data) Blocking variant ofio.vertx.mutiny.core.streams.WriteStream#end(io.vertx.mutiny.core.buffer.Buffer)
.void
Variant ofend(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.void
endAndForget
(Buffer data) Variant ofio.vertx.mutiny.core.streams.WriteStream#end(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.endHandler
(Runnable endHandler) exceptionHandler
(Consumer<Throwable> handler) fetch
(long amount) frameHandler
(Consumer<WebSocketFrame> handler) io.vertx.core.http.WebSocketBase
headers()
boolean
isClosed()
boolean
isSsl()
static WebSocketBase
newInstance
(io.vertx.core.http.WebSocketBase arg) pause()
pipe()
io.smallrye.mutiny.Uni<Void>
pipeTo
(WriteStream<Buffer> dst) Pipe thisReadStream
to theWriteStream
.pipeToAndAwait
(WriteStream<Buffer> dst) Blocking variant ofReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream)
.void
pipeToAndForget
(WriteStream<Buffer> dst) Variant ofReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream)
that ignores the result of the operation.pongHandler
(Consumer<Buffer> handler) resume()
setWriteQueueMaxSize
(int maxSize) textMessageHandler
(Consumer<String> handler) io.smallrye.mutiny.Uni<Void>
Same as but with anhandler
called when the operation completeswriteAndAwait
(Buffer data) Blocking variant ofio.vertx.mutiny.core.streams.WriteStream#write(io.vertx.mutiny.core.buffer.Buffer)
.void
writeAndForget
(Buffer data) Variant ofio.vertx.mutiny.core.streams.WriteStream#write(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
writeBinaryMessage
(Buffer data) Same aswriteBinaryMessage(io.vertx.mutiny.core.buffer.Buffer)
but with anhandler
called when the operation completesBlocking variant ofwriteBinaryMessage(io.vertx.mutiny.core.buffer.Buffer)
.Variant ofwriteBinaryMessage(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
writeFinalBinaryFrame
(Buffer data) Same aswriteFinalBinaryFrame(io.vertx.mutiny.core.buffer.Buffer)
but with anhandler
called when the operation completesBlocking variant ofwriteFinalBinaryFrame(io.vertx.mutiny.core.buffer.Buffer)
.Variant ofwriteFinalBinaryFrame(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
writeFinalTextFrame
(String text) Same aswriteFinalTextFrame(java.lang.String)
but with anhandler
called when the operation completesBlocking variant ofwriteFinalTextFrame(String)
.Variant ofwriteFinalTextFrame(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
writeFrame
(WebSocketFrame frame) Same aswriteFrame(io.vertx.mutiny.core.http.WebSocketFrame)
but with anhandler
called when the operation completeswriteFrameAndAwait
(WebSocketFrame frame) Blocking variant ofwriteFrame(io.vertx.mutiny.core.http.WebSocketFrame)
.Variant ofwriteFrame(io.vertx.mutiny.core.http.WebSocketFrame)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
Writes a ping frame to the connection.writePingAndAwait
(Buffer data) Blocking variant ofwritePing(io.vertx.mutiny.core.buffer.Buffer)
.writePingAndForget
(Buffer data) Variant ofwritePing(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.io.smallrye.mutiny.Uni<Void>
Writes a pong frame to the connection.writePongAndAwait
(Buffer data) Blocking variant ofwritePong(io.vertx.mutiny.core.buffer.Buffer)
.writePongAndForget
(Buffer data) Variant ofwritePong(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.boolean
io.smallrye.mutiny.Uni<Void>
writeTextMessage
(String text) Same aswriteTextMessage(java.lang.String)
but with anhandler
called when the operation completesBlocking variant ofwriteTextMessage(String)
.Variant ofwriteTextMessage(String)
that ignores the result of the operation.Methods inherited from interface io.vertx.mutiny.core.streams.ReadStream
toMulti
-
Field Details
-
TYPE_ARG_0
-
-
Method Details
-
getDelegate
io.vertx.core.http.WebSocketBase getDelegate()- Specified by:
getDelegate
in interfaceMutinyDelegate
- Specified by:
getDelegate
in interfaceReadStream<Buffer>
- Specified by:
getDelegate
in interfaceStreamBase
- Specified by:
getDelegate
in interfaceWriteStream<Buffer>
- Returns:
- the delegate used by this Mutiny object of generated type
-
write
Same as but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Specified by:
write
in interfaceWriteStream<Buffer>
- Parameters:
data
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
writeAndAwait
Blocking variant ofio.vertx.mutiny.core.streams.WriteStream#write(io.vertx.mutiny.core.buffer.Buffer)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Specified by:
writeAndAwait
in interfaceWriteStream<Buffer>
- Parameters:
data
-- Returns:
- the Void instance produced by the operation.
-
writeAndForget
Variant ofio.vertx.mutiny.core.streams.WriteStream#write(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.This method subscribes on the result of
io.vertx.mutiny.core.streams.WriteStream#write(io.vertx.mutiny.core.buffer.Buffer)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromio.vertx.mutiny.core.streams.WriteStream#write(io.vertx.mutiny.core.buffer.Buffer)
but you don't need to compose it with other operations.- Specified by:
writeAndForget
in interfaceWriteStream<Buffer>
- Parameters:
data
-
-
end
Same as but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Specified by:
end
in interfaceWriteStream<Buffer>
- Parameters:
data
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
endAndAwait
Blocking variant ofio.vertx.mutiny.core.streams.WriteStream#end(io.vertx.mutiny.core.buffer.Buffer)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Specified by:
endAndAwait
in interfaceWriteStream<Buffer>
- Parameters:
data
-- Returns:
- the Void instance produced by the operation.
-
endAndForget
Variant ofio.vertx.mutiny.core.streams.WriteStream#end(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.This method subscribes on the result of
io.vertx.mutiny.core.streams.WriteStream#end(io.vertx.mutiny.core.buffer.Buffer)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromio.vertx.mutiny.core.streams.WriteStream#end(io.vertx.mutiny.core.buffer.Buffer)
but you don't need to compose it with other operations.- Specified by:
endAndForget
in interfaceWriteStream<Buffer>
- Parameters:
data
-
-
writeQueueFull
boolean writeQueueFull()- Specified by:
writeQueueFull
in interfaceWriteStream<Buffer>
- Returns:
true
if write queue is full
-
pipe
- Specified by:
pipe
in interfaceReadStream<Buffer>
- Returns:
- a pipe
-
pipeTo
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.Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Specified by:
pipeTo
in interfaceReadStream<Buffer>
- Parameters:
dst
- the destination write stream- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
pipeToAndAwait
Blocking variant ofReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Specified by:
pipeToAndAwait
in interfaceReadStream<Buffer>
- Parameters:
dst
- the destination write stream- Returns:
- the Void instance produced by the operation.
-
pipeToAndForget
Variant ofReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream)
that ignores the result of the operation.This method subscribes on the result of
ReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromReadStream.pipeTo(io.vertx.mutiny.core.streams.WriteStream)
but you don't need to compose it with other operations.- Specified by:
pipeToAndForget
in interfaceReadStream<Buffer>
- Parameters:
dst
- the destination write stream
-
exceptionHandler
- Specified by:
exceptionHandler
in interfaceReadStream<Buffer>
- Specified by:
exceptionHandler
in interfaceStreamBase
- Specified by:
exceptionHandler
in interfaceWriteStream<Buffer>
- Parameters:
handler
- the exception handler- Returns:
-
handler
- Specified by:
handler
in interfaceReadStream<Buffer>
- Returns:
-
pause
WebSocketBase pause()- Specified by:
pause
in interfaceReadStream<Buffer>
- Returns:
- a reference to this, so the API can be used fluently
-
resume
WebSocketBase resume()- Specified by:
resume
in interfaceReadStream<Buffer>
- Returns:
- a reference to this, so the API can be used fluently
-
fetch
- Specified by:
fetch
in interfaceReadStream<Buffer>
- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
- Specified by:
endHandler
in interfaceReadStream<Buffer>
- Returns:
-
setWriteQueueMaxSize
- 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
- Specified by:
drainHandler
in interfaceWriteStream<Buffer>
- Parameters:
handler
- the handler- Returns:
-
binaryHandlerID
String binaryHandlerID()- Returns:
- the binary handler id
-
textHandlerID
String textHandlerID()- Returns:
- the text handler id
-
subProtocol
String subProtocol()- Returns:
-
closeStatusCode
Short closeStatusCode()- Returns:
-
closeReason
String closeReason()- Returns:
-
headers
MultiMap headers()- Returns:
- the headers
-
writeFrame
Same aswriteFrame(io.vertx.mutiny.core.http.WebSocketFrame)
but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
frame
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
writeFrameAndAwait
Blocking variant ofwriteFrame(io.vertx.mutiny.core.http.WebSocketFrame)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
frame
-- Returns:
- the Void instance produced by the operation.
-
writeFrameAndForget
Variant ofwriteFrame(io.vertx.mutiny.core.http.WebSocketFrame)
that ignores the result of the operation.This method subscribes on the result of
writeFrame(io.vertx.mutiny.core.http.WebSocketFrame)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwriteFrame(io.vertx.mutiny.core.http.WebSocketFrame)
but you don't need to compose it with other operations.- Parameters:
frame
-- Returns:
- the instance of WebSocketBase to chain method calls.
-
writeFinalTextFrame
Same aswriteFinalTextFrame(java.lang.String)
but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
text
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
writeFinalTextFrameAndAwait
Blocking variant ofwriteFinalTextFrame(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
text
-- Returns:
- the Void instance produced by the operation.
-
writeFinalTextFrameAndForget
Variant ofwriteFinalTextFrame(String)
that ignores the result of the operation.This method subscribes on the result of
writeFinalTextFrame(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwriteFinalTextFrame(String)
but you don't need to compose it with other operations.- Parameters:
text
-- Returns:
- the instance of WebSocketBase to chain method calls.
-
writeFinalBinaryFrame
Same aswriteFinalBinaryFrame(io.vertx.mutiny.core.buffer.Buffer)
but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
data
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
writeFinalBinaryFrameAndAwait
Blocking variant ofwriteFinalBinaryFrame(io.vertx.mutiny.core.buffer.Buffer)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
data
-- Returns:
- the Void instance produced by the operation.
-
writeFinalBinaryFrameAndForget
Variant ofwriteFinalBinaryFrame(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.This method subscribes on the result of
writeFinalBinaryFrame(io.vertx.mutiny.core.buffer.Buffer)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwriteFinalBinaryFrame(io.vertx.mutiny.core.buffer.Buffer)
but you don't need to compose it with other operations.- Parameters:
data
-- Returns:
- the instance of WebSocketBase to chain method calls.
-
writeBinaryMessage
Same aswriteBinaryMessage(io.vertx.mutiny.core.buffer.Buffer)
but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
data
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
writeBinaryMessageAndAwait
Blocking variant ofwriteBinaryMessage(io.vertx.mutiny.core.buffer.Buffer)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
data
-- Returns:
- the Void instance produced by the operation.
-
writeBinaryMessageAndForget
Variant ofwriteBinaryMessage(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.This method subscribes on the result of
writeBinaryMessage(io.vertx.mutiny.core.buffer.Buffer)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwriteBinaryMessage(io.vertx.mutiny.core.buffer.Buffer)
but you don't need to compose it with other operations.- Parameters:
data
-- Returns:
- the instance of WebSocketBase to chain method calls.
-
writeTextMessage
Same aswriteTextMessage(java.lang.String)
but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
text
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
writeTextMessageAndAwait
Blocking variant ofwriteTextMessage(String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
text
-- Returns:
- the Void instance produced by the operation.
-
writeTextMessageAndForget
Variant ofwriteTextMessage(String)
that ignores the result of the operation.This method subscribes on the result of
writeTextMessage(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwriteTextMessage(String)
but you don't need to compose it with other operations.- Parameters:
text
-- Returns:
- the instance of WebSocketBase to chain method calls.
-
writePing
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
. Don't forget to subscribe on it to trigger the operation.- Parameters:
data
- the data to write, may be at most 125 bytes- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
writePingAndAwait
Blocking variant ofwritePing(io.vertx.mutiny.core.buffer.Buffer)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
data
- the data to write, may be at most 125 bytes- Returns:
- the Void instance produced by the operation.
-
writePingAndForget
Variant ofwritePing(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.This method subscribes on the result of
writePing(io.vertx.mutiny.core.buffer.Buffer)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwritePing(io.vertx.mutiny.core.buffer.Buffer)
but you don't need to compose it with other operations.- Parameters:
data
- the data to write, may be at most 125 bytes- Returns:
- the instance of WebSocketBase to chain method calls.
-
writePong
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
. Don't forget to subscribe on it to trigger the operation.- Parameters:
data
- the data to write, may be at most 125 bytes- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
writePongAndAwait
Blocking variant ofwritePong(io.vertx.mutiny.core.buffer.Buffer)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
data
- the data to write, may be at most 125 bytes- Returns:
- the Void instance produced by the operation.
-
writePongAndForget
Variant ofwritePong(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.This method subscribes on the result of
writePong(io.vertx.mutiny.core.buffer.Buffer)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromwritePong(io.vertx.mutiny.core.buffer.Buffer)
but you don't need to compose it with other operations.- Parameters:
data
- the data to write, may be at most 125 bytes- Returns:
- the instance of WebSocketBase to chain method calls.
-
closeHandler
- Parameters:
handler
- the handler- Returns:
-
frameHandler
- Parameters:
handler
- the handler- Returns:
-
textMessageHandler
- Parameters:
handler
- the handler- Returns:
-
binaryMessageHandler
- Parameters:
handler
- the handler- Returns:
-
pongHandler
- Parameters:
handler
- the handler- Returns:
-
end
Callsclose()
Unlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Specified by:
end
in interfaceWriteStream<Buffer>
- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
endAndAwait
Void endAndAwait()Blocking variant ofend(io.vertx.mutiny.core.buffer.Buffer)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Specified by:
endAndAwait
in interfaceWriteStream<Buffer>
- Returns:
- the Void instance produced by the operation.
-
endAndForget
void endAndForget()Variant ofend(io.vertx.mutiny.core.buffer.Buffer)
that ignores the result of the operation.This method subscribes on the result of
end(io.vertx.mutiny.core.buffer.Buffer)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromend(io.vertx.mutiny.core.buffer.Buffer)
but you don't need to compose it with other operations.- Specified by:
endAndForget
in interfaceWriteStream<Buffer>
-
close
Same asclose()
but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
closeAndAwait
Void closeAndAwait()Blocking variant ofclose()
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Returns:
- the Void instance produced by the operation.
-
closeAndForget
void closeAndForget() -
close
Same asclose()
but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
statusCode
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
closeAndAwait
Blocking variant ofclose(short)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
statusCode
-- Returns:
- the Void instance produced by the operation.
-
closeAndForget
void closeAndForget(short statusCode) Variant ofclose(short)
that ignores the result of the operation.This method subscribes on the result of
close(short)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromclose(short)
but you don't need to compose it with other operations.- Parameters:
statusCode
-
-
close
Same asclose()
but with anhandler
called when the operation completesUnlike the bare Vert.x variant, this method returns a
Uni
. Don't forget to subscribe on it to trigger the operation.- Parameters:
statusCode
-reason
-- Returns:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
closeAndAwait
Blocking variant ofclose(short,String)
.This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).
- Parameters:
statusCode
-reason
-- Returns:
- the Void instance produced by the operation.
-
closeAndForget
Variant ofclose(short,String)
that ignores the result of the operation.This method subscribes on the result of
close(short,String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromclose(short,String)
but you don't need to compose it with other operations.- Parameters:
statusCode
-reason
-
-
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
-
sslSession
SSLSession sslSession()- Returns:
- SSLSession associated with the underlying socket. Returns null if connection is not SSL.
-
newInstance
-