vertx / io.vertx.ext.web.handler.sockjs / SockJSHandler

SockJSHandler

interface SockJSHandler : Handler<RoutingContext>

A handler that allows you to handle SockJS connections from clients.

We currently support version 0.3.3 of the SockJS protocol, which can be found in this tag:

Author
Tim Fox

Functions

bridge

abstract fun bridge(bridgeOptions: BridgeOptions): SockJSHandler

Bridge the SockJS handler to the Vert.x event bus. This basically installs a built-in SockJS socket handler which takes SockJS traffic and bridges it to the event bus, thus allowing you to extend the server-side Vert.x event bus to browsers

abstract fun bridge(bridgeOptions: BridgeOptions, bridgeEventHandler: Handler<BridgeEvent>): SockJSHandler

Like io.vertx.ext.web.handler.sockjs.SockJSHandler#bridge(BridgeOptions) but specifying a handler that will receive bridge events.

create

open static fun create(vertx: Vertx): SockJSHandler
open static fun create(vertx: Vertx, options: SockJSHandlerOptions): SockJSHandler

Create a SockJS handler

installTestApplications

open static fun installTestApplications(router: Router, vertx: Vertx): Unit

Install SockJS test applications on a router - used when running the SockJS test suite

socketHandler

abstract fun socketHandler(handler: Handler<SockJSSocket>): SockJSHandler

Set a SockJS socket handler. This handler will be called with a SockJS socket whenever a SockJS connection is made from a client