protocol

Type Members

trait AttributesSupport extends AnyRef

Frames that mix this trait can add a block of attributes.
Frames that mix this trait can add a block of attributes. Attributes are a list of pairs of String and byte arrays.
trait BodySupport extends AnyRef

Frames that mix this trait can add a body, which is a byte array at the end of the frame.
case class ByeFrame() extends Frame with Product with Serializable

Empty frame that signals the normal finalization of a connection.
Empty frame that signals the normal finalization of a connection. Nothing is sent or received after this frame.

case class FlowControlFrame(flowId: Int, open: Boolean) extends Frame with Product with Serializable

Frame sent by clients to open or close a flow.

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
╭───────────────────────────────────────────────────────────────╮
╎                                                               ╎
╎                     Header (see Frame)                        ╎
╎                                                               ╎
├─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┤
│0│                    Flow ID (31 bits)                        │
├─┼─┬─┬─┬─┬─┬─┬─┬───────────────────────────────────────────────╯
│ Open (0 or 1) │
╰───────────────╯

See also: mot.ClientFlow

trait Frame extends AnyRef

Base trait for all protocol frames.

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
╭─┬─┬─┬─┬─┬─┬─┬─╮
│    Type (8)   │
├─┬─┬─┬─┬─┬─┬─┬─┼─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─╮
│0│                 Message Length (31 bits)                    │
├─┴─────────────────────────────────────────────────────────────┤
╎                                                               ╎
╎                     Data (see sub types)                      ╎
╎                                                               ╎
╰───────────────────────────────────────────────────────────────╯

trait FrameFactory[+T <: Frame] extends AnyRef
case class HeartbeatFrame() extends Frame with Product with Serializable

Empty frame that keeps the connection with some activity when there are not other kind of frames.
Empty frame that keeps the connection with some activity when there are not other kind of frames. The protocol mandates to send a heartbeat after 5 seconds of not sending anything.

case class HelloFrame(attributes: Seq[(String, ByteArray)]) extends Frame with AttributesSupport with Product with Serializable

First frame send by both parties in the beginning of every connection.

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
╭───────────────────────────────────────────────────────────────╮
╎                                                               ╎
╎                     Header (see Frame)                        ╎
╎                                                               ╎
├───────────────────────────────────────────────────────────────┤
╎                                                               ╎
╎              Attributes (see AttributeSupport)                ╎
╎                                                               ╎
╰───────────────────────────────────────────────────────────────╯

case class MessageFrame(attributes: Seq[(String, ByteArray)], bodyLength: Int, body: Seq[ByteArray]) extends Frame with AttributesSupport with BodySupport with Product with Serializable

Frame sent by clients, represents and unrespondible message.

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
╭───────────────────────────────────────────────────────────────╮
╎                                                               ╎
╎                     Header (see Frame)                        ╎
╎                                                               ╎
├───────────────────────────────────────────────────────────────┤
╎                                                               ╎
╎              Attributes (see AttributeSupport)                ╎
╎                                                               ╎
├─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┤
╎                                                               ╎
╎                    Body (see BodySupport)                     ╎
╎                                                               ╎
╰───────────────────────────────────────────────────────────────╯

trait ProtocolException extends Exception
class ProtocolSemanticException extends Exception with ProtocolException
trait ProtocolSyntaxException extends Exception with ProtocolException

case class RequestFrame(requestId: Int, flowId: Int, timeout: Int, attributes: Seq[(String, ByteArray)], bodyLength: Int, body: Seq[ByteArray]) extends Frame with AttributesSupport with BodySupport with Product with Serializable

Frame sent by clients.

Frame sent by clients. Represents a respondible message.

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
╭───────────────────────────────────────────────────────────────╮
╎                                                               ╎
╎                     Header (see Frame)                        ╎
╎                                                               ╎
├─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┤
│0│                   Request ID (31 bits)                      │
├─┼─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┤
│0│                    Flow ID (31 bits)                        │
├─┼─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┤
│0│                    Timeout (31 bits)                        │
├─┴─────────────────────────────────────────────────────────────┤
╎                                                               ╎
╎              Attributes (see AttributeSupport)                ╎
╎                                                               ╎
├─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┤
╎                                                               ╎
╎                    Body (see BodySupport)                     ╎
╎                                                               ╎
╰───────────────────────────────────────────────────────────────╯

case class ResetFrame(error: String) extends Frame with BodySupport with Product with Serializable

Frame that is sent in the event of an abnormal connection termination.

