The internal type of the Java wrapped class.
The internal type of the Java wrapped class.
The internal instance of the Java wrapped class.
The internal instance of the Java wrapped class.
When a Websocket
is created it automatically registers an event handler with the eventbus, the ID of that
handler is given by binaryHandlerID
.
When a Websocket
is created it automatically registers an event handler with the eventbus, the ID of that
handler is given by binaryHandlerID
.
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.
Close the websocket
Close the websocket
Set a closed handler on the connection
Set a closed handler on the connection
Set a data handler.
Set a data handler. As data is read, the handler will be called with the data.
Set a drain handler on the stream.
Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write queue has been reduced to maxSize / 2. See org.vertx.scala.core.streams.Pump for an example of this being used.
Set an end handler.
Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
Set an exception handler.
Set an exception handler.
A map of all headers in the request to upgrade to websocket
Return the local address for this socket
Return the local address for this socket
The path the websocket is attempting to connect at
Pause the ReadSupport
.
Pause the ReadSupport
. While it's paused, no data will be sent to the dataHandler
The query string passed on the websocket uri
Reject the WebSocket
Reject the WebSocket
Calling this method from the websocketHandler gives you the opportunity to reject the websocket, which will cause the websocket handshake to fail by returning a 404 response code.
You might use this method, if for example you only want to accept websockets with a particular path.
Return the remote address for this socket
Return the remote address for this socket
Resume reading.
Resume reading. If the ReadSupport
has been paused, reading will recommence on it.
Set the maximum size of the write queue to maxSize
.
Set the maximum size of the write queue to maxSize
. You will still be able to write to the stream even
if there is more than maxSize
bytes in the write queue. This is used as an indicator by classes such as
Pump
to provide flow control.
When a Websocket} is created it automatically registers an event handler with the eventbus, the ID of that
handler is given by
textHandlerID}.
When a 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.
The uri the websocket handshake occurred at
Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types
Helper method wrapping invocations and returning the Scala type, once again to help provide fluent return types
Write some data to the stream.
Write some data to the stream. The data is put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the org.vertx.scala.core.streams.WriteStream.writeQueueFull() method before writing. This is done automatically if using a org.vertx.scala.core.streams.Pump.
Write data
to the websocket as a binary frame
Write data
to the websocket as a binary frame
This will return true
if there are more bytes in the write queue than the value set using
org.vertx.scala.core.streams.WriteStream.setWriteQueueMaxSize()
This will return true
if there are more bytes in the write queue than the value set using
org.vertx.scala.core.streams.WriteStream.setWriteQueueMaxSize()
Write str
to the websocket as a text frame
Write str
to the websocket as a text frame
Represents a server side WebSocket that is passed into a the websocketHandler of an org.vertx.scala.core.http.HttpServer
Instances of this class are not thread-safe