Class WebSocket
- java.lang.Object
-
- io.vertx.reactivex.core.http.WebSocket
-
- All Implemented Interfaces:
WebSocketBase
,ReadStream<Buffer>
,StreamBase
,WriteStream<Buffer>
public class WebSocket extends Object implements WebSocketBase
Represents a client-side WebSocket. 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<WebSocket>
__TYPE_ARG
-
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.WebSocketBase
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 completesWebSocket
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.WebSocket
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 completesWebSocket
endHandler(Handler<Void> endHandler)
Set an end handler.boolean
equals(Object o)
WebSocket
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.WebSocket
fetch(long amount)
Fetch the specifiedamount
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 theReadStream
, it sets the buffer infetch
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)
Pipe thisReadStream
to theWriteStream
.void
pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
Pipe thisReadStream
to theWriteStream
.WebSocketBase
pongHandler(Handler<Buffer> handler)
Set a pong frame handler on the connection.SocketAddress
remoteAddress()
WebSocket
resume()
Resume reading, and sets the buffer inflowing
mode.io.reactivex.Completable
rxClose()
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxClose(short statusCode)
Same asWebSocketBase.close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
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 completesio.reactivex.Completable
rxEnd()
io.reactivex.Completable
rxEnd(Buffer data)
Same as but with anhandler
called when the operation completesio.reactivex.Completable
rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStream
to theWriteStream
.io.reactivex.Completable
rxWrite(Buffer data)
Same as but with anhandler
called when the operation completesio.reactivex.Completable
rxWriteBinaryMessage(Buffer data)
Same asWebSocketBase.writeBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxWriteFinalBinaryFrame(Buffer data)
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
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 completesio.reactivex.Completable
rxWriteFrame(WebSocketFrame frame)
Same asWebSocketBase.writeFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxWritePing(Buffer data)
Writes a ping frame to the connection.io.reactivex.Completable
rxWritePong(Buffer data)
Writes a pong frame to the connection.io.reactivex.Completable
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 completesWebSocket
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue tomaxSize
.SSLSession
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
.WebSocketBase
textMessageHandler(Handler<String> handler)
Set a text message handler on the connection.io.reactivex.Flowable<Buffer>
toFlowable()
io.reactivex.Observable<Buffer>
toObservable()
WriteStreamObserver<Buffer>
toObserver()
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 completesWebSocket
writeBinaryMessage(Buffer data)
Same asWebSocketBase.writeBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocket
writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.writeBinaryMessage(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocket
writeFinalBinaryFrame(Buffer data)
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocket
writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.core.buffer.Buffer, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocket
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 completesWebSocket
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 completesWebSocket
writeFrame(WebSocketFrame frame)
Same asWebSocketBase.writeFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocket
writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
Same asWebSocketBase.writeFrame(io.vertx.reactivex.core.http.WebSocketFrame, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesWebSocketBase
writePing(Buffer data)
Writes a ping frame to the connection.WebSocketBase
writePing(Buffer data, Handler<AsyncResult<Void>> handler)
Writes a ping frame to the connection.WebSocketBase
writePong(Buffer data)
Writes a pong frame to the connection.WebSocketBase
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 usingsetWriteQueueMaxSize(int)
WebSocket
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 completesWebSocket
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
-
-
-
Method Detail
-
getDelegate
public WebSocket getDelegate()
- Specified by:
getDelegate
in interfaceReadStream<Buffer>
- Specified by:
getDelegate
in interfaceStreamBase
- Specified by:
getDelegate
in interfaceWebSocketBase
- Specified by:
getDelegate
in interfaceWriteStream<Buffer>
-
toObservable
public io.reactivex.Observable<Buffer> toObservable()
- Specified by:
toObservable
in interfaceReadStream<Buffer>
-
toFlowable
public io.reactivex.Flowable<Buffer> toFlowable()
- Specified by:
toFlowable
in interfaceReadStream<Buffer>
-
toObserver
public WriteStreamObserver<Buffer> toObserver()
-
toSubscriber
public WriteStreamSubscriber<Buffer> toSubscriber()
-
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>
- 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>
- Parameters:
data
-
-
rxWrite
public io.reactivex.Completable rxWrite(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
rxWrite
in interfaceWebSocketBase
- Specified by:
rxWrite
in interfaceWriteStream<Buffer>
- 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>
- 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>
- Parameters:
data
-
-
rxEnd
public io.reactivex.Completable rxEnd(Buffer data)
Same as but with anhandler
called when the operation completes- Specified by:
rxEnd
in interfaceWebSocketBase
- Specified by:
rxEnd
in interfaceWriteStream<Buffer>
- Parameters:
data
-- Returns:
-
writeQueueFull
public boolean writeQueueFull()
This will returntrue
if there are more bytes in the write queue than the value set usingsetWriteQueueMaxSize(int)
- Specified by:
writeQueueFull
in interfaceWebSocketBase
- Specified by:
writeQueueFull
in interfaceWriteStream<Buffer>
- Returns:
true
if write queue is full
-
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
- 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
- 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
- Parameters:
dst
- the destination write stream
-
rxPipeTo
public io.reactivex.Completable 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
- Parameters:
dst
- the destination write stream- Returns:
-
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
- 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
- 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
- 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
- Returns:
-
closeReason
public String closeReason()
Returns the close reason message from the remote endpoint ornull
when not yet received.- Specified by:
closeReason
in interfaceWebSocketBase
- 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
- Returns:
- the headers
-
writePing
public WebSocketBase writePing(Buffer data, Handler<AsyncResult<Void>> handler)
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
- 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 WebSocketBase writePing(Buffer data)
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
- 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 io.reactivex.Completable rxWritePing(Buffer data)
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
- 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 WebSocketBase writePong(Buffer data, Handler<AsyncResult<Void>> handler)
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
- 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 WebSocketBase writePong(Buffer data)
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
- 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 io.reactivex.Completable rxWritePong(Buffer data)
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
- Parameters:
data
- the data to write, may be at most 125 bytes- Returns:
- a reference to this, so the API can be used fluently
-
textMessageHandler
public WebSocketBase textMessageHandler(Handler<String> handler)
Set a text message handler on the connection. This handler will be called similar to theWebSocketBase.binaryMessageHandler(io.vertx.core.Handler<io.vertx.reactivex.core.buffer.Buffer>)
, but the buffer will be converted to a String first- Specified by:
textMessageHandler
in interfaceWebSocketBase
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
binaryMessageHandler
public WebSocketBase binaryMessageHandler(Handler<Buffer> handler)
Set a binary message handler on the connection. This handler serves a similar purpose tohandler(io.vertx.core.Handler<io.vertx.reactivex.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
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
pongHandler
public WebSocketBase pongHandler(Handler<Buffer> handler)
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
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
end
public void end(Handler<AsyncResult<Void>> handler)
- Specified by:
end
in interfaceWebSocketBase
- Specified by:
end
in interfaceWriteStream<Buffer>
- Parameters:
handler
-
-
end
public void end()
- Specified by:
end
in interfaceWebSocketBase
- Specified by:
end
in interfaceWriteStream<Buffer>
-
rxEnd
public io.reactivex.Completable rxEnd()
- Specified by:
rxEnd
in interfaceWebSocketBase
- Specified by:
rxEnd
in interfaceWriteStream<Buffer>
- 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
- 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
-
rxClose
public io.reactivex.Completable 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
- 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
- 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
- Parameters:
statusCode
-
-
rxClose
public io.reactivex.Completable 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
- 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
- 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
- Parameters:
statusCode
-reason
-
-
rxClose
public io.reactivex.Completable 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
- Parameters:
statusCode
-reason
-- Returns:
-
remoteAddress
public SocketAddress remoteAddress()
- Specified by:
remoteAddress
in interfaceWebSocketBase
- 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
- 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
- Returns:
- true if this
HttpConnection
is encrypted via SSL/TLS.
-
isClosed
public boolean isClosed()
- Specified by:
isClosed
in interfaceWebSocketBase
- Returns:
true
if the WebSocket is closed
-
exceptionHandler
public WebSocket 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>
- Parameters:
handler
- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
public WebSocket 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
- Returns:
- a reference to this, so the API can be used fluently
-
pause
public WebSocket pause()
Description copied from interface:ReadStream
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.While it's paused, no data will be sent to the data
handler
.- Specified by:
pause
in interfaceReadStream<Buffer>
- Specified by:
pause
in interfaceWebSocketBase
- Returns:
- a reference to this, so the API can be used fluently
-
resume
public WebSocket resume()
Description copied from interface:ReadStream
Resume reading, and sets the buffer inflowing
mode. If theReadStream
has been paused, reading will recommence on it.- Specified by:
resume
in interfaceReadStream<Buffer>
- Specified by:
resume
in interfaceWebSocketBase
- Returns:
- a reference to this, so the API can be used fluently
-
fetch
public WebSocket fetch(long amount)
Description copied from interface:ReadStream
Fetch the specifiedamount
of elements. If theReadStream
has been paused, reading will recommence with the specifiedamount
of items, otherwise the specifiedamount
will be added to the current stream demand.- Specified by:
fetch
in interfaceReadStream<Buffer>
- Specified by:
fetch
in interfaceWebSocketBase
- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public WebSocket 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
- Returns:
- a reference to this, so the API can be used fluently
-
setWriteQueueMaxSize
public WebSocket setWriteQueueMaxSize(int maxSize)
Description copied from interface:WriteStream
Set the maximum size of the write queue tomaxSize
. You will still be able to write to the stream even if there is more thanmaxSize
items in the write queue. This is used as an indicator by classes such asPipe
to provide flow control. The value is defined by the implementation of the stream, e.g in bytes for aNetSocket
, etc...- Specified by:
setWriteQueueMaxSize
in interfaceWebSocketBase
- Specified by:
setWriteQueueMaxSize
in interfaceWriteStream<Buffer>
- Parameters:
maxSize
- the max size of the write stream- Returns:
- a reference to this, so the API can be used fluently
-
drainHandler
public WebSocket 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>
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
writeFrame
public WebSocket writeFrame(WebSocketFrame frame, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFrame(io.vertx.reactivex.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
- Returns:
-
writeFrame
public WebSocket writeFrame(WebSocketFrame frame)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFrame(io.vertx.reactivex.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
- Returns:
-
rxWriteFrame
public io.reactivex.Completable rxWriteFrame(WebSocketFrame frame)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFrame(io.vertx.reactivex.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
- Returns:
-
writeFinalTextFrame
public WebSocket 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
- Returns:
-
writeFinalTextFrame
public WebSocket 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
- Returns:
-
rxWriteFinalTextFrame
public io.reactivex.Completable 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
- Returns:
-
writeFinalBinaryFrame
public WebSocket writeFinalBinaryFrame(Buffer data, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.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
- Returns:
-
writeFinalBinaryFrame
public WebSocket writeFinalBinaryFrame(Buffer data)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.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
- Returns:
-
rxWriteFinalBinaryFrame
public io.reactivex.Completable rxWriteFinalBinaryFrame(Buffer data)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeFinalBinaryFrame(io.vertx.reactivex.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
- Returns:
-
writeBinaryMessage
public WebSocket writeBinaryMessage(Buffer data, Handler<AsyncResult<Void>> handler)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeBinaryMessage(io.vertx.reactivex.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
- Returns:
-
writeBinaryMessage
public WebSocket writeBinaryMessage(Buffer data)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeBinaryMessage(io.vertx.reactivex.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
- Returns:
-
rxWriteBinaryMessage
public io.reactivex.Completable rxWriteBinaryMessage(Buffer data)
Description copied from interface:WebSocketBase
Same asWebSocketBase.writeBinaryMessage(io.vertx.reactivex.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
- Returns:
-
writeTextMessage
public WebSocket 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
- Returns:
-
writeTextMessage
public WebSocket 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
- Returns:
-
rxWriteTextMessage
public io.reactivex.Completable 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
- Returns:
-
closeHandler
public WebSocket 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
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
frameHandler
public WebSocket 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
- Parameters:
handler
- the handler- Returns:
- a reference to this, so the API can be used fluently
-
sslSession
public SSLSession sslSession()
- Returns:
- SSLSession associated with the underlying socket. Returns null if connection is not SSL.
-
-