client

Documentation

Index

• type Client
  • func NewClient(conf *Config) Client
• type Config

Types

type Client

type Client interface {
	sielink.Link

	// DialAndHandle initiates a connection to the provided URL and
	// runs the Link protocol over this connection. It returns an error,
	// if any, when the connection ends.
	DialAndHandle(uri string) error

	// Subscribe requests data available on the supplied channels
	// from the servers.
	Subscribe(channels ...uint32)
}

A Client Link allows the caller to subscribe to a number of channels in addition to the base Link functionality.

func NewClient

func NewClient(conf *Config) Client

NewClient creates a Link appropriate for use as a client for uploading and subscribing to data from a collection of routers.

type Config

type Config struct {
	Heartbeat time.Duration
	URL       string
	APIKey    string
	TLSConfig *tls.Config
}

Config contains the configuration for a sieproto Client link.