public interface ClientWebSocket extends WebSocket
| Modifier and Type | Method and Description |
|---|---|
ClientWebSocket |
binaryMessageHandler(Handler<Buffer> handler)
Set a binary message handler on the connection.
|
ClientWebSocket |
closeHandler(Handler<Void> handler)
Set a close handler.
|
default Future<WebSocket> |
connect(int port,
String host,
String requestURI)
Like
connect(int, String, String, Handler) but returns a Future of the asynchronous result |
default void |
connect(int port,
String host,
String requestURI,
Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the specified port, host and relative request URI
|
default Future<WebSocket> |
connect(String requestURI)
Connect this WebSocket at the relative request URI using the default host and port.
|
default void |
connect(String requestURI,
Handler<AsyncResult<WebSocket>> handler)
Connect this WebSocket at the relative request URI using the default host and port.
|
default Future<WebSocket> |
connect(String host,
String requestURI)
Connect this WebSocket to the host and relative request URI and default port.
|
default void |
connect(String host,
String requestURI,
Handler<AsyncResult<WebSocket>> handler)
Connect this WebSocket to the host and relative request URI and default port.
|
Future<WebSocket> |
connect(WebSocketConnectOptions options)
Like
connect(WebSocketConnectOptions, Handler) but returns a Future of the asynchronous result |
void |
connect(WebSocketConnectOptions options,
Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket with the specified options.
|
ClientWebSocket |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
ClientWebSocket |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
ClientWebSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
ClientWebSocket |
frameHandler(Handler<WebSocketFrame> handler)
Set a frame handler on the connection.
|
ClientWebSocket |
handler(Handler<Buffer> handler)
Set a data handler.
|
ClientWebSocket |
pongHandler(Handler<Buffer> handler)
Set a pong frame handler on the connection.
|
ClientWebSocket |
textMessageHandler(Handler<String> handler)
Set a text message handler on the connection.
|
ClientWebSocket |
writeBinaryMessage(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeBinaryMessage(Buffer) but with an handler called when the operation completes |
ClientWebSocket |
writeFinalBinaryFrame(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFinalBinaryFrame(Buffer, Handler) but with an handler called when the operation completes |
ClientWebSocket |
writeFinalTextFrame(String text,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFinalTextFrame(String, Handler) but with an handler called when the operation completes |
ClientWebSocket |
writeFrame(WebSocketFrame frame,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFrame(WebSocketFrame) but with an handler called when the operation completes |
ClientWebSocket |
writePing(Buffer data,
Handler<AsyncResult<Void>> handler)
Writes a ping frame to the connection.
|
ClientWebSocket |
writePong(Buffer data,
Handler<AsyncResult<Void>> handler)
Writes a pong frame to the connection.
|
ClientWebSocket |
writeTextMessage(String text,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeTextMessage(String) but with an handler called when the operation completes |
fetch, pause, resume, setWriteQueueMaxSizebinaryHandlerID, close, close, close, close, close, close, closeReason, closeStatusCode, end, end, headers, isClosed, isSsl, localAddress, peerCertificateChain, peerCertificates, remoteAddress, sslSession, subProtocol, textHandlerID, writeBinaryMessage, writeFinalBinaryFrame, writeFinalTextFrame, writeFrame, writePing, writePong, writeTextMessagecollect, pipe, pipeTo, pipeToend, end, write, write, writeQueueFulldefault void connect(int port,
String host,
String requestURI,
Handler<AsyncResult<WebSocket>> handler)
port - the porthost - the hostrequestURI - the relative URIhandler - handler that will be called with the WebSocket when connecteddefault Future<WebSocket> connect(int port, String host, String requestURI)
connect(int, String, String, Handler) but returns a Future of the asynchronous resultvoid connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)
options - the request optionshandler - handler that will be called with the WebSocket when connectedFuture<WebSocket> connect(WebSocketConnectOptions options)
connect(WebSocketConnectOptions, Handler) but returns a Future of the asynchronous resultdefault void connect(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
host - the hostrequestURI - the relative URIhandler - handler that will be called with the WebSocket when connecteddefault Future<WebSocket> connect(String host, String requestURI)
host - the hostrequestURI - the relative URIdefault void connect(String requestURI, Handler<AsyncResult<WebSocket>> handler)
requestURI - the relative URIhandler - handler that will be called with the WebSocket when connecteddefault Future<WebSocket> connect(String requestURI)
requestURI - the relative URIClientWebSocket handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>handler in interface WebSockethandler in interface WebSocketBaseClientWebSocket endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>endHandler in interface WebSocketendHandler in interface WebSocketBaseClientWebSocket drainHandler(Handler<Void> handler)
WriteStreamPipe 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 WebSocketdrainHandler in interface WebSocketBasedrainHandler in interface WriteStream<Buffer>handler - the handlerClientWebSocket closeHandler(Handler<Void> handler)
WebSocketBaseWebSocketBase.closeStatusCode() will return the status code and WebSocketBase.closeReason() will return the reason.closeHandler in interface WebSocketcloseHandler in interface WebSocketBasehandler - the handlerClientWebSocket frameHandler(Handler<WebSocketFrame> handler)
WebSocketBaseframeHandler in interface WebSocketframeHandler in interface WebSocketBasehandler - the handlerClientWebSocket textMessageHandler(Handler<String> handler)
WebSocketBaseWebSocketBase.binaryMessageHandler(Handler), but the buffer will be converted to a String firsttextMessageHandler in interface WebSocketBasehandler - the handlerClientWebSocket binaryMessageHandler(Handler<Buffer> handler)
WebSocketBaseWebSocketBase.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).binaryMessageHandler in interface WebSocketBasehandler - the handlerClientWebSocket pongHandler(Handler<Buffer> handler)
WebSocketBasePong 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.
pongHandler in interface WebSocketBasehandler - the handlerClientWebSocket exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WebSocketexceptionHandler in interface WebSocketBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerClientWebSocket writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeFrame(WebSocketFrame) but with an handler called when the operation completeswriteFrame in interface WebSocketwriteFrame in interface WebSocketBaseClientWebSocket writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeFinalTextFrame(String, Handler) but with an handler called when the operation completeswriteFinalTextFrame in interface WebSocketwriteFinalTextFrame in interface WebSocketBaseClientWebSocket writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeFinalBinaryFrame(Buffer, Handler) but with an handler called when the operation completeswriteFinalBinaryFrame in interface WebSocketwriteFinalBinaryFrame in interface WebSocketBaseClientWebSocket writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeBinaryMessage(Buffer) but with an handler called when the operation completeswriteBinaryMessage in interface WebSocketwriteBinaryMessage in interface WebSocketBaseClientWebSocket writeTextMessage(String text, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeTextMessage(String) but with an handler called when the operation completeswriteTextMessage in interface WebSocketwriteTextMessage in interface WebSocketBaseClientWebSocket writePing(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseThis 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.
writePing in interface WebSocketwritePing in interface WebSocketBasedata - the data to write, may be at most 125 byteshandler - called when the ping frame has been successfully writtenClientWebSocket writePong(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseThis 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.
writePong in interface WebSocketwritePong in interface WebSocketBasedata - the data to write, may be at most 125 byteshandler - called when the pong frame has been successfully writtenCopyright © 2024 Eclipse. All rights reserved.