msg

Documentation

Index

• Constants
• Variables
• func Pack(msg Message) ([]byte, error)
• func ReadMsgInto(c io.Reader, msg Message) (err error)
• func UnPackInto(buffer []byte, msg Message) (err error)
• func WriteMsg(c io.Writer, msg interface{}) (err error)
• type CloseProxy
• type Login
• type LoginResp
• type Message
  • func ReadMsg(c io.Reader) (msg Message, err error)
  • func UnPack(typeByte byte, buffer []byte) (msg Message, err error)
• type NatHoleClient
• type NatHoleResp
• type NatHoleSid
• type NatHoleVisitor
• type NewProxy
• type NewProxyResp
• type NewVisitorConn
• type NewVisitorConnResp
• type NewWorkConn
• type Ping
• type Pong
• type ReqWorkConn
• type StartWorkConn
• type UdpPacket

Constants

const (
	TypeLogin              = 'o'
	TypeLoginResp          = '1'
	TypeNewProxy           = 'p'
	TypeNewProxyResp       = '2'
	TypeCloseProxy         = 'c'
	TypeNewWorkConn        = 'w'
	TypeReqWorkConn        = 'r'
	TypeStartWorkConn      = 's'
	TypeNewVisitorConn     = 'v'
	TypeNewVisitorConnResp = '3'
	TypePing               = 'h'
	TypePong               = '4'
	TypeUdpPacket          = 'u'
	TypeNatHoleVisitor     = 'i'
	TypeNatHoleClient      = 'n'
	TypeNatHoleResp        = 'm'
	TypeNatHoleSid         = '5'
)

Variables

var (
	TypeMap       map[byte]reflect.Type
	TypeStringMap map[reflect.Type]byte
)

var (
	MaxMsgLength int64 = 10240
)

Functions

func Pack

func Pack(msg Message) ([]byte, error)

func ReadMsgInto

func ReadMsgInto(c io.Reader, msg Message) (err error)

func UnPackInto

func UnPackInto(buffer []byte, msg Message) (err error)

func WriteMsg

func WriteMsg(c io.Writer, msg interface{}) (err error)

Types

type CloseProxy

type CloseProxy struct {
	ProxyName string `json:"proxy_name"`
}

type Login

type Login struct {
	Version      string `json:"version"`
	Hostname     string `json:"hostname"`
	Os           string `json:"os"`
	Arch         string `json:"arch"`
	User         string `json:"user"`
	PrivilegeKey string `json:"privilege_key"`
	Timestamp    int64  `json:"timestamp"`
	RunId        string `json:"run_id"`

	// Some global configures.
	PoolCount int `json:"pool_count"`
}

When frpc start, client send this message to login to server.

type LoginResp

type LoginResp struct {
	Version       string `json:"version"`
	RunId         string `json:"run_id"`
	ServerUdpPort int64  `json:"server_udp_port"`
	Error         string `json:"error"`
}

type Message

type Message interface{}

Message wraps socket packages for communicating between frpc and frps.

func ReadMsg

func ReadMsg(c io.Reader) (msg Message, err error)

func UnPack

func UnPack(typeByte byte, buffer []byte) (msg Message, err error)

type NatHoleClient

type NatHoleClient struct {
	ProxyName string `json:"proxy_name"`
	Sid       string `json:"sid"`
}

type NatHoleResp

type NatHoleResp struct {
	Sid         string `json:"sid"`
	VisitorAddr string `json:"visitor_addr"`
	ClientAddr  string `json:"client_addr"`
}

type NatHoleSid

type NatHoleSid struct {
	Sid string `json:"sid"`
}

type NatHoleVisitor

type NatHoleVisitor struct {
	ProxyName string `json:"proxy_name"`
	SignKey   string `json:"sign_key"`
	Timestamp int64  `json:"timestamp"`
}

type NewProxy

type NewProxy struct {
	ProxyName      string `json:"proxy_name"`
	ProxyType      string `json:"proxy_type"`
	UseEncryption  bool   `json:"use_encryption"`
	UseCompression bool   `json:"use_compression"`

	// tcp and udp only
	RemotePort int64 `json:"remote_port"`

	// http and https only
	CustomDomains     []string `json:"custom_domains"`
	SubDomain         string   `json:"subdomain"`
	Locations         []string `json:"locations"`
	HostHeaderRewrite string   `json:"host_header_rewrite"`
	HttpUser          string   `json:"http_user"`
	HttpPwd           string   `json:"http_pwd"`

	// stcp
	Sk string `json:"sk"`
}

When frpc login success, send this message to frps for running a new proxy.

type NewProxyResp

type NewProxyResp struct {
	ProxyName string `json:"proxy_name"`
	Error     string `json:"error"`
}

type NewVisitorConn

type NewVisitorConn struct {
	ProxyName      string `json:"proxy_name"`
	SignKey        string `json:"sign_key"`
	Timestamp      int64  `json:"timestamp"`
	UseEncryption  bool   `json:"use_encryption"`
	UseCompression bool   `json:"use_compression"`
}

type NewVisitorConnResp

type NewVisitorConnResp struct {
	ProxyName string `json:"proxy_name"`
	Error     string `json:"error"`
}

type NewWorkConn

type NewWorkConn struct {
	RunId string `json:"run_id"`
}

type Ping

type Ping struct {
}

type Pong

type Pong struct {
}

type ReqWorkConn

type ReqWorkConn struct {
}

type StartWorkConn

type StartWorkConn struct {
	ProxyName string `json:"proxy_name"`
}

type UdpPacket

type UdpPacket struct {
	Content    string       `json:"c"`
	LocalAddr  *net.UDPAddr `json:"l"`
	RemoteAddr *net.UDPAddr `json:"r"`
}