public class WebSocket extends Object implements WebSocketBase
original non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<WebSocket> |
__TYPE_ARG |
| Constructor and Description |
|---|
WebSocket(Object delegate) |
WebSocket(WebSocket delegate) |
| 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
WebSocketBase.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
WebSocketBase.close() 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 but with an
handler called when the operation completes |
WebSocket |
closeHandler(Handler<Void> handler)
Set a close handler.
|
Observable<Void> |
closeObservable()
Deprecated.
use
rxClose() instead |
Observable<Void> |
closeObservable(short statusCode)
Deprecated.
use
rxClose() instead |
Observable<Void> |
closeObservable(short statusCode,
String reason)
Deprecated.
use
rxClose() instead |
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. |
WebSocket |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
void |
end()
Calls
WebSocketBase.close() |
void |
end(Buffer data)
Same as
WebSocketBase.end(io.vertx.rxjava.core.buffer.Buffer) but writes some data to the stream before ending. |
void |
end(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as but with an
handler called when the operation completes |
void |
end(Handler<AsyncResult<Void>> handler)
Calls
WebSocketBase.close() |
WebSocket |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
Observable<Void> |
endObservable()
Deprecated.
use
rxEnd(io.vertx.rxjava.core.buffer.Buffer) instead |
Observable<Void> |
endObservable(Buffer data)
Deprecated.
use
rxEnd(io.vertx.rxjava.core.buffer.Buffer) instead |
boolean |
equals(Object o) |
WebSocket |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
WebSocket |
fetch(long amount)
Fetch the specified
amount of elements. |
WebSocket |
frameHandler(Handler<WebSocketFrame> handler)
Set a frame handler on the connection.
|
WebSocket |
getDelegate() |
WebSocket |
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 WebSocket |
newInstance(WebSocket arg) |
WebSocket |
pause()
Pause the
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
Pipe<Buffer> |
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .
|
void |
pipeTo(WriteStream<Buffer> dst)
Like
ReadStream.pipeTo(io.vertx.rxjava.core.streams.WriteStream<T>) but with no completion handler. |
void |
pipeTo(WriteStream<Buffer> dst,
Handler<AsyncResult<Void>> handler)
Pipe this
ReadStream to the WriteStream. |
Observable<Void> |
pipeToObservable(WriteStream<Buffer> dst)
Deprecated.
|
WebSocketBase |
pongHandler(Handler<Buffer> handler)
Set a pong frame handler on the connection.
|
SocketAddress |
remoteAddress() |
WebSocket |
resume()
Resume reading, and sets the buffer in
flowing mode. |
Single<Void> |
rxClose()
Same as
WebSocketBase.close() but with an handler called when the operation completes |
Single<Void> |
rxClose(short statusCode)
Same as
WebSocketBase.close() but with an handler called when the operation completes |
Single<Void> |
rxClose(short statusCode,
String reason)
Same as but with an
handler called when the operation completes |
Single<Void> |
rxEnd()
Calls
WebSocketBase.close() |
Single<Void> |
rxEnd(Buffer data)
Same as but with an
handler called when the operation completes |
Single<Void> |
rxPipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream. |
Single<Void> |
rxWrite(Buffer data) |
Single<Void> |
rxWriteBinaryMessage(Buffer data) |
Single<Void> |
rxWriteFinalBinaryFrame(Buffer data) |
Single<Void> |
rxWriteFinalTextFrame(String text) |
Single<Void> |
rxWriteFrame(WebSocketFrame frame) |
Single<Void> |
rxWriteTextMessage(String text) |
WebSocket |
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.
|
Observable<Buffer> |
toObservable() |
String |
toString() |
io.vertx.rx.java.WriteStreamSubscriber<Buffer> |
toSubscriber() |
WebSocket |
write(Buffer data)
Write some data to the stream.
|
WebSocket |
write(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as but with an
handler called when the operation completes |
WebSocket |
writeBinaryMessage(Buffer data)
Writes a (potentially large) piece of binary data to the connection.
|
WebSocket |
writeBinaryMessage(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeBinaryMessage(io.vertx.rxjava.core.buffer.Buffer) but with an handler called when the operation completes |
Observable<Void> |
writeBinaryMessageObservable(Buffer data)
Deprecated.
|
WebSocket |
writeFinalBinaryFrame(Buffer data)
Write a final WebSocket binary frame to the connection
|
WebSocket |
writeFinalBinaryFrame(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava.core.buffer.Buffer) but with an handler called when the operation completes |
Observable<Void> |
writeFinalBinaryFrameObservable(Buffer data)
Deprecated.
|
WebSocket |
writeFinalTextFrame(String text)
Write a final WebSocket text frame to the connection
|
WebSocket |
writeFinalTextFrame(String text,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFinalTextFrame(java.lang.String) but with an handler called when the operation completes |
Observable<Void> |
writeFinalTextFrameObservable(String text)
Deprecated.
|
WebSocket |
writeFrame(WebSocketFrame frame)
Write a WebSocket frame to the connection
|
WebSocket |
writeFrame(WebSocketFrame frame,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeFrame(io.vertx.rxjava.core.http.WebSocketFrame) but with an handler called when the operation completes |
Observable<Void> |
writeFrameObservable(WebSocketFrame frame)
Deprecated.
|
Observable<Void> |
writeObservable(Buffer data)
Deprecated.
|
WebSocketBase |
writePing(Buffer data)
Writes a ping frame to the connection.
|
WebSocketBase |
writePong(Buffer data)
Writes a pong frame to the connection.
|
boolean |
writeQueueFull()
This will return
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int) |
WebSocket |
writeTextMessage(String text)
Writes a (potentially large) piece of text data to the connection.
|
WebSocket |
writeTextMessage(String text,
Handler<AsyncResult<Void>> handler)
Same as
WebSocketBase.writeTextMessage(java.lang.String) but with an handler called when the operation completes |
Observable<Void> |
writeTextMessageObservable(String text)
Deprecated.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitnewInstancenewInstance, newInstancenewInstance, newInstancenewInstancepublic static final io.vertx.lang.rx.TypeArg<WebSocket> __TYPE_ARG
public WebSocket(WebSocket delegate)
public WebSocket(Object delegate)
public WebSocket getDelegate()
getDelegate in interface WebSocketBasegetDelegate in interface ReadStream<Buffer>getDelegate in interface StreamBasegetDelegate in interface WriteStream<Buffer>public Observable<Buffer> toObservable()
toObservable in interface ReadStream<Buffer>public io.vertx.rx.java.WriteStreamSubscriber<Buffer> toSubscriber()
public void end(Buffer data)
WebSocketBase.end(io.vertx.rxjava.core.buffer.Buffer) but writes some data to the stream before ending.end in interface WebSocketBaseend in interface WriteStream<Buffer>data - the data to writepublic void end(Buffer data, Handler<AsyncResult<Void>> handler)
handler called when the operation completesend in interface WebSocketBaseend in interface WriteStream<Buffer>data - handler - @Deprecated public Observable<Void> endObservable(Buffer data)
rxEnd(io.vertx.rxjava.core.buffer.Buffer) insteadhandler called when the operation completesdata - public Single<Void> rxEnd(Buffer data)
handler called when the operation completesdata - public boolean writeQueueFull()
true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize(int)writeQueueFull in interface WebSocketBasewriteQueueFull in interface WriteStream<Buffer>public Pipe<Buffer> pipe()
WriteStream.pipe in interface WebSocketBasepipe in interface ReadStream<Buffer>public void pipeTo(WriteStream<Buffer> dst)
ReadStream.pipeTo(io.vertx.rxjava.core.streams.WriteStream<T>) but with no completion handler.pipeTo in interface WebSocketBasepipeTo in interface ReadStream<Buffer>dst - public void pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
ReadStream to the WriteStream.
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.
pipeTo in interface WebSocketBasepipeTo in interface ReadStream<Buffer>dst - the destination write streamhandler - @Deprecated public Observable<Void> pipeToObservable(WriteStream<Buffer> dst)
rxPipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.buffer.Buffer>) insteadReadStream to the WriteStream.
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.
dst - the destination write streampublic Single<Void> rxPipeTo(WriteStream<Buffer> dst)
ReadStream to the WriteStream.
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.
dst - the destination write streampublic String 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.
binaryHandlerID in interface WebSocketBasepublic 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.
textHandlerID in interface WebSocketBasepublic String subProtocol()
null when the handler receives the websocket callback as the
handshake will not be completed yet.subProtocol in interface WebSocketBasepublic Short closeStatusCode()
null when not yet received.closeStatusCode in interface WebSocketBasepublic String closeReason()
null when not yet received.closeReason in interface WebSocketBasepublic MultiMap headers()
null on subsequent interactions.headers in interface WebSocketBasepublic WebSocketBase 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.
writePing in interface WebSocketBasedata - the data to write, may be at most 125 bytespublic WebSocketBase 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.
writePong in interface WebSocketBasedata - the data to write, may be at most 125 bytespublic WebSocketBase textMessageHandler(Handler<String> handler)
textMessageHandler in interface WebSocketBasehandler - the handlerpublic WebSocketBase binaryMessageHandler(Handler<Buffer> handler)
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 (using WebSocketFrame.isFinal() to find the boundaries).binaryMessageHandler in interface WebSocketBasehandler - the handlerpublic WebSocketBase 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.
pongHandler in interface WebSocketBasehandler - the handlerpublic void end()
WebSocketBase.close()end in interface WebSocketBaseend in interface WriteStream<Buffer>public void end(Handler<AsyncResult<Void>> handler)
WebSocketBase.close()end in interface WebSocketBaseend in interface WriteStream<Buffer>handler - @Deprecated public Observable<Void> endObservable()
rxEnd(io.vertx.rxjava.core.buffer.Buffer) insteadWebSocketBase.close()public Single<Void> rxEnd()
WebSocketBase.close()public void close()
close in interface WebSocketBasepublic void close(Handler<AsyncResult<Void>> handler)
WebSocketBase.close() but with an handler called when the operation completesclose in interface WebSocketBasehandler - @Deprecated public Observable<Void> closeObservable()
rxClose() insteadWebSocketBase.close() but with an handler called when the operation completespublic Single<Void> rxClose()
WebSocketBase.close() but with an handler called when the operation completespublic void close(short statusCode)
close in interface WebSocketBasestatusCode - Status codepublic void close(short statusCode,
Handler<AsyncResult<Void>> handler)
WebSocketBase.close() but with an handler called when the operation completesclose in interface WebSocketBasestatusCode - handler - @Deprecated public Observable<Void> closeObservable(short statusCode)
rxClose() insteadWebSocketBase.close() but with an handler called when the operation completesstatusCode - public Single<Void> rxClose(short statusCode)
WebSocketBase.close() but with an handler called when the operation completesstatusCode - public void close(short statusCode,
String reason)
close in interface WebSocketBasestatusCode - Status codereason - reason of closurepublic void close(short statusCode,
String reason,
Handler<AsyncResult<Void>> handler)
handler called when the operation completesclose in interface WebSocketBasestatusCode - reason - handler - @Deprecated public Observable<Void> closeObservable(short statusCode, String reason)
rxClose() insteadhandler called when the operation completesstatusCode - reason - public Single<Void> rxClose(short statusCode, String reason)
handler called when the operation completesstatusCode - reason - public SocketAddress remoteAddress()
remoteAddress in interface WebSocketBasenull (e.g a server bound on a domain socket)public SocketAddress localAddress()
localAddress in interface WebSocketBasenull (e.g a server bound on a domain socket)public boolean isSsl()
isSsl in interface WebSocketBaseHttpConnection is encrypted via SSL/TLS.public boolean isClosed()
isClosed in interface WebSocketBasetrue if the WebSocket is closedpublic WebSocket exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface WebSocketBaseexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerpublic WebSocket handler(Handler<Buffer> handler)
ReadStreamhandler in interface WebSocketBasehandler in interface ReadStream<Buffer>public WebSocket pause()
ReadStreamReadStream, 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 WebSocketBasepause in interface ReadStream<Buffer>public WebSocket resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface WebSocketBaseresume in interface ReadStream<Buffer>public WebSocket fetch(long amount)
ReadStreamamount 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 WebSocketBasefetch in interface ReadStream<Buffer>public WebSocket endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface WebSocketBaseendHandler in interface ReadStream<Buffer>public WebSocket write(Buffer data)
WriteStreamWriteStream.writeQueueFull() method before writing. This is done automatically if using a Pump.write in interface WebSocketBasewrite in interface WriteStream<Buffer>data - the data to writepublic WebSocket write(Buffer data, Handler<AsyncResult<Void>> handler)
WriteStreamhandler called when the operation completeswrite in interface WebSocketBasewrite in interface WriteStream<Buffer>@Deprecated public Observable<Void> writeObservable(Buffer data)
public WebSocket setWriteQueueMaxSize(int maxSize)
WriteStreammaxSize. 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 WebSocketBasesetWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streampublic WebSocket drainHandler(Handler<Void> handler)
WriteStreamPump 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 WebSocketBasedrainHandler in interface WriteStream<Buffer>handler - the handlerpublic WebSocket writeFrame(WebSocketFrame frame)
WebSocketBasewriteFrame in interface WebSocketBaseframe - the frame to writepublic WebSocket writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeFrame(io.vertx.rxjava.core.http.WebSocketFrame) but with an handler called when the operation completeswriteFrame in interface WebSocketBase@Deprecated public Observable<Void> writeFrameObservable(WebSocketFrame frame)
public Single<Void> rxWriteFrame(WebSocketFrame frame)
public WebSocket writeFinalTextFrame(String text)
WebSocketBasewriteFinalTextFrame in interface WebSocketBasetext - The text to writepublic WebSocket writeFinalTextFrame(String text, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeFinalTextFrame(java.lang.String) but with an handler called when the operation completeswriteFinalTextFrame in interface WebSocketBase@Deprecated public Observable<Void> writeFinalTextFrameObservable(String text)
public WebSocket writeFinalBinaryFrame(Buffer data)
WebSocketBasewriteFinalBinaryFrame in interface WebSocketBasedata - The data to writepublic WebSocket writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeFinalBinaryFrame(io.vertx.rxjava.core.buffer.Buffer) but with an handler called when the operation completeswriteFinalBinaryFrame in interface WebSocketBase@Deprecated public Observable<Void> writeFinalBinaryFrameObservable(Buffer data)
public WebSocket writeBinaryMessage(Buffer data)
WebSocketBasewriteBinaryMessage in interface WebSocketBasedata - the data to writepublic WebSocket writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeBinaryMessage(io.vertx.rxjava.core.buffer.Buffer) but with an handler called when the operation completeswriteBinaryMessage in interface WebSocketBase@Deprecated public Observable<Void> writeBinaryMessageObservable(Buffer data)
public WebSocket writeTextMessage(String text)
WebSocketBasewriteTextMessage in interface WebSocketBasetext - the data to writepublic WebSocket writeTextMessage(String text, Handler<AsyncResult<Void>> handler)
WebSocketBaseWebSocketBase.writeTextMessage(java.lang.String) but with an handler called when the operation completeswriteTextMessage in interface WebSocketBase@Deprecated public Observable<Void> writeTextMessageObservable(String text)
public WebSocket closeHandler(Handler<Void> handler)
WebSocketBaseWebSocketBase.closeStatusCode() will return the status code and WebSocketBase.closeReason() will return the reason.closeHandler in interface WebSocketBasehandler - the handlerpublic WebSocket frameHandler(Handler<WebSocketFrame> handler)
WebSocketBaseframeHandler in interface WebSocketBasehandler - the handlerpublic SSLSession sslSession()
Copyright © 2021 Eclipse. All rights reserved.