client

Documentation

Overview

Package client is a client library for the msgbus server

Index

• Constants
• Variables
• type Client
  • func NewClient(url string, options *Options) *Client
  • func (c *Client) Publish(topic, message string) error
  • func (c *Client) Pull(topic string) (msg *msgbus.Message, err error)
  • func (c *Client) Subscribe(topic string, index int64, handler msgbus.HandlerFunc) *Subscriber
• type Options
• type Subscriber
  • func NewSubscriber(client *Client, topic string, index int64, handler msgbus.HandlerFunc) *Subscriber
  • func (s *Subscriber) Run(ctx context.Context) error

Constants

const (
	// DefaultReconnectInterval ...
	DefaultReconnectInterval = 2

	// DefaultMaxReconnectInterval ...
	DefaultMaxReconnectInterval = 64

	// DefaultPingInterval is the default time interval (in seconds) between pings
	DefaultPingInterval = 60
)

Variables

var (
	// ErrConnectionFailed is an error returned when the connection fails
	ErrConnectionFailed = errors.New("error: connection failed")
)

Types

type Client

type Client struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Client is a msgbus client

func NewClient

func NewClient(url string, options *Options) *Client

NewClient ...

func (*Client) Publish

func (c *Client) Publish(topic, message string) error

Publish ...

func (*Client) Pull

func (c *Client) Pull(topic string) (msg *msgbus.Message, err error)

Pull ...

func (*Client) Subscribe

func (c *Client) Subscribe(topic string, index int64, handler msgbus.HandlerFunc) *Subscriber

Subscribe ...

type Options

type Options struct {
	PingInterval         int
	ReconnectInterval    int
	MaxReconnectInterval int
}

Options ...

type Subscriber

type Subscriber struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Subscriber ...

func NewSubscriber

func NewSubscriber(client *Client, topic string, index int64, handler msgbus.HandlerFunc) *Subscriber

NewSubscriber ...

func (*Subscriber) Run

func (s *Subscriber) Run(ctx context.Context) error

Run runs the subscriber client with the provided context