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. abstract class BaseWebsocketHandler extends Controller[Frame, Frame]

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

  3. trait FrameCodec[P <: Protocol] extends AnyRef

  4. trait FrameCodecProvider[P <: Protocol] extends AnyRef

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

    A Parsed Frame Header

  6. trait Websocket extends Protocol

  7. class WebsocketCodec extends Codec[Frame, Frame]

  8. abstract class WebsocketHandler[P <: Protocol] extends BaseWebsocketHandler

    A websocket server connection handler that uses a specified sub-protocol.

  9. abstract class WebsocketInitializer extends AnyRef

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

Value Members

  1. object Frame extends Serializable

  2. object FrameParser

  3. object OpCodes

  4. object UpgradeRequest

  5. implicit object WebsocketCodecProvider extends CodecProvider[Websocket]

  6. object WebsocketServer

  7. object subprotocols

Inherited from AnyRef

Inherited from Any

Ungrouped