implicit final class VertxServerWebSocketOps extends AnyVal
- Alphabetic
- By Inheritance
- VertxServerWebSocketOps
- AnyVal
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new VertxServerWebSocketOps(target: ServerWebSocket)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- Any
- final def ##(): Int
- Definition Classes
- Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def closeL(statusCode: Short, reason: String): Task[Unit]
Same as
String)
but with anhandler
called when the operation completes - def closeL(statusCode: Short): Task[Unit]
Same as
#close(short)
but with anhandler
called when the operation completes - def closeL(): Task[Unit]
Same as
#close()
but with anhandler
called when the operation completes - def endL(): Task[Unit]
Calls
#close(Handler)
- def endL(data: Buffer): Task[Unit]
Same as
#end(T)
but with anhandler
called when the operation completes - def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def pipeToL(dst: WriteStream[Buffer]): Task[Unit]
Pipe this
ReadStream
to theWriteStream
.Pipe this
ReadStream
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.- dst
the destination write stream
- def setHandshakeL(future: Future[Integer]): Task[Int]
Set an asynchronous result for the handshake, upon completion of the specified
future
, the WebSocket will either beSet an asynchronous result for the handshake, upon completion of the specified
future
, the WebSocket will either be- accepted when the
future
succeeds with the HTTP101
status code - rejected when the
future
is succeeds with an HTTP status code different than101
- rejected when the
future
fails with the HTTP status code500
The provided future might be completed by the WebSocket itself, e.g calling the
#close()
method will try to accept the handshake and close the WebSocket afterward. Thus it is advised to try to complete thefuture
withPromise#tryComplete
orPromise#tryFail
.This method should be called from the WebSocket handler to explicitly set an asynchronous handshake.
Calling this method will override the
future
completion handler.- future
the future to complete with
- Exceptions thrown
IllegalStateException
when the WebSocket has already an asynchronous result
- accepted when the
- val target: ServerWebSocket
- def toString(): String
- Definition Classes
- Any
- def writeBinaryMessageL(data: Buffer): Task[Unit]
- def writeFinalBinaryFrameL(data: Buffer): Task[Unit]
- def writeFinalTextFrameL(text: String): Task[Unit]
- def writeFrameL(frame: WebSocketFrame): Task[Unit]
- def writeL(data: Buffer): Task[Unit]
- def writeTextMessageL(text: String): Task[Unit]