colossus.protocols

websocket

package 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
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. websocket
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. 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.

  2. trait FrameCodec[E <: Encoding] extends AnyRef

  3. trait FrameCodecProvider[E <: Encoding] extends AnyRef

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

    A Parsed Frame Header

  5. class WebsocketCodec extends Codec[WebsocketEncoding]

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

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

  8. trait WebsocketEncoding extends Encoding

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

  10. class WebsocketHttpHandler[E <: Encoding] extends RequestHandler

  11. abstract class WebsocketInitializer[E <: Encoding] extends AnyRef

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

Value Members

  1. object Frame extends Serializable

  2. object FrameParser

  3. object OpCodes

  4. object UpgradeRequest

  5. object WebsocketServer

  6. object subprotocols

Inherited from AnyRef

Inherited from Any

Ungrouped