cherryClient

Documentation

Index

• type ActionFn
• type Client
  • func New(opts ...Option) *Client
  • func (p *Client) AddAction(actionFn ActionFn)
  • func (p *Client) Codec() cfacade.IPacketCodec
  • func (p *Client) ConnectToTCP(addr string, tlsConfig ...*tls.Config) error
  • func (p *Client) ConnectToWS(addr string, path string, tlsConfig ...*tls.Config) error
  • func (p *Client) Disconnect()
  • func (p *Client) HandshakeData() *HandshakeData
  • func (p *Client) IsConnected() bool
  • func (p *Client) Notify(route string, val interface{}) error
  • func (p *Client) On(route string, fn OnMessageFn)
  • func (p *Client) Request(route string, val interface{}) (*cmsg.Message, error)
  • func (p *Client) Send(msgType cmsg.Type, route string, val interface{}) (uint, error)
  • func (p *Client) SendRaw(typ cpacket.Type, data []byte) error
  • func (p *Client) Serializer() cfacade.ISerializer
• type HandshakeData
• type HandshakeSys
• type OnMessageFn
• type Option
  • func WithErrorBreak(isBreak bool) Option
  • func WithHandshake(handshake string) Option
  • func WithHeartbeat(heartBeat int) Option
  • func WithPacketCodec(codec cfacade.IPacketCodec) Option
  • func WithRequestTimeout(requestTimeout time.Duration) Option
  • func WithSerializer(serializer cfacade.ISerializer) Option
• type RequestContext
  • func NewRequestContext(t time.Duration) RequestContext
  • func (p *RequestContext) Close()

Types

type ActionFn

type ActionFn func() error

type Client

type Client struct {
	TagName string // 客户标识
	// contains filtered or unexported fields
}

Client struct

func New

func New(opts ...Option) *Client

New returns a new client

func (*Client) AddAction

func (p *Client) AddAction(actionFn ActionFn)

func (*Client) Codec

func (p *Client) Codec() cfacade.IPacketCodec

func (*Client) ConnectToTCP

func (p *Client) ConnectToTCP(addr string, tlsConfig ...*tls.Config) error

func (*Client) ConnectToWS

func (p *Client) ConnectToWS(addr string, path string, tlsConfig ...*tls.Config) error

func (*Client) Disconnect

func (p *Client) Disconnect()

func (*Client) HandshakeData

func (p *Client) HandshakeData() *HandshakeData

func (*Client) IsConnected

func (p *Client) IsConnected() bool

IsConnected return the connection status

func (*Client) Notify

func (p *Client) Notify(route string, val interface{}) error

Notify sends a notify to the server

func (*Client) On

func (p *Client) On(route string, fn OnMessageFn)

On listener route

func (*Client) Request

func (p *Client) Request(route string, val interface{}) (*cmsg.Message, error)

func (*Client) Send

func (p *Client) Send(msgType cmsg.Type, route string, val interface{}) (uint, error)

Send the message to the server

func (*Client) SendRaw

func (p *Client) SendRaw(typ cpacket.Type, data []byte) error

func (*Client) Serializer

func (p *Client) Serializer() cfacade.ISerializer

type HandshakeData

type HandshakeData struct {
	Code int          `json:"code"`
	Sys  HandshakeSys `json:"sys"`
}

HandshakeData struct

type HandshakeSys

type HandshakeSys struct {
	Dict       map[string]uint16 `json:"dict"`
	Heartbeat  int               `json:"heartbeat"`
	Serializer string            `json:"serializer"`
}

HandshakeSys struct

type OnMessageFn

type OnMessageFn func(msg *cmsg.Message)

type Option

type Option func(options *options)

func WithErrorBreak

func WithErrorBreak(isBreak bool) Option

func WithHandshake

func WithHandshake(handshake string) Option

func WithHeartbeat

func WithHeartbeat(heartBeat int) Option

func WithPacketCodec

func WithPacketCodec(codec cfacade.IPacketCodec) Option

func WithRequestTimeout

func WithRequestTimeout(requestTimeout time.Duration) Option

func WithSerializer

func WithSerializer(serializer cfacade.ISerializer) Option

type RequestContext

type RequestContext struct {
	*time.Ticker
	Chan chan *cmsg.Message
}

func NewRequestContext

func NewRequestContext(t time.Duration) RequestContext

func (*RequestContext) Close

func (p *RequestContext) Close()