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

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[E <: Encoding] extends AnyRef
trait FrameCodecProvider[E <: Encoding] extends AnyRef
case class Header(opcode: Byte, mask: Boolean) extends Product with Serializable

A Parsed Frame Header
class WebsocketCodec extends Codec[WebsocketEncoding]
class WebsocketController[E <: Encoding] extends ControllerDownstream[WebsocketEncoding] with ControllerUpstream[E] with DownstreamEventHandler[WebsocketControllerDownstream[E]] with UpstreamEventHandler[ControllerUpstream[WebsocketEncoding]]
trait WebsocketControllerDownstream[E <: Encoding] extends UpstreamEvents with HasUpstream[ControllerUpstream[E]] with DownstreamEvents
trait WebsocketEncoding extends Encoding
abstract class WebsocketHandler[E <: Encoding] extends WebsocketControllerDownstream[E] with UpstreamEventHandler[ControllerUpstream[E]] with HandlerTail
class WebsocketHttpHandler[E <: Encoding] extends RequestHandler
abstract class WebsocketInitializer[E <: Encoding] extends AnyRef
abstract class WebsocketServerHandler[E <: Encoding] extends WebsocketHandler[E]

Value Members

object Frame extends Serializable
object FrameParser
object OpCodes
object UpgradeRequest
object WebsocketServer
object subprotocols

package websocket

Type Members

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

trait FrameCodec[E <: Encoding] extends AnyRef

trait FrameCodecProvider[E <: Encoding] extends AnyRef

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

class WebsocketCodec extends Codec[WebsocketEncoding]

class WebsocketController[E <: Encoding] extends ControllerDownstream[WebsocketEncoding] with ControllerUpstream[E] with DownstreamEventHandler[WebsocketControllerDownstream[E]] with UpstreamEventHandler[ControllerUpstream[WebsocketEncoding]]

trait WebsocketControllerDownstream[E <: Encoding] extends UpstreamEvents with HasUpstream[ControllerUpstream[E]] with DownstreamEvents

trait WebsocketEncoding extends Encoding

abstract class WebsocketHandler[E <: Encoding] extends WebsocketControllerDownstream[E] with UpstreamEventHandler[ControllerUpstream[E]] with HandlerTail

class WebsocketHttpHandler[E <: Encoding] extends RequestHandler

abstract class WebsocketInitializer[E <: Encoding] extends AnyRef

abstract class WebsocketServerHandler[E <: Encoding] extends WebsocketHandler[E]

Value Members

object Frame extends Serializable

object FrameParser

object OpCodes

object UpgradeRequest

object WebsocketServer

object subprotocols

Inherited from AnyRef

Inherited from Any

Ungrouped