es

README

es

Easy session/stream protocol

This is v2 of emsg (our private Easy Message Protocol)

OLD emsg and otunnel usage, ref to Chinese usage of otunnel

Arch

Message split design

simple message flow in one order

Example

• Simple Example
• otunnel

CI

GitHub Actions workflow: .github/workflows/ci.yml. It validates module metadata and runs go build ./... plus go test ./... on push/PR.

Documentation

Index

• Constants
• Variables
• type BaseConn
  • func (c *BaseConn) Close() error
  • func (c *BaseConn) Recv() (message []byte, err error)
  • func (c *BaseConn) Send(message []byte) error
• type Conn
  • func NewBaseConn(conn io.ReadWriteCloser) Conn
  • func NewSafeConn(conn io.ReadWriteCloser, cipher *ecrypt.Cipher) Conn
• type SafeConn
  • func (c *SafeConn) Recv() (message []byte, err error)
  • func (c *SafeConn) Send(message []byte) error

Constants

const (
	LinkMsgTypePingRequest  = 1
	LinkMsgTypePingResponse = 2
	LinkMsgTypeSession      = 10
	LinkMsgTypeTunnel       = 20
)

message type

Variables

var (
	ErrBufferIsShort  = errors.New("buffer is short")
	ErrMaxLengthLimit = errors.New("max length limit")
)

common error define

Types

type BaseConn

type BaseConn struct {
	// contains filtered or unexported fields
}

BaseConn is the basic connection type

func (*BaseConn) Close

func (c *BaseConn) Close() error

Close close a Conn

func (*BaseConn) Recv

func (c *BaseConn) Recv() (message []byte, err error)

Recv read a message from this Conn

func (*BaseConn) Send

func (c *BaseConn) Send(message []byte) error

Send send a message to this Conn

type Conn

type Conn interface {
	Recv() (message []byte, err error)
	Send(message []byte) error
	Close() error
}

Conn is a interface a Conn

func NewBaseConn

func NewBaseConn(conn io.ReadWriteCloser) Conn

NewBaseConn create a base Conn object

func NewSafeConn

func NewSafeConn(conn io.ReadWriteCloser, cipher *ecrypt.Cipher) Conn

NewSafeConn create a safe Conn

type SafeConn

type SafeConn struct {
	BaseConn
	// contains filtered or unexported fields
}

SafeConn ecrypt Conn

func (*SafeConn) Recv

func (c *SafeConn) Recv() (message []byte, err error)

Recv read a message from this Conn

func (*SafeConn) Send

func (c *SafeConn) Send(message []byte) error

Send send a message to this Conn