websocket

**This package is experimental and subject to breaking changes between versions**. We currently don't support the complete Websocket spec but there is enough support for basic servers

The Websocket protocol defines an asynchronous application protocol. Since unlike HTTP or other similar protocols there are no requests or responses, writing a Websocket server is slightly different from other service-protocol servers. In particular, you should use the WebsocketServer to start a server and the WebsocketServerHandler to define a connection handler.

The subprotocols package contains some basic sub-protocols, but these tend to be application specific so support is limited.

Websocket connection handlers are designed to behave like actors, and mixing in the ProxyActor trait can make Websocket connections behave like and interact with Akka actors.

Linear Supertypes

AnyRef, Any

Type Members

abstract class BaseWebsocketHandler extends Controller[Frame, Frame]
case class Frame(header: Header, payload: DataBlock) extends Product with Serializable

A Frame represents a single chunk of data sent by either the client or server.
trait FrameCodec[P <: Protocol] extends AnyRef
trait FrameCodecProvider[P <: Protocol] extends AnyRef
case class Header(opcode: Byte, mask: Boolean) extends Product with Serializable

A Parsed Frame Header
trait Websocket extends Protocol
class WebsocketCodec extends Codec[Frame, Frame]
abstract class WebsocketHandler[P <: Protocol] extends BaseWebsocketHandler

A websocket server connection handler that uses a specified sub-protocol.
class WebsocketHttpHandler extends HttpService
abstract class WebsocketInitializer extends AnyRef
abstract class WebsocketServerHandler[P <: Protocol] extends WebsocketHandler[P] with ServerConnectionHandler

Value Members

object Frame extends Serializable
object FrameParser
object OpCodes
object UpgradeRequest
implicit object WebsocketCodecProvider extends CodecProvider[Websocket]
object WebsocketHandler
object WebsocketServer
object subprotocols

package websocket

Type Members

abstract class BaseWebsocketHandler extends Controller[Frame, Frame]

case class Frame(header: Header, payload: DataBlock) extends Product with Serializable

trait FrameCodec[P <: Protocol] extends AnyRef

trait FrameCodecProvider[P <: Protocol] extends AnyRef

case class Header(opcode: Byte, mask: Boolean) extends Product with Serializable

trait Websocket extends Protocol

class WebsocketCodec extends Codec[Frame, Frame]

abstract class WebsocketHandler[P <: Protocol] extends BaseWebsocketHandler

class WebsocketHttpHandler extends HttpService

abstract class WebsocketInitializer extends AnyRef

abstract class WebsocketServerHandler[P <: Protocol] extends WebsocketHandler[P] with ServerConnectionHandler

Value Members

object Frame extends Serializable

object FrameParser

object OpCodes

object UpgradeRequest

implicit object WebsocketCodecProvider extends CodecProvider[Websocket]

object WebsocketHandler

object WebsocketServer

object subprotocols

Inherited from AnyRef

Inherited from Any

Ungrouped