vertx-lang-scala-docs_2.12 3.4.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package web
  Definition Classes
    ext
-  package handler
  Definition Classes
    web
-  package sockjs
  Definition Classes
    handler
- BridgeEvent
- BridgeOptions
- PermittedOptions
- SockJSHandler
- SockJSHandlerOptions
- SockJSSocket

c

io.vertx.scala.ext.web.handler.sockjs

# SockJSSocket 

###
Companion object SockJSSocket

#### class SockJSSocket extends ReadStream[Buffer] with WriteStream[Buffer]

You interact with SockJS clients through instances of SockJS socket.

The API is very similar to io.vertx.scala.core.http.WebSocket. It implements both and so it can be used with io.vertx.scala.core.streams.Pump to pump data with flow control.

Linear Supertypes
WriteStream[Buffer], ReadStream[Buffer], StreamBase, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. SockJSSocket
2. WriteStream
3. ReadStream
4. StreamBase
5. AnyRef
6. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new SockJSSocket(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: AnyRef
   Definition Classes
     SockJSSocket → WriteStream → ReadStream → StreamBase
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
7.  def close(): Unit

   Close it

8.  def drainHandler(handler: Handler[Unit]): SockJSSocket

   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 is ready to accept buffers again. See io.vertx.scala.core.streams.Pump 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`.

   handler

     the handler

   returns

     a reference to this, so the API can be used fluently

   Definition Classes
     SockJSSocket → WriteStream
9.  def end(): Unit

   Call io.vertx.scala.ext.web.handler.sockjs.SockJSSocket#end.

   Call io.vertx.scala.ext.web.handler.sockjs.SockJSSocket#end.

   Definition Classes
     SockJSSocket → WriteStream
10.  def end(t: Buffer): Unit

    Same as io.vertx.scala.core.streams.WriteStream#end but writes some data to the stream before ending.

    Same as io.vertx.scala.core.streams.WriteStream#end but writes some data to the stream before ending.

    Definition Classes
      SockJSSocket → WriteStream
11.  def endHandler(endHandler: Handler[Unit]): SockJSSocket

    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
      SockJSSocket → ReadStream
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
14.  def exceptionHandler(handler: Handler[Throwable]): SockJSSocket

    Set an exception handler on the write stream.

    Set an exception handler on the write stream.

    handler

      the exception handler

    returns

      a reference to this, so the API can be used fluently

    Definition Classes
      SockJSSocket → WriteStream → ReadStream → StreamBase
15.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
16.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
17.  def handler(handler: Handler[Buffer]): SockJSSocket

    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
      SockJSSocket → ReadStream
18.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
19.  def headers(): MultiMap

    Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasons

20.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
21.  def localAddress(): SocketAddress

    Return the local address for this socket

22.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
23.  final def notify(): Unit
    Definition Classes
      AnyRef
24.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
25.  def pause(): SockJSSocket

    Pause the `ReadSupport`.

    Pause the `ReadSupport`. While it's paused, no data will be sent to the `dataHandler`

    returns

      a reference to this, so the API can be used fluently

    Definition Classes
      SockJSSocket → ReadStream
26.  def remoteAddress(): SocketAddress

    Return the remote address for this socket

27.  def resume(): SockJSSocket

    Resume reading.

    Resume reading. If the `ReadSupport` has been paused, reading will recommence on it.

    returns

      a reference to this, so the API can be used fluently

    Definition Classes
      SockJSSocket → ReadStream
28.  def setWriteQueueMaxSize(maxSize: Int): SockJSSocket

    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` 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 io.vertx.scala.core.net.NetSocket, the number of io.vertx.scala.core.eventbus.Message for a io.vertx.scala.core.eventbus.MessageProducer, etc...

    maxSize

      the max size of the write stream

    returns

      a reference to this, so the API can be used fluently

    Definition Classes
      SockJSSocket → WriteStream
29.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
30.  def toString(): String
    Definition Classes
      AnyRef → Any
31.  def uri(): String

    Return the URI corresponding to the last request for this socket or the websocket handshake

32.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
33.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
34.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
35.  def webSession(): Option[Session]

    returns

      the Vert.x-Web session corresponding to this socket

36.  def webUser(): Option[User]

    returns

      the Vert.x-Web user corresponding to this socket

37.  def write(data: String): SockJSSocket

    Write a String to the socket, encoded in UTF-8.

    Write a String to the socket, encoded in UTF-8.

    data

      the string to write

    returns

      a reference to this, so the API can be used fluently

38.  def write(data: Buffer): SockJSSocket

    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 io.vertx.scala.core.streams.WriteStream#writeQueueFull method before writing. This is done automatically if using a io.vertx.scala.core.streams.Pump.

    data

      the data to write

    returns

      a reference to this, so the API can be used fluently

    Definition Classes
      SockJSSocket → WriteStream
39.  def writeHandlerID(): String

    When a `SockJSSocket` is created it automatically registers an event handler with the event bus, the ID of that handler is given by `writeHandlerID`.

    When a `SockJSSocket` is created it automatically registers an event handler with the event bus, the ID of that handler is given by `writeHandlerID`.

    Given this ID, a different event loop can send a buffer 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 socket. This allows you to write data to other sockets which are owned by different event loops.

40.  def writeQueueFull(): Boolean

    This will return `true` if there are more bytes in the write queue than the value set using io.vertx.scala.core.streams.WriteStream#setWriteQueueMaxSize

    This will return `true` if there are more bytes in the write queue than the value set using io.vertx.scala.core.streams.WriteStream#setWriteQueueMaxSize

    returns

      true if write queue is full

    Definition Classes
      SockJSSocket → WriteStream

### Inherited from WriteStream[Buffer]

### Inherited from ReadStream[Buffer]

### Inherited from StreamBase

### Inherited from AnyRef

### Inherited from Any

### Ungrouped