frame

Documentation

Overview

Package frame defines frames for yomo.

Index

• type AuthenticationAckFrame
  • func (f *AuthenticationAckFrame) Type() Type
• type AuthenticationFrame
  • func (f *AuthenticationFrame) Type() Type
• type BackflowFrame
  • func (f *BackflowFrame) Type() Type
• type Codec
• type DataFrame
  • func (f *DataFrame) Type() Type
• type Frame
  • func NewFrame(f Type) (Frame, error)
• type GoawayFrame
  • func (f *GoawayFrame) Type() Type
• type HandshakeAckFrame
  • func (f *HandshakeAckFrame) Type() Type
• type HandshakeFrame
  • func (f *HandshakeFrame) Type() Type
• type HandshakeRejectedFrame
  • func (f *HandshakeRejectedFrame) Type() Type
• type PacketReadWriter
• type ReadWriteCloser
• type ReadWriter
• type Reader
• type RejectedFrame
  • func (f *RejectedFrame) Type() Type
• type Tag
• type Type
  • func (f Type) String() string
• type Writer

Types

type AuthenticationAckFrame

type AuthenticationAckFrame struct{}

AuthenticationAckFrame is used to confirm that the client is authorized to access the requested DataStream from ControlStream, AuthenticationAckFrame is transmit on ControlStream. If the client-side receives this frame, it indicates that authentication was successful.

func (*AuthenticationAckFrame) Type

func (f *AuthenticationAckFrame) Type() Type

Type returns the type of AuthenticationAckFrame.

type AuthenticationFrame

type AuthenticationFrame struct {
	// AuthName.
	AuthName string
	// AuthPayload.
	AuthPayload string
}

AuthenticationFrame is used to authenticate the client, once the connection is established, the client immediately, sends information to the server, server gets the way to authenticate according to AuthName and use AuthPayload to do a authentication. AuthenticationFrame is transmit on ControlStream.

Reading the `auth.Authentication` interface will help you understand how AuthName and AuthPayload work.

func (*AuthenticationFrame) Type

func (f *AuthenticationFrame) Type() Type

Type returns the type of AuthenticationFrame.

type BackflowFrame

type BackflowFrame struct {
	// Tag is used for data router.
	Tag Tag
	// Carriage is the data to transmit.
	Carriage []byte
}

The BackflowFrame is used to receive the processed result of a DataStream with StreamFunction type and forward it to a DataStream with StreamSource type.

func (*BackflowFrame) Type

func (f *BackflowFrame) Type() Type

Type returns the type of BackflowFrame.

type Codec

type Codec interface {
	// Decode decodes byte array to frame.
	Decode([]byte, Frame) error
	// Encode encodes frame to byte array.
	Encode(Frame) ([]byte, error)
}

Codec encodes and decodes byte array to frame.

type DataFrame

type DataFrame struct {
	// Metadata stores additional data beyond the Payload,
	// it is an map[string]string{} that be encoded in msgpack.
	Metadata []byte
	// Tag is used for data router.
	Tag Tag
	// Payload is the data to transmit.
	Payload []byte
}

DataFrame carries tagged data to transmit across DataStream.

func (*DataFrame) Type

func (f *DataFrame) Type() Type

Type returns the type of DataFrame.

type Frame

type Frame interface {
	// Type returns the type of frame.
	Type() Type
}

Frame is the minimum unit required for Yomo to run. Yomo transmits various instructions and data through the frames.

following frame types are supported by Yomo:

1. AuthenticationFrame
2. AuthenticationAckFrame
3. DataFrame
4. HandshakeFrame
5. HandshakeRejectedFrame
6. HandshakeAckFrame
7. RejectedFrame
8. BackflowFrame

Read frame comments to understand the role of the frame.

func NewFrame

func NewFrame(f Type) (Frame, error)

NewFrame creates a new frame from Type.

type GoawayFrame

type GoawayFrame struct {
	// Message contains the reason why the connection be evicted.
	Message string
}

GoawayFrame is is used by server to evict a connection.

func (*GoawayFrame) Type

func (f *GoawayFrame) Type() Type

Type returns the type of GoawayFrame.

type HandshakeAckFrame

type HandshakeAckFrame struct {
	StreamID string
}

