class WebSocketStream extends ReadStream[WebSocket]
A stream for io.vertx.scala.core.http.HttpClient WebSocket connection.
When the connection attempt is successful, the stream handler is called back with the io.vertx.scala.core.http.WebSocket argument, immediately followed by a call to the end handler. When the connection attempt fails, the exception handler is invoked.
The connection occurs when the io.vertx.scala.core.http.WebSocketStream#handler method is called with a non null handler, the other handlers should be set before setting the handler.
- Alphabetic
- By Inheritance
- WebSocketStream
- ReadStream
- StreamBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new WebSocketStream(_asJava: AnyRef)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: AnyRef
- Definition Classes
- WebSocketStream → ReadStream → StreamBase
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
endHandler(endHandler: Handler[Unit]): WebSocketStream
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.
- returns
a reference to this, so the API can be used fluently
- Definition Classes
- WebSocketStream → ReadStream
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
exceptionHandler(handler: Handler[Throwable]): WebSocketStream
Set an exception handler on the read stream.
Set an exception handler on the read stream.
- handler
the exception handler
- returns
a reference to this, so the API can be used fluently
- Definition Classes
- WebSocketStream → ReadStream → StreamBase
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
handler(handler: Handler[WebSocket]): WebSocketStream
Set a data handler.
Set a data handler. As data is read, the handler will be called with the data.
- returns
a reference to this, so the API can be used fluently
- Definition Classes
- WebSocketStream → ReadStream
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
pause(): WebSocketStream
Pause the
ReadSupport.Pause the
ReadSupport. While it's paused, no data will be sent to thedataHandler- returns
a reference to this, so the API can be used fluently
- Definition Classes
- WebSocketStream → ReadStream
-
def
resume(): WebSocketStream
Resume reading.
Resume reading. If the
ReadSupporthas been paused, reading will recommence on it.- returns
a reference to this, so the API can be used fluently
- Definition Classes
- WebSocketStream → ReadStream
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )