flare

Documentation

Index

• Variables
• func ClientConfig(config string) func(*Client)
• type Client
  • func NewClient(options ...func(*Client)) (*Client, error)
  • func (c *Client) Setup(ctx context.Context) error
  • func (c *Client) Start() error
  • func (c *Client) Stop() error

Variables

var (
	Version   = ""
	BuildTime = ""
	Commit    = ""
	GoVersion = runtime.Version()
)

Variables set with ldflags during compilation.

Functions

func ClientConfig

func ClientConfig(config string) func(*Client)

ClientConfig set the config on client.

Types

type Client

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

Client is responsible to init Flare.

func NewClient

func NewClient(options ...func(*Client)) (*Client, error)

NewClient return a initialized client.

func (*Client) Setup

func (c *Client) Setup(ctx context.Context) error

Setup is used to bootstrap the providers.

func (*Client) Start

func (c *Client) Start() error

Start the service.

func (*Client) Stop

func (c *Client) Stop() error

Stop the service.