client

Documentation

Index

• type Client
  • func NewClient(opts *Options) (c *Client, err error)
  • func (c *Client) Ack(event string, v interface{}, r interface{}) (err error)
  • func (c *Client) Close()
  • func (c *Client) Emit(event string, v interface{}) (err error)
  • func (c *Client) IsClosed() bool
  • func (c *Client) MustStart()
  • func (c *Client) On(e string, fn EventHandler)
  • func (c *Client) RemoteAddr() string
  • func (c *Client) Start() error
• type Context
• type EventHandler
• type Options
  • func DefaultOptions() *Options

Types

type Client

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

func NewClient

func NewClient(opts *Options) (c *Client, err error)

func (*Client) Ack

func (c *Client) Ack(event string, v interface{}, r interface{}) (err error)

func (*Client) Close

func (c *Client) Close()

func (*Client) Emit

func (c *Client) Emit(event string, v interface{}) (err error)

func (*Client) IsClosed

func (c *Client) IsClosed() bool

func (*Client) MustStart

func (c *Client) MustStart()

func (*Client) On

func (c *Client) On(e string, fn EventHandler)

func (*Client) RemoteAddr

func (c *Client) RemoteAddr() string

func (*Client) Start

func (c *Client) Start() error

type Context

type Context interface {
	IsClosed() bool
	Close()

	Emit(event string, v interface{}) error
	Ack(event string, v interface{}, r interface{}) error

	Content() []byte
	Packet() air.Packet
	Bind(v interface{}) error

	Reply(v interface{}) error

	Logger() air.Logger
}

type EventHandler

type EventHandler func(c Context) error

type Options

type Options struct {
	// common
	WorkId                 uint16
	Address                string
	PacketSendChanLimit    uint32
	PacketReceiveChanLimit uint32
	MessageTimeout         time.Duration
	Codec                  air.Codec
	Logger                 air.Logger

	// only for client
	HeartbeatInterval time.Duration
	ReconnectInterval time.Duration
	ReconnectLimit    uint32
	Reconnect         bool
}

func DefaultOptions

func DefaultOptions() *Options