Frame that is sent in the event of an abnormal connection termination. The body can have a reason. Nothing is sent or received after this frame.

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
╭───────────────────────────────────────────────────────────────╮
╎                                                               ╎
╎                     Header (see Frame)                        ╎
╎                                                               ╎
├─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┤
╎                                                               ╎
╎                    Body (see BodySupport)                     ╎
╎                                                               ╎
╰───────────────────────────────────────────────────────────────╯

case class ResponseFrame(reference: Int, attributes: Seq[(String, ByteArray)], bodyLength: Int, body: Seq[ByteArray]) extends Frame with AttributesSupport with BodySupport with Product with Serializable

Frame sent by servers to respond to messages.

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
╭───────────────────────────────────────────────────────────────╮
╎                                                               ╎
╎                     Header (see Frame)                        ╎
╎                                                               ╎
├─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┤
│0│                    Reference (31 bits)                      │
├─┴─────────────────────────────────────────────────────────────┤
╎                                                               ╎
╎              Attributes (see AttributeSupport)                ╎
╎                                                               ╎
├─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┤
╎                                                               ╎
╎                    Body (see BodySupport)                     ╎
╎                                                               ╎
╰───────────────────────────────────────────────────────────────╯

case class UnknownFrame(messageType: Byte, length: Int) extends Frame with Product with Serializable

Special frame type, which represents an unknown received frame.
Special frame type, which represents an unknown received frame. It is never written.

Value Members

object AttributesSupport
object BodySupport
object ByeFrame extends FrameFactory[ByeFrame] with Serializable
object FlowControlFrame extends FrameFactory[FlowControlFrame] with Serializable
object Frame extends StrictLogging
object HeartbeatFrame extends FrameFactory[HeartbeatFrame] with Serializable
object HelloFrame extends FrameFactory[HelloFrame] with Serializable
object MessageFrame extends FrameFactory[MessageFrame] with Serializable
object MessageTypes
object ProtocolSyntaxException extends Serializable
object RequestFrame extends FrameFactory[RequestFrame] with Serializable
object ResetFrame extends FrameFactory[ResetFrame] with Serializable
object ResponseFrame extends FrameFactory[ResponseFrame] with Serializable
object UnknownFrame extends FrameFactory[UnknownFrame] with Serializable

package protocol

Type Members

trait AttributesSupport extends AnyRef

trait BodySupport extends AnyRef

case class ByeFrame() extends Frame with Product with Serializable

case class FlowControlFrame(flowId: Int, open: Boolean) extends Frame with Product with Serializable

trait Frame extends AnyRef

trait FrameFactory[+T <: Frame] extends AnyRef

case class HeartbeatFrame() extends Frame with Product with Serializable

case class HelloFrame(attributes: Seq[(String, ByteArray)]) extends Frame with AttributesSupport with Product with Serializable

case class MessageFrame(attributes: Seq[(String, ByteArray)], bodyLength: Int, body: Seq[ByteArray]) extends Frame with AttributesSupport with BodySupport with Product with Serializable

trait ProtocolException extends Exception

class ProtocolSemanticException extends Exception with ProtocolException

trait ProtocolSyntaxException extends Exception with ProtocolException

case class RequestFrame(requestId: Int, flowId: Int, timeout: Int, attributes: Seq[(String, ByteArray)], bodyLength: Int, body: Seq[ByteArray]) extends Frame with AttributesSupport with BodySupport with Product with Serializable

case class ResetFrame(error: String) extends Frame with BodySupport with Product with Serializable

case class ResponseFrame(reference: Int, attributes: Seq[(String, ByteArray)], bodyLength: Int, body: Seq[ByteArray]) extends Frame with AttributesSupport with BodySupport with Product with Serializable

case class UnknownFrame(messageType: Byte, length: Int) extends Frame with Product with Serializable

Value Members

object AttributesSupport

object BodySupport

object ByeFrame extends FrameFactory[ByeFrame] with Serializable

object FlowControlFrame extends FrameFactory[FlowControlFrame] with Serializable

object Frame extends StrictLogging

object HeartbeatFrame extends FrameFactory[HeartbeatFrame] with Serializable

object HelloFrame extends FrameFactory[HelloFrame] with Serializable

object MessageFrame extends FrameFactory[MessageFrame] with Serializable

object MessageTypes

object ProtocolSyntaxException extends Serializable

object RequestFrame extends FrameFactory[RequestFrame] with Serializable

object ResetFrame extends FrameFactory[ResetFrame] with Serializable

object ResponseFrame extends FrameFactory[ResponseFrame] with Serializable

object UnknownFrame extends FrameFactory[UnknownFrame] with Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped