cherryClient

Documentation

Index

• type Client
  • func New(requestTimeout ...time.Duration) *Client
  • func (c *Client) ConnectTo(addr string) error
  • func (c *Client) ConnectToTLS(addr string, skipVerify bool) error
  • func (c *Client) ConnectedStatus() bool
  • func (c *Client) Disconnect()
  • func (c *Client) MsgChannel() chan *cherryMessage.Message
  • func (c *Client) SendNotify(route string, data []byte) error
  • func (c *Client) SendRequest(route string, data []byte) (uint, error)
• type HandshakeData
• type HandshakeSys
• type IClient

Types

type Client

type Client struct {
	Connected bool

	IncomingMsgChan chan *cherryMessage.Message
	// contains filtered or unexported fields
}

Client struct

func New

func New(requestTimeout ...time.Duration) *Client

New returns a new client

func (*Client) ConnectTo

func (c *Client) ConnectTo(addr string) error

ConnectTo connects to the server at addr, for now the only supported protocol is tcp this methods blocks as it also handles the messages from the server

func (*Client) ConnectToTLS

func (c *Client) ConnectToTLS(addr string, skipVerify bool) error

ConnectToTLS connects to the server at addr using TLS, for now the only supported protocol is tcp this methods blocks as it also handles the messages from the server

func (*Client) ConnectedStatus

func (c *Client) ConnectedStatus() bool

ConnectedStatus return the connection status

func (*Client) Disconnect

func (c *Client) Disconnect()

Disconnect disconnects the client

func (*Client) MsgChannel

func (c *Client) MsgChannel() chan *cherryMessage.Message

MsgChannel return the incoming message channel

func (*Client) SendNotify

func (c *Client) SendNotify(route string, data []byte) error

SendNotify sends a notify to the server

func (*Client) SendRequest

func (c *Client) SendRequest(route string, data []byte) (uint, error)

SendRequest sends a request to the server

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 IClient

type IClient interface {
	ConnectTo(addr string) error
	ConnectToTLS(addr string, skipVerify bool) error
	Disconnect()
	SendNotify(route string, data []byte) error
	SendRequest(route string, data []byte) (uint, error)
	ConnectedStatus() bool
	MsgChannel() chan *cherryMessage.Message
}