Class ClientWebSocket
- java.lang.Object
-
- io.vertx.rxjava.core.http.WebSocket
-
- io.vertx.rxjava.core.http.ClientWebSocket
-
- All Implemented Interfaces:
WebSocketBase
,ReadStream<Buffer>
,StreamBase
,WriteStream<Buffer>
public class ClientWebSocket extends WebSocket
Represents a client-side WebSocket initially not connected. NOTE: This class has been automatically generated from theoriginal
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<ClientWebSocket>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description ClientWebSocket(ClientWebSocket delegate)
ClientWebSocket(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete 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.ClientWebSocket
binaryMessageHandler(Handler<Buffer> handler)
Set a binary message handler on the connection.void
close()
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
close(short statusCode)
Same asWebSocketBase.close(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 asWebSocketBase.close(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 asWebSocketBase.close(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 asWebSocketBase.close(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 asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
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.void
connect(int port, String host, String requestURI)
Connect a WebSocket to the specified port, host and relative request URIvoid
connect(int port, String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the specified port, host and relative request URIvoid
connect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.void
connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket with the specified options.void
connect(String requestURI)
Connect this WebSocket at the relative request URI using the default host and port.void
connect(String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect this WebSocket at the relative request URI using the default host and port.void
connect(String host, String requestURI)
Connect this WebSocket to the host and relative request URI and default port.void
connect(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect this WebSocket to the host and relative request URI and default port.ClientWebSocket
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 completesClientWebSocket
endHandler(Handler<Void> endHandler)
Set an end handler.boolean
equals(Object o)
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
getDelegate()
ClientWebSocket
handler(Handler<Buffer> handler)
Set a data handler.int
hashCode()
MultiMap
headers()
Returns the HTTP headers when the WebSocket is first obtained in the handler.boolean
isClosed()
boolean
isSsl()
SocketAddress
localAddress()
static ClientWebSocket
newInstance(ClientWebSocket arg)
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
.ClientWebSocket
pongHandler(Handler<Buffer> handler)
Set a pong frame handler on the connection.SocketAddress
remoteAddress()
rx.Single<Void>
rxClose()
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesrx.Single<Void>
rxClose(short statusCode)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesrx.Single<Void>
rxClose(short statusCode, String reason)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesrx.Single<WebSocket>
rxConnect(int port, String host, String requestURI)
Connect a WebSocket to the specified port, host and relative request URIrx.Single<WebSocket>
rxConnect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.rx.Single<WebSocket>
rxConnect(String requestURI)
Connect this WebSocket at the relative request URI using the default host and port.rx.Single<WebSocket>
rxConnect(String host, String requestURI)
Connect this WebSocket to the host and relative request URI and default port.rx.Single<Void>
rxEnd()
rx.Single<Void>
rxEnd(Buffer data)
Same as but with anhandler
called when the operation completesrx.Single<Void>
rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStream
to theWriteStream
.rx.Single<Void>
rxWrite(Buffer data)
Same as but with anhandler
called when the operation completesrx.Single<Void>
rxWriteBinaryMessage(Buffer data)
Same asWebSocketBase.writeBinaryMessage(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesrx.Single<Void>
rxWriteFinalBinaryFrame(Buffer data)
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesrx.Single<Void>
rxWriteFinalTextFrame(String text)
Same asWebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesrx.Single<Void>
rxWriteFrame(WebSocketFrame frame)
Same asWebSocketBase.writeFrame(io.vertx.rxjava.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesrx.Single<Void>
rxWritePing(Buffer data)
Writes a ping frame to the connection.rx.Single<Void>
rxWritePong(Buffer data)
Writes a pong frame to the connection.rx.Single<Void>
rxWriteTextMessage(String text)
Same asWebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesSSLSession
sslSession()
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
.ClientWebSocket
textMessageHandler(Handler<String> handler)
Set a text message handler on the connection.rx.Observable<Buffer>
toObservable()
String
toString()
WriteStreamSubscriber<Buffer>
toSubscriber()
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 completesClientWebSocket
writeBinaryMessage(Buffer data)
Same asWebSocketBase.writeBinaryMessage(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.writeBinaryMessage(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
writeFinalBinaryFrame(Buffer data)
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
writeFinalTextFrame(String text)
Same asWebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
writeFrame(WebSocketFrame frame)
Same asWebSocketBase.writeFrame(io.vertx.rxjava.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.writeFrame(io.vertx.rxjava.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
writePing(Buffer data)
Writes a ping frame to the connection.ClientWebSocket
writePing(Buffer data, Handler<AsyncResult<Void>> handler)
Writes a ping frame to the connection.ClientWebSocket
writePong(Buffer data)
Writes a pong frame to the connection.ClientWebSocket
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 usingWebSocket.setWriteQueueMaxSize(int)
ClientWebSocket
writeTextMessage(String text)
Same asWebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesClientWebSocket
writeTextMessage(String text, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.writeTextMessage(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 class io.vertx.rxjava.core.http.WebSocket
fetch, newInstance, pause, resume, setWriteQueueMaxSize
-
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<ClientWebSocket> __TYPE_ARG
-
-
Constructor Detail
-
ClientWebSocket
public ClientWebSocket(ClientWebSocket delegate)
-
ClientWebSocket
public ClientWebSocket(Object delegate)
-
-
Method Detail
-
getDelegate
public ClientWebSocket getDelegate()
- Specified by:
getDelegate
in interfaceReadStream<Buffer>
- Specified by:
getDelegate
in interfaceStreamBase
- Specified by:
getDelegate
in interfaceWebSocketBase
- Specified by:
getDelegate
in interfaceWriteStream<Buffer>
- Overrides:
getDelegate
in classWebSocket
-
toObservable
public rx.Observable<Buffer> toObservable()
- Specified by:
toObservable
in interfaceReadStream<Buffer>
- Overrides:
toObservable
in classWebSocket
-
toSubscriber
public WriteStreamSubscriber<Buffer> toSubscriber()
- Overrides:
toSubscriber
in classWebSocket
-
pipe
public 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>
- Specified by:
pipe
in interfaceWebSocketBase
- Overrides:
pipe
in classWebSocket
- Returns:
- a pipe
-
pipeTo
public 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>
- Specified by:
pipeTo
in interfaceWebSocketBase
- Overrides:
pipeTo
in classWebSocket
- Parameters:
dst
- the destination write streamhandler
-
-
pipeTo
public 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>
- Specified by:
pipeTo
in interfaceWebSocketBase
- Overrides:
pipeTo
in classWebSocket
- Parameters:
dst
- the destination write stream
-
rxPipeTo
public rx.Single<Void> 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>
- Specified by:
rxPipeTo
in interfaceWebSocketBase
- Overrides:
rxPipeTo
in classWebSocket
- Parameters:
dst
- the destination write stream- Returns:
-
write
public void write(Buffer data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Specified by:
write
in interfaceWebSocketBase
- Specified by:
write
in interfaceWriteStream<Buffer>
- Overrides:
write
in classWebSocket
- Parameters:
data
-handler
-
-
write
public void write(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
write
in interfaceWebSocketBase
- Specified by:
write
in interfaceWriteStream<Buffer>
- Overrides:
write
in classWebSocket
- Parameters:
data
-
-
rxWrite
public rx.Single<Void> rxWrite(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
rxWrite
in interfaceWebSocketBase
- Specified by:
rxWrite
in interfaceWriteStream<Buffer>
- Overrides:
rxWrite
in classWebSocket
- Parameters:
data
-- Returns:
-
end
public void end(Buffer data, Handler<AsyncResult<Void>> handler)
Same as but with anhandler
called when the operation completes- Specified by:
end
in interfaceWebSocketBase
- Specified by:
end
in interfaceWriteStream<Buffer>
- Overrides:
end
in classWebSocket
- Parameters:
data
-handler
-
-
end
public void end(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
end
in interfaceWebSocketBase
- Specified by:
end
in interfaceWriteStream<Buffer>
- Overrides:
end
in classWebSocket
- Parameters:
data
-
-
rxEnd
public rx.Single<Void> rxEnd(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
rxEnd
in interfaceWebSocketBase
- Specified by:
rxEnd
in interfaceWriteStream<Buffer>
- Overrides:
rxEnd
in classWebSocket
- Parameters:
data
-- Returns:
-
writeQueueFull
public boolean writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingWebSocket.setWriteQueueMaxSize(int)
- Specified by:
writeQueueFull
in interfaceWebSocketBase
- Specified by:
writeQueueFull
in interfaceWriteStream<Buffer>
- Overrides:
writeQueueFull
in classWebSocket
- Returns:
true
if write queue is full
-
binaryHandlerID
public 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.
- Specified by:
binaryHandlerID
in interfaceWebSocketBase
- Overrides:
binaryHandlerID
in classWebSocket
- Returns:
- the binary handler id
-
textHandlerID
public 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.
- Specified by:
textHandlerID
in interfaceWebSocketBase
- Overrides:
textHandlerID
in classWebSocket
- Returns:
- the text handler id
-
subProtocol
public 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.- Specified by:
subProtocol
in interfaceWebSocketBase
- Overrides:
subProtocol
in classWebSocket
- Returns:
-
closeStatusCode
public Short closeStatusCode()
Returns the close status code received from the remote endpoint ornull
when not yet received.- Specified by:
closeStatusCode
in interfaceWebSocketBase
- Overrides:
closeStatusCode
in classWebSocket
- Returns:
-
closeReason
public String closeReason()
Returns the close reason message from the remote endpoint ornull
when not yet received.- Specified by:
closeReason
in interfaceWebSocketBase
- Overrides:
closeReason
in classWebSocket
- Returns:
-
headers
public MultiMap headers()
Returns the HTTP headers when the WebSocket is first obtained in the handler. The headers will benull
on subsequent interactions.- Specified by:
headers
in interfaceWebSocketBase
- Overrides:
headers
in classWebSocket
- Returns:
- the headers
-
end
public void end(Handler<AsyncResult<Void>> handler)
- Specified by:
end
in interfaceWebSocketBase
- Specified by:
end
in interfaceWriteStream<Buffer>
- Overrides:
end
in classWebSocket
- Parameters:
handler
-
-
end
public void end()
- Specified by:
end
in interfaceWebSocketBase
- Specified by:
end
in interfaceWriteStream<Buffer>
- Overrides:
end
in classWebSocket
-
rxEnd
public rx.Single<Void> rxEnd()
- Specified by:
rxEnd
in interfaceWebSocketBase
- Specified by:
rxEnd
in interfaceWriteStream<Buffer>
- Overrides:
rxEnd
in classWebSocket
- Returns:
-
close
public void close(Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
close
in interfaceWebSocketBase
- Overrides:
close
in classWebSocket
- Parameters:
handler
-
-
close
public void close()
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
close
in interfaceWebSocketBase
- Overrides:
close
in classWebSocket
-
rxClose
public rx.Single<Void> rxClose()
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxClose
in interfaceWebSocketBase
- Overrides:
rxClose
in classWebSocket
- Returns:
-
close
public void close(short statusCode, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
close
in interfaceWebSocketBase
- Overrides:
close
in classWebSocket
- Parameters:
statusCode
-handler
-
-
close
public void close(short statusCode)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
close
in interfaceWebSocketBase
- Overrides:
close
in classWebSocket
- Parameters:
statusCode
-
-
rxClose
public rx.Single<Void> rxClose(short statusCode)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxClose
in interfaceWebSocketBase
- Overrides:
rxClose
in classWebSocket
- Parameters:
statusCode
-- Returns:
-
close
public void close(short statusCode, String reason, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
close
in interfaceWebSocketBase
- Overrides:
close
in classWebSocket
- Parameters:
statusCode
-reason
-handler
-
-
close
public void close(short statusCode, String reason)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
close
in interfaceWebSocketBase
- Overrides:
close
in classWebSocket
- Parameters:
statusCode
-reason
-
-
rxClose
public rx.Single<Void> rxClose(short statusCode, String reason)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxClose
in interfaceWebSocketBase
- Overrides:
rxClose
in classWebSocket
- Parameters:
statusCode
-reason
-- Returns:
-
remoteAddress
public SocketAddress remoteAddress()
- Specified by:
remoteAddress
in interfaceWebSocketBase
- Overrides:
remoteAddress
in classWebSocket
- 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
public SocketAddress localAddress()
- Specified by:
localAddress
in interfaceWebSocketBase
- Overrides:
localAddress
in classWebSocket
- 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
public boolean isSsl()
- Specified by:
isSsl
in interfaceWebSocketBase
- Overrides:
isSsl
in classWebSocket
- Returns:
- true if this
HttpConnection
is encrypted via SSL/TLS.
-
isClosed
public boolean isClosed()
- Specified by:
isClosed
in interfaceWebSocketBase
- Overrides:
isClosed
in classWebSocket
- Returns:
true
if the WebSocket is closed
-
connect
public void connect(int port, String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket to the specified port, host and relative request URI- Parameters:
port
- the porthost
- the hostrequestURI
- the relative URIhandler
- handler that will be called with the WebSocket when connected
-
connect
public void connect(int port, String host, String requestURI)
Connect a WebSocket to the specified port, host and relative request URI- Parameters:
port
- the porthost
- the hostrequestURI
- the relative URI
-
rxConnect
public rx.Single<WebSocket> rxConnect(int port, String host, String requestURI)
Connect a WebSocket to the specified port, host and relative request URI- Parameters:
port
- the porthost
- the hostrequestURI
- the relative URI- Returns:
-
connect
public void connect(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket with the specified options.- Parameters:
options
- the request optionshandler
- handler that will be called with the WebSocket when connected
-
connect
public void connect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.- Parameters:
options
- the request options
-
rxConnect
public rx.Single<WebSocket> rxConnect(WebSocketConnectOptions options)
Connect a WebSocket with the specified options.- Parameters:
options
- the request options- Returns:
-
connect
public void connect(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect this WebSocket to the host and relative request URI and default port.- Parameters:
host
- the hostrequestURI
- the relative URIhandler
- handler that will be called with the WebSocket when connected
-
connect
public void connect(String host, String requestURI)
Connect this WebSocket to the host and relative request URI and default port.- Parameters:
host
- the hostrequestURI
- the relative URI
-
rxConnect
public rx.Single<WebSocket> rxConnect(String host, String requestURI)
Connect this WebSocket to the host and relative request URI and default port.- Parameters:
host
- the hostrequestURI
- the relative URI- Returns:
-
connect
public void connect(String requestURI, Handler<AsyncResult<WebSocket>> handler)
Connect this WebSocket at the relative request URI using the default host and port.- Parameters:
requestURI
- the relative URIhandler
- handler that will be called with the WebSocket when connected
-
connect
public void connect(String requestURI)
Connect this WebSocket at the relative request URI using the default host and port.- Parameters:
requestURI
- the relative URI
-
rxConnect
public rx.Single<WebSocket> rxConnect(String requestURI)
Connect this WebSocket at the relative request URI using the default host and port.- Parameters:
requestURI
- the relative URI- Returns:
-
handler
public ClientWebSocket 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>
- Specified by:
handler
in interfaceWebSocketBase
- Overrides:
handler
in classWebSocket
- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public ClientWebSocket 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>
- Specified by:
endHandler
in interfaceWebSocketBase
- Overrides:
endHandler
in classWebSocket
- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
public ClientWebSocket 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 interfaceWebSocketBase
- Specified by:
drainHandler
in interfaceWriteStream<Buffer>
- Overrides:
drainHandler
in classWebSocket
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
closeHandler
public ClientWebSocket closeHandler(Handler<Void> handler)
Description copied from interface:WebSocketBase
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, theWebSocketBase.closeStatusCode()
will return the status code andWebSocketBase.closeReason()
will return the reason.- Specified by:
closeHandler
in interfaceWebSocketBase
- Overrides:
closeHandler
in classWebSocket
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
frameHandler
public ClientWebSocket frameHandler(Handler<WebSocketFrame> handler)
Description copied from interface:WebSocketBase
Set a frame handler on the connection. This handler will be called when frames are read on the connection.- Specified by:
frameHandler
in interfaceWebSocketBase
- Overrides:
frameHandler
in classWebSocket
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
textMessageHandler
public ClientWebSocket textMessageHandler(Handler<String> handler)
Description copied from class:WebSocket
Set a text message handler on the connection. This handler will be called similar to theWebSocketBase.binaryMessageHandler(io.vertx.core.Handler<io.vertx.rxjava.core.buffer.Buffer>)
, but the buffer will be converted to a String first- Specified by:
textMessageHandler
in interfaceWebSocketBase
- Overrides:
textMessageHandler
in classWebSocket
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
binaryMessageHandler
public ClientWebSocket binaryMessageHandler(Handler<Buffer> handler)
Description copied from class:WebSocket
Set a binary message handler on the connection. This handler serves a similar purpose toWebSocket.handler(io.vertx.core.Handler<io.vertx.rxjava.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).- Specified by:
binaryMessageHandler
in interfaceWebSocketBase
- Overrides:
binaryMessageHandler
in classWebSocket
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
pongHandler
public ClientWebSocket pongHandler(Handler<Buffer> handler)
Description copied from class:WebSocket
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.
- Specified by:
pongHandler
in interfaceWebSocketBase
- Overrides:
pongHandler
in classWebSocket
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
exceptionHandler
public ClientWebSocket 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 interfaceWebSocketBase
- Specified by:
exceptionHandler
in interfaceWriteStream<Buffer>
- Overrides:
exceptionHandler
in classWebSocket
- Parameters:
handler
- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
writeFrame
public ClientWebSocket writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFrame(io.vertx.rxjava.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeFrame
in interfaceWebSocketBase
- Overrides:
writeFrame
in classWebSocket
- Returns:
-
writeFrame
public ClientWebSocket writeFrame(WebSocketFrame frame)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFrame(io.vertx.rxjava.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeFrame
in interfaceWebSocketBase
- Overrides:
writeFrame
in classWebSocket
- Returns:
-
rxWriteFrame
public rx.Single<Void> rxWriteFrame(WebSocketFrame frame)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFrame(io.vertx.rxjava.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxWriteFrame
in interfaceWebSocketBase
- Overrides:
rxWriteFrame
in classWebSocket
- Returns:
-
writeFinalTextFrame
public ClientWebSocket writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeFinalTextFrame
in interfaceWebSocketBase
- Overrides:
writeFinalTextFrame
in classWebSocket
- Returns:
-
writeFinalTextFrame
public ClientWebSocket writeFinalTextFrame(String text)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeFinalTextFrame
in interfaceWebSocketBase
- Overrides:
writeFinalTextFrame
in classWebSocket
- Returns:
-
rxWriteFinalTextFrame
public rx.Single<Void> rxWriteFinalTextFrame(String text)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFinalTextFrame(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxWriteFinalTextFrame
in interfaceWebSocketBase
- Overrides:
rxWriteFinalTextFrame
in classWebSocket
- Returns:
-
writeFinalBinaryFrame
public ClientWebSocket writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeFinalBinaryFrame
in interfaceWebSocketBase
- Overrides:
writeFinalBinaryFrame
in classWebSocket
- Returns:
-
writeFinalBinaryFrame
public ClientWebSocket writeFinalBinaryFrame(Buffer data)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeFinalBinaryFrame
in interfaceWebSocketBase
- Overrides:
writeFinalBinaryFrame
in classWebSocket
- Returns:
-
rxWriteFinalBinaryFrame
public rx.Single<Void> rxWriteFinalBinaryFrame(Buffer data)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxWriteFinalBinaryFrame
in interfaceWebSocketBase
- Overrides:
rxWriteFinalBinaryFrame
in classWebSocket
- Returns:
-
writeBinaryMessage
public ClientWebSocket writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeBinaryMessage(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeBinaryMessage
in interfaceWebSocketBase
- Overrides:
writeBinaryMessage
in classWebSocket
- Returns:
-
writeBinaryMessage
public ClientWebSocket writeBinaryMessage(Buffer data)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeBinaryMessage(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeBinaryMessage
in interfaceWebSocketBase
- Overrides:
writeBinaryMessage
in classWebSocket
- Returns:
-
rxWriteBinaryMessage
public rx.Single<Void> rxWriteBinaryMessage(Buffer data)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeBinaryMessage(io.vertx.rxjava.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxWriteBinaryMessage
in interfaceWebSocketBase
- Overrides:
rxWriteBinaryMessage
in classWebSocket
- Returns:
-
writeTextMessage
public ClientWebSocket writeTextMessage(String text, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeTextMessage
in interfaceWebSocketBase
- Overrides:
writeTextMessage
in classWebSocket
- Returns:
-
writeTextMessage
public ClientWebSocket writeTextMessage(String text)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
writeTextMessage
in interfaceWebSocketBase
- Overrides:
writeTextMessage
in classWebSocket
- Returns:
-
rxWriteTextMessage
public rx.Single<Void> rxWriteTextMessage(String text)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeTextMessage(java.lang.String, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Specified by:
rxWriteTextMessage
in interfaceWebSocketBase
- Overrides:
rxWriteTextMessage
in classWebSocket
- Returns:
-
writePing
public ClientWebSocket writePing(Buffer data, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
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.
- Specified by:
writePing
in interfaceWebSocketBase
- Overrides:
writePing
in classWebSocket
- 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
public ClientWebSocket writePing(Buffer data)
Description copied from interface:WebSocketBase
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.
- Specified by:
writePing
in interfaceWebSocketBase
- Overrides:
writePing
in classWebSocket
- 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
public rx.Single<Void> rxWritePing(Buffer data)
Description copied from interface:WebSocketBase
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.
- Specified by:
rxWritePing
in interfaceWebSocketBase
- Overrides:
rxWritePing
in classWebSocket
- 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
public ClientWebSocket writePong(Buffer data, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
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.
- Specified by:
writePong
in interfaceWebSocketBase
- Overrides:
writePong
in classWebSocket
- 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
public ClientWebSocket writePong(Buffer data)
Description copied from interface:WebSocketBase
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.
- Specified by:
writePong
in interfaceWebSocketBase
- Overrides:
writePong
in classWebSocket
- 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
public rx.Single<Void> rxWritePong(Buffer data)
Description copied from interface:WebSocketBase
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.
- Specified by:
rxWritePong
in interfaceWebSocketBase
- Overrides:
rxWritePong
in classWebSocket
- Parameters:
data
- the data to write, may be at most 125 bytes- Returns:
- a reference to this, so the API can be used fluently
-
sslSession
public SSLSession sslSession()
- Overrides:
sslSession
in classWebSocket
- Returns:
- SSLSession associated with the underlying socket. Returns null if connection is not SSL.
-
newInstance
public static ClientWebSocket newInstance(ClientWebSocket arg)
-
-