protocols

Documentation

Overview

frame protocol

Protocol the interface of protocol, include three method, you can define custom protocol through implement three method.

text protocol.

webSocket protocol

Index

• type Frame
  • func NewFrameProtocol() *Frame
  • func (t *Frame) Decode(buffer []byte) []byte
  • func (t *Frame) Encode(buffer []byte) interface{}
  • func (t *Frame) Input(buffer []byte, maxPackageSize int) interface{}
• type Protocol
• type Text
  • func NewTextProtocol() *Text
  • func (t *Text) Decode(buffer []byte) []byte
  • func (t *Text) Encode(buffer []byte) interface{}
  • func (t *Text) Input(buffer []byte, maxPackageSize int) interface{}

Types

type Frame

type Frame struct {
}

Frame frame struct.

func NewFrameProtocol

func NewFrameProtocol() *Frame

NewFrameProtocol.

func (*Frame) Decode

func (t *Frame) Decode(buffer []byte) []byte

Decode decode the buffer.

func (*Frame) Encode

func (t *Frame) Encode(buffer []byte) interface{}

Encode encode the buffer, the type of return value is []byte.

func (*Frame) Input

func (t *Frame) Input(buffer []byte, maxPackageSize int) interface{}

Input check the integrity of the package.

type Protocol

type Protocol interface {
	// Encode encode package before send to client.
	// The type of return is different for each protocol.
	Encode(data []byte) interface{}
	// Decode decode package and emit.
	Decode(recvBuffer []byte) []byte
	// Input check the integrity of package.
	// if return the value of bool, close connection, indicates that the package is greater than MaxPackageSize,
	// else if return 0, the package is not a integrity package, continue to receive.
	Input(recvBuffer []byte, maxPackageSize int) interface{}
}

type Text

type Text struct {
}

Text text struct.

func NewTextProtocol

func NewTextProtocol() *Text

NewTextProtocol.

func (*Text) Decode

func (t *Text) Decode(buffer []byte) []byte

Decode decode the buffer.

func (*Text) Encode

func (t *Text) Encode(buffer []byte) interface{}

Encode encode the buffer, the type of return value is []byte.

func (*Text) Input

func (t *Text) Input(buffer []byte, maxPackageSize int) interface{}

Input check the integrity of the package.