public interface WebSocketBase extends ReadStream<Buffer>, WriteStream<Buffer>
It implements both ReadStream
and WriteStream
so it can be used with
Pipe
to pipe data with flow control.
Modifier and Type | Method and Description |
---|---|
String |
binaryHandlerID()
When a
WebSocket is created it automatically registers 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()
Close the WebSocket sending the default close frame.
|
void |
close(Handler<AsyncResult<Void>> handler)
Same as
close() but with an handler called when the operation completes |
void |
close(short statusCode)
Close the WebSocket sending a close frame with specified status code.
|
void |
close(short statusCode,
Handler<AsyncResult<Void>> handler)
Same as
close(short) but with an handler called when the operation completes |
void |
close(short statusCode,
String reason)
Close sending a close frame with specified status code and reason.
|
void |
close(short statusCode,
String reason,
Handler<AsyncResult<Void>> handler)
Same as
close(short, String) but with an handler called when the operation completes |
WebSocketBase |
closeHandler(Handler<Void> handler)
Set a close handler.
|
String |
closeReason()
Returns the close reason message from the remote endpoint or
null when not yet received. |
Short |
closeStatusCode()
Returns the close status code received from the remote endpoint or
null when not yet received. |
WebSocketBase |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
void |
end()
Calls
close() |
void |
end(Handler<AsyncResult<Void>> handler)
Calls
close(Handler) |
WebSocketBase |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
WebSocketBase |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
WebSocketBase |
fetch(long amount)
Fetch the specified
amount of elements. |
WebSocketBase |
frameHandler(Handler<WebSocketFrame> handler)
Set a frame handler on the connection.
|
WebSocketBase |
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() |
WebSocketBase |
pause()
Pause the
ReadStream , it sets the buffer in fetch mode and clears the actual demand. |
X509Certificate[] |
peerCertificateChain()
Note: Java SE 5+ recommends to use javax.net.ssl.SSLSession#getPeerCertificates() instead of
of javax.net.ssl.SSLSession#getPeerCertificateChain() which this method is based on.
|
WebSocketBase |
pongHandler(Handler<Buffer> handler)
Set a pong frame handler on the connection.
|
SocketAddress |
remoteAddress() |
WebSocketBase |
resume()
Resume reading, and sets the buffer in
flowing mode. |
WebSocketBase |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize . |
SSLSession |
sslSession() |
String |
subProtocol()
Returns the WebSocket sub protocol selected by the WebSocket handshake.
|
String |
textHandlerID()
When a
WebSocket is created it automatically registers an event handler with the eventbus, the ID of that
handler is given by textHandlerID . |
WebSocketBase |
textMessageHandler(Handler<String> handler)
Set a text message handler on the connection.
|
WebSocketBase |
write(Buffer data)
Write some data to the stream.
|
WebSocketBase |
write(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
#write(T) but with an handler called when the operation completes |
WebSocketBase |
writeBinaryMessage(Buffer data)
Writes a (potentially large) piece of binary data to the connection.
|
WebSocketBase |
writeBinaryMessage(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
writeBinaryMessage(Buffer) but with an handler called when the operation completes |
WebSocketBase |
writeFinalBinaryFrame(Buffer data)
Write a final WebSocket binary frame to the connection
|
WebSocketBase |
writeFinalBinaryFrame(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
writeFinalBinaryFrame(Buffer, Handler) but with an handler called when the operation completes |
WebSocketBase |
writeFinalTextFrame(String text)
Write a final WebSocket text frame to the connection
|
WebSocketBase |
writeFinalTextFrame(String text,
Handler<AsyncResult<Void>> handler)
Same as
writeFinalTextFrame(String, Handler) but with an handler called when the operation completes |
WebSocketBase |
writeFrame(WebSocketFrame frame)
Write a WebSocket frame to the connection
|
WebSocketBase |
writeFrame(WebSocketFrame frame,
Handler<AsyncResult<Void>> handler)
Same as
writeFrame(WebSocketFrame) but with an handler called when the operation completes |
WebSocketBase |
writePing(Buffer data)
Writes a ping frame to the connection.
|
WebSocketBase |
writePong(Buffer data)
Writes a pong frame to the connection.
|
WebSocketBase |
writeTextMessage(String text)
Writes a (potentially large) piece of text data to the connection.
|
WebSocketBase |
writeTextMessage(String text,
Handler<AsyncResult<Void>> handler)
Same as
writeTextMessage(String) but with an handler called when the operation completes |
pipe, pipeTo, pipeTo
end, end, writeQueueFull
WebSocketBase exceptionHandler(Handler<Throwable> handler)
ReadStream
exceptionHandler
in interface ReadStream<Buffer>
exceptionHandler
in interface StreamBase
exceptionHandler
in interface WriteStream<Buffer>
handler
- the exception handlerWebSocketBase handler(Handler<Buffer> handler)
ReadStream
handler
in interface ReadStream<Buffer>
WebSocketBase pause()
ReadStream
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
.
pause
in interface ReadStream<Buffer>
WebSocketBase resume()
ReadStream
flowing
mode.
If the ReadStream
has been paused, reading will recommence on it.resume
in interface ReadStream<Buffer>
WebSocketBase fetch(long amount)
ReadStream
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.fetch
in interface ReadStream<Buffer>
WebSocketBase endHandler(Handler<Void> endHandler)
ReadStream
endHandler
in interface ReadStream<Buffer>
WebSocketBase write(Buffer data)
WriteStream
WriteStream.writeQueueFull()
method before writing. This is done automatically if using a Pump
.write
in interface WriteStream<Buffer>
data
- the data to writeWebSocketBase write(Buffer data, Handler<AsyncResult<Void>> handler)
WriteStream
#write(T)
but with an handler
called when the operation completeswrite
in interface WriteStream<Buffer>
WebSocketBase setWriteQueueMaxSize(int maxSize)
WriteStream
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
Pump
to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket
, the number of Message
for a
MessageProducer
, etc...setWriteQueueMaxSize
in interface WriteStream<Buffer>
maxSize
- the max size of the write streamWebSocketBase drainHandler(Handler<Void> handler)
WriteStream
Pump
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
.drainHandler
in interface WriteStream<Buffer>
handler
- the handlerString binaryHandlerID()
WebSocket
is created it automatically registers an event handler with the event bus - the ID of that
handler is given by this method.
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.
String textHandlerID()
WebSocket
is created it automatically registers an event handler with the eventbus, the ID of that
handler is given by textHandlerID
.
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.
String subProtocol()
null
when the handler receives the websocket callback as the
handshake will not be completed yet.Short closeStatusCode()
null
when not yet received.String closeReason()
null
when not yet received.MultiMap headers()
null
on subsequent interactions.WebSocketBase writeFrame(WebSocketFrame frame)
frame
- the frame to writeWebSocketBase writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
writeFrame(WebSocketFrame)
but with an handler
called when the operation completesWebSocketBase writeFinalTextFrame(String text)
text
- The text to writeWebSocketBase writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)
writeFinalTextFrame(String, Handler)
but with an handler
called when the operation completesWebSocketBase writeFinalBinaryFrame(Buffer data)
data
- The data to writeWebSocketBase writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
writeFinalBinaryFrame(Buffer, Handler)
but with an handler
called when the operation completesWebSocketBase writeBinaryMessage(Buffer data)
data
- the data to writeWebSocketBase writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
writeBinaryMessage(Buffer)
but with an handler
called when the operation completesWebSocketBase writeTextMessage(String text)
text
- the data to writeWebSocketBase writeTextMessage(String text, Handler<AsyncResult<Void>> handler)
writeTextMessage(String)
but with an handler
called when the operation completesWebSocketBase writePing(Buffer data)
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.
data
- the data to write, may be at most 125 bytesWebSocketBase writePong(Buffer data)
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.
data
- the data to write, may be at most 125 bytesWebSocketBase closeHandler(Handler<Void> handler)
closeStatusCode()
will return the status code and closeReason()
will return the reason.handler
- the handlerWebSocketBase frameHandler(Handler<WebSocketFrame> handler)
handler
- the handlerWebSocketBase textMessageHandler(Handler<String> handler)
binaryMessageHandler(Handler)
, but the buffer will be converted to a String firsthandler
- the handlerWebSocketBase binaryMessageHandler(Handler<Buffer> handler)
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).handler
- the handlerWebSocketBase pongHandler(Handler<Buffer> handler)
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.
handler
- the handlervoid end()
close()
end
in interface WriteStream<Buffer>
void end(Handler<AsyncResult<Void>> handler)
close(Handler)
end
in interface WriteStream<Buffer>
void close()
void close(Handler<AsyncResult<Void>> handler)
close()
but with an handler
called when the operation completesvoid close(short statusCode)
statusCode
- Status codevoid close(short statusCode, Handler<AsyncResult<Void>> handler)
close(short)
but with an handler
called when the operation completesvoid close(short statusCode, String reason)
statusCode
- Status codereason
- reason of closurevoid close(short statusCode, String reason, Handler<AsyncResult<Void>> handler)
close(short, String)
but with an handler
called when the operation completesSocketAddress remoteAddress()
null
(e.g a server bound on a domain socket)SocketAddress localAddress()
null
(e.g a server bound on a domain socket)boolean isSsl()
HttpConnection
is encrypted via SSL/TLS.boolean isClosed()
true
if the WebSocket is closedSSLSession sslSession()
SSLSession
X509Certificate[] peerCertificateChain() throws SSLPeerUnverifiedException
sslSession()
to
access that method.SSLPeerUnverifiedException
- SSL peer's identity has not been verified.SSLSession.getPeerCertificateChain()
,
sslSession()
Copyright © 2023 Eclipse. All rights reserved.