HandshakeAckFrame is used to ack handshake, If handshake successful, The server will send HandshakeAckFrame to the new DataStream, That means the initial frame received by the new DataStream must be the HandshakeAckFrame.

func (*HandshakeAckFrame) Type

func (f *HandshakeAckFrame) Type() Type

Type returns the type of HandshakeAckFrame.

type HandshakeFrame

type HandshakeFrame struct {
	// Name is the name of the dataStream that will be created.
	Name string
	// ID is the ID of the dataStream that will be created.
	ID string
	// StreamType is the StreamType of the dataStream that will be created.
	StreamType byte
	// ObserveDataTags is the ObserveDataTags of the dataStream that will be created.
	ObserveDataTags []Tag
	// Metadata is the Metadata of the dataStream that will be created.
	Metadata []byte
}

The HandshakeFrame is the frame through which the client obtains a new data stream from the server. It include essential details required for the creation of a fresh DataStream. The server then generates the DataStream utilizing this provided information.

func (*HandshakeFrame) Type

func (f *HandshakeFrame) Type() Type

Type returns the type of HandshakeFrame.

type HandshakeRejectedFrame

type HandshakeRejectedFrame struct {
	// ID is the ID of DataStream be rejected.
	ID string
	// Message contains the reason why the handshake was not successful.
	Message string
}

HandshakeRejectedFrame is employed to reject a handshake. It is transmitted over the ControlStream

func (*HandshakeRejectedFrame) Type

func (f *HandshakeRejectedFrame) Type() Type

Type returns the type of HandshakeRejectedFrame.

type PacketReadWriter

type PacketReadWriter interface {
	ReadPacket(io.Reader) (Type, []byte, error)
	WritePacket(io.Writer, Type, []byte) error
}

PacketReadWriter reads packets from the io.Reader and writes packets to the io.Writer. If read failed, return the frameType, the data of the packet and an error.

type ReadWriteCloser

type ReadWriteCloser interface {
	Reader
	Writer
	Close() error
}

ReadWriteCloser is the interface that groups the ReadFrame, WriteFrame and Close methods.

type ReadWriter

type ReadWriter interface {
	Reader
	Writer
}

ReadWriter is the interface that groups the ReadFrame and WriteFrame methods.

type Reader

type Reader interface {
	// ReadFrame reads a frame, if an error occurs, the returned error will not be empty,
	// and the returned frame will be nil.
	ReadFrame() (Frame, error)
}

Reader reads frame from underlying stream.

type RejectedFrame

type RejectedFrame struct {
	// Message encapsulates the rationale behind the rejection of the request.
	Message string
}

RejectedFrame is used to reject a ControlStream request.

func (*RejectedFrame) Type

func (f *RejectedFrame) Type() Type

Type returns the type of RejectedFrame.

type Tag

type Tag = uint32

Tag tags data and can be used for data routing.

type Type

type Type byte

Type defined The type of frame.

const (
	TypeAuthenticationFrame    Type = 0x03 // TypeAuthenticationFrame is the type of AuthenticationFrame.
	TypeAuthenticationAckFrame Type = 0x11 // TypeAuthenticationAckFrame is the type of AuthenticationAckFrame.
	TypeDataFrame              Type = 0x3F // TypeDataFrame is the type of DataFrame.
	TypeHandshakeFrame         Type = 0x31 // TypeHandshakeFrame is the type of PayloadFrame.
	TypeHandshakeRejectedFrame Type = 0x14 // TypeHandshakeRejectedFrame is the type of HandshakeRejectedFrame.
	TypeHandshakeAckFrame      Type = 0x29 // TypeHandshakeAckFrame is the type of HandshakeAckFrame.
	TypeRejectedFrame          Type = 0x39 // TypeRejectedFrame is the type of RejectedFrame.
	TypeBackflowFrame          Type = 0x2D // TypeBackflowFrame is the type of BackflowFrame.
	TypeGoawayFrame            Type = 0x2E // TypeGoawayFrame is the type of GoawayFrame.
)

func (Type) String

func (f Type) String() string

String returns a human-readable string which represents the frame type. The string can be used for debugging or logging purposes.

type Writer

type Writer interface {
	// WriteFrame writes frame to underlying stream.
	WriteFrame(Frame) error
}

Writer is the interface that wraps the WriteFrame method, it writes frame to the underlying data stream.