SockJSServer

This is an implementation of the server side part of SockJS.

SockJS enables browsers to communicate with the server using a simple WebSocket-like api for sending and receiving messages. Under the bonnet SockJS chooses to use one of several protocols depending on browser capabilities and what appears to be working across the network.

Available protocols include:

WebSockets
xhr-polling
xhr-streaming
json-polling
event-source
html-file

This means, it should just work irrespective of what browser is being used, and whether there are nasty things like proxies and load balancers between the client and the server.

For more detailed information on SockJS, see their website.

On the server side, you interact using instances of org.vertx.scala.core.sockjs.SockJSSocket - this allows you to send data to the client or receive data via the org.vertx.scala.core.sockjs.SockJSSocket.dataHandler().

You can register multiple applications with the same SockJSServer, each using different path prefixes, each application will have its own handler, and configuration.

Instances of this class are not thread-safe.

Linear Supertypes

Self, AnyRef, Any

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val asJava: java.core.sockjs.SockJSServer
def bridge(sjsConfig: JsonObject, inboundPermitted: JsonArray, outboundPermitted: JsonArray, bridgeConfig: JsonObject): SockJSServer

Install an app which bridges the SockJS server to the event bus
Install an app which bridges the SockJS server to the event bus
sjsConfig
The config for the app
inboundPermitted
A list of JSON objects which define permitted matches for inbound (client->server) traffic
outboundPermitted
A list of JSON objects which define permitted matches for outbound (server->client) traffic
bridgeConfig
JSON object holding config for the EventBusBridge
def bridge(sjsConfig: JsonObject, inboundPermitted: JsonArray, outboundPermitted: JsonArray, authTimeout: Long, authAddress: String): SockJSServer

Install an app which bridges the SockJS server to the event bus
Install an app which bridges the SockJS server to the event bus
sjsConfig
The config for the app
inboundPermitted
A list of JSON objects which define permitted matches for inbound (client->server) traffic
outboundPermitted
A list of JSON objects which define permitted matches for outbound (server->client) traffic
authTimeout
Default time an authorisation will be cached for in the bridge (defaults to 5 minutes)
authAddress
Address of auth manager. Defaults to 'vertx.basicauthmanager.authorise'
def bridge(sjsConfig: JsonObject, inboundPermitted: JsonArray, outboundPermitted: JsonArray, authTimeout: Long): SockJSServer

Install an app which bridges the SockJS server to the event bus
Install an app which bridges the SockJS server to the event bus
sjsConfig
The config for the app
inboundPermitted
A list of JSON objects which define permitted matches for inbound (client->server) traffic
outboundPermitted
A list of JSON objects which define permitted matches for outbound (server->client) traffic
authTimeout
Default time an authorisation will be cached for in the bridge (defaults to 5 minutes)
def bridge(sjsConfig: JsonObject, inboundPermitted: JsonArray, outboundPermitted: JsonArray): SockJSServer

Install an app which bridges the SockJS server to the event bus
Install an app which bridges the SockJS server to the event bus
sjsConfig
The config for the app
inboundPermitted
A list of JSON objects which define permitted matches for inbound (client->server) traffic
outboundPermitted
A list of JSON objects which define permitted matches for outbound (server->client) traffic
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
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 hashCode(): Int

Definition Classes
AnyRef → Any
def installApp(config: JsonObject, sockHandler: (SockJSSocket) ⇒ Unit): SockJSServer

Install an application
Install an application
config
The application configuration
sockHandler
A handler that will be called when new SockJS sockets are created
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 setHook(hook: EventBusBridgeHook): SockJSServer

Set a EventBusBridgeHook on the SockJS server
Set a EventBusBridgeHook on the SockJS server
hook
The hook
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( ... )
def wrap[X](doStuff: ⇒ X): SockJSServer.this.type

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

Attributes
protected[this]
Definition Classes
Self

final class SockJSServer extends Self

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val asJava: java.core.sockjs.SockJSServer

def bridge(sjsConfig: JsonObject, inboundPermitted: JsonArray, outboundPermitted: JsonArray, bridgeConfig: JsonObject): SockJSServer

def bridge(sjsConfig: JsonObject, inboundPermitted: JsonArray, outboundPermitted: JsonArray, authTimeout: Long, authAddress: String): SockJSServer

def bridge(sjsConfig: JsonObject, inboundPermitted: JsonArray, outboundPermitted: JsonArray, authTimeout: Long): SockJSServer

def bridge(sjsConfig: JsonObject, inboundPermitted: JsonArray, outboundPermitted: JsonArray): SockJSServer

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def installApp(config: JsonObject, sockHandler: (SockJSSocket) ⇒ Unit): SockJSServer

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def setHook(hook: EventBusBridgeHook): SockJSServer

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def wrap[X](doStuff: ⇒ X): SockJSServer.this.type

Inherited from Self

Inherited from AnyRef

Inherited from Any

Ungrouped