Vert.x 4.5.13 · io.vertx.core.http.impl.ClientWebSocketImpl

Modifier and Type	Field and Description
private Handler<Buffer>	binaryMessageHandler
private HttpClientBase	client
private Handler<Void>	closeHandler
private final AtomicReference<Promise<WebSocket>>	connect
private Handler<Buffer>	dataHandler
private Handler<Void>	drainHandler
private Handler<Void>	endHandler
private Handler<Throwable>	exceptionHandler
private Handler<WebSocketFrame>	frameHandler
private Handler<Buffer>	pongHandler
private Handler<String>	textMessageHandler
private volatile WebSocket	ws

Access	Constructor and Description
pack-priv	ClientWebSocketImpl(HttpClientBase client)

Method Summary

Modifier and Type	Method and Description
public String	binaryHandlerID() Implements io.vertx.core.http.WebSocketBase.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.
public ClientWebSocket	binaryMessageHandler(@Nullable Handler<Buffer> handler)
public Future<Void>	close() Implements io.vertx.core.http.WebSocketBase.close. Close the WebSocket sending the default close frame.
public void	close(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.WebSocketBase.close. Same as `close()` but with an `handler` called when the operation completes
public Future<Void>	close(short the status code statusCode) Implements io.vertx.core.http.WebSocketBase.close. Close the WebSocket sending a close frame with specified status code.
public void	close(short statusCode, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.WebSocketBase.close. Same as `close(short)` but with an `handler` called when the operation completes
public Future<Void>	close(short statusCode, @Nullable String reason)
public void	close(short statusCode, @Nullable String reason, Handler<AsyncResult<Void>> handler)
public ClientWebSocket	closeHandler(Handler<Void> handler) Implements io.vertx.core.http.ClientWebSocket.closeHandler.
public String	closeReason() Implements io.vertx.core.http.WebSocketBase.closeReason. Returns the close reason message from the remote endpoint or `null` when not yet received.
public Short	closeStatusCode() Implements io.vertx.core.http.WebSocketBase.closeStatusCode. Returns the close status code received from the remote endpoint or `null` when not yet received.
public Future<WebSocket>	connect(WebSocketConnectOptions options) Implements io.vertx.core.http.ClientWebSocket.connect. Like `connect(WebSocketConnectOptions, Handler)` but returns a `Future` of the asynchronous result
public Future<WebSocket>	connect(Context context, WebSocketConnectOptions options) Implements io.vertx.core.http.impl.ClientWebSocketInternal.connect.
private Future<WebSocket>	connect(ContextInternal ctx, WebSocketConnectOptions options)
public void	connect(WebSocketConnectOptions the request options options, Handler<AsyncResult<WebSocket>> handler that will be called with the WebSocket when connected handler) Implements io.vertx.core.http.ClientWebSocket.connect. Connect a WebSocket with the specified options.
private WebSocket	delegate()
public ClientWebSocket	drainHandler(Handler<Void> handler) Implements io.vertx.core.http.ClientWebSocket.drainHandler.
public Future<Void>	end() Implements io.vertx.core.http.WebSocketBase.end. Ends the stream.
public void	end(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.WebSocketBase.end. Same as `end()` but with an `handler` called when the operation completes Calls `close(Handler)`
public ClientWebSocket	endHandler(Handler<Void> handler) Implements io.vertx.core.http.ClientWebSocket.endHandler.
public ClientWebSocket	exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.http.ClientWebSocket.exceptionHandler.
public WebSocket	fetch(long amount) Implements io.vertx.core.http.WebSocket.fetch. Fetch the specified `amount` of elements.
public ClientWebSocket	frameHandler(Handler<WebSocketFrame> handler) Implements io.vertx.core.http.ClientWebSocket.frameHandler.
public ClientWebSocket	handler(Handler<Buffer> handler) Implements io.vertx.core.http.ClientWebSocket.handler.
public MultiMap	headers() Implements io.vertx.core.http.WebSocketBase.headers. Returns the HTTP headers when the WebSocket is first obtained in the handler.
public boolean	isClosed() Implements io.vertx.core.http.WebSocketBase.isClosed.
public boolean	isSsl() Implements io.vertx.core.http.WebSocketBase.isSsl.
public SocketAddress	localAddress() Implements io.vertx.core.http.WebSocketBase.localAddress.
public WebSocket	pause() Implements io.vertx.core.http.WebSocket.pause. Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
public X509Certificate[]	peerCertificateChain() Implements io.vertx.core.http.WebSocketBase.peerCertificateChain. References Deprecated `X509Certificate` is deprecated or references (maybe indirectly) at least one deprecated element.
public List<Certificate>	peerCertificates() Implements io.vertx.core.http.WebSocketBase.peerCertificates.
public ClientWebSocket	pongHandler(@Nullable Handler<Buffer> handler)
public SocketAddress	remoteAddress() Implements io.vertx.core.http.WebSocketBase.remoteAddress.
public WebSocket	resume() Implements io.vertx.core.http.WebSocket.resume. Resume reading, and sets the buffer in `flowing` mode.
public WebSocket	setWriteQueueMaxSize(int the max size of the write stream maxSize) Implements io.vertx.core.http.WebSocket.setWriteQueueMaxSize. Set the maximum size of the write queue to `maxSize`.
public SSLSession	sslSession() Implements io.vertx.core.http.WebSocketBase.sslSession.
public String	subProtocol() Implements io.vertx.core.http.WebSocketBase.subProtocol. Returns the WebSocket sub protocol selected by the WebSocket handshake.
public String	textHandlerID() Implements io.vertx.core.http.WebSocketBase.textHandlerID. When a `WebSocket` is created, it may register an event handler with the eventbus, the ID of that handler is given by `textHandlerID`.
public ClientWebSocket	textMessageHandler(@Nullable Handler<String> handler)
public Future<Void>	write(Buffer the data to write data) Implements io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Write some data to the stream.
public void	write(Buffer data, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `write(T)` but with an `handler` called when the operation completes
public Future<Void>	writeBinaryMessage(Buffer the data to write data) Implements io.vertx.core.http.WebSocketBase.writeBinaryMessage. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Writes a (potentially large) piece of binary data to the connection.
public ClientWebSocket	writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.ClientWebSocket.writeBinaryMessage. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `writeBinaryMessage(Buffer)` but with an `handler` called when the operation completes
public Future<Void>	writeFinalBinaryFrame(Buffer The data to write data) Implements io.vertx.core.http.WebSocketBase.writeFinalBinaryFrame. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Write a final WebSocket binary frame to the connection
public ClientWebSocket	writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.ClientWebSocket.writeFinalBinaryFrame. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `writeFinalBinaryFrame(Buffer, Handler)` but with an `handler` called when the operation completes
public Future<Void>	writeFinalTextFrame(String The text to write text) Implements io.vertx.core.http.WebSocketBase.writeFinalTextFrame. Write a final WebSocket text frame to the connection
public ClientWebSocket	writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.ClientWebSocket.writeFinalTextFrame. Same as `writeFinalTextFrame(String, Handler)` but with an `handler` called when the operation completes
public Future<Void>	writeFrame(WebSocketFrame the frame to write frame) Implements io.vertx.core.http.WebSocketBase.writeFrame. Write a WebSocket frame to the connection
public ClientWebSocket	writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.ClientWebSocket.writeFrame. Same as `writeFrame(WebSocketFrame)` but with an `handler` called when the operation completes
public Future<Void>	writePing(Buffer data) Implements io.vertx.core.http.WebSocketBase.writePing. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Like `writePing(Buffer, Handler)` but with an `handler` called when the message has been written or failed to be written.
public ClientWebSocket	writePing(Buffer the data to write, may be at most 125 bytes data, Handler<AsyncResult<Void>> called when the ping frame has been successfully written handler) Implements io.vertx.core.http.ClientWebSocket.writePing. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Writes a ping frame to the connection.
public Future<Void>	writePong(Buffer data) Implements io.vertx.core.http.WebSocketBase.writePong. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Like `writePong(Buffer, Handler)` but with an `handler` called when the message has been written or failed to be written.
public ClientWebSocket	writePong(Buffer the data to write, may be at most 125 bytes data, Handler<AsyncResult<Void>> called when the pong frame has been successfully written handler) Implements io.vertx.core.http.ClientWebSocket.writePong. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Writes a pong frame to the connection.
public boolean	writeQueueFull() Implements io.vertx.core.streams.WriteStream.writeQueueFull. This will return `true` if there are more bytes in the write queue than the value set using `setWriteQueueMaxSize`
public Future<Void>	writeTextMessage(String the data to write text) Implements io.vertx.core.http.WebSocketBase.writeTextMessage. Writes a (potentially large) piece of text data to the connection.
public ClientWebSocket	writeTextMessage(String text, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.http.ClientWebSocket.writeTextMessage. Same as `writeTextMessage(String)` but with an `handler` called when the operation completes

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class ClientWebSocketImpl

Field Summary

Constructor Summary

Method Summary