nutcracker

package

v0.0.0-...-4c3ecd7 Latest Latest Go to latest Published: Aug 26, 2021 License: GPL-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

API represents a nutcracker API

func NewAPI(creds *Creds, server string) *API

NewAPI returns a new nutcracker API. If creds are nil, an unauthenticated request will be made.

func (a *API) Delete(path string) (response []byte, err error)

Delete sents a DELETE request

func (a *API) Get(path string) (response []byte, err error)

Get sents a GET request

func (a *API) Post(path string, data APIReq) (response []byte, err error)

Post sends a POST request

type APIReq map[string]interface{}

APIReq is a convenient way of passing a request

func NewAPIReq() APIReq

NewAPIReq returns a new APIReq

func (a APIReq) Set(key string, value interface{}) APIReq

Set sets a value in a request.

type Creds struct {
	Username string
	Password string
	Admin    bool `json:"-"`
}

Creds is an interface to send credentials

type MetricVal struct {
	Keys    int
	Secrets int
	Views   int
	Sealed  bool
	// contains filtered or unexported fields
}

type Metrics struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewMetrics(server string) (m *Metrics)

NewMetrics creates a new metric poller

func (m *Metrics) Latest() MetricVal

Latest returns the latest metric data set

func (m *Metrics) Update() (err error)

Update updates the metric data from the server