clistats

type DynamicCallback func(client StatisticsClient) interface{}

type PrintCallback func(client StatisticsClient)

type RequestPerSecondCallbackOptions struct {
	// StartTimeFieldID is the ID of the start time field for the client.
	StartTimeFieldID string
	// RequestsCounterID is the ID of the sent request counter
	RequestsCounterID string
}

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

type StatisticsClient interface {
	// Start starts the event loop of the stats client.
	Start(printer PrintCallback, tickDuration time.Duration) error
	// Stop stops the event loop of the stats client
	Stop() error

	// AddCounter adds a uint64 counter field to the statistics client.
	//
	// A counter is used to track an increasing quantity, like requests,
	// errors etc.
	AddCounter(id string, value uint64)

	// GetCounter returns the current value of a counter.
	GetCounter(id string) (uint64, bool)

	// IncrementCounter increments the value of a counter by a count.
	IncrementCounter(id string, count int)

	// AddStatic adds a static information field to the statistics.
	//
	// The value for these metrics will remain constant throughout the
	// lifecycle of the statistics client. All the values will be
	// converted into string and displayed as such.
	AddStatic(id string, value interface{})

	// GetStatic returns the original value for a static field.
	GetStatic(id string) (interface{}, bool)

	// AddDynamic adds a dynamic field to display whose value
	// is retrieved by running a callback function.
	//
	// The callback function performs some actions and returns the value
	// to display. Generally this is used for calculating requests per
	// seconds, elapsed time, etc.
	AddDynamic(id string, Callback DynamicCallback)

	// GetDynamic returns the dynamic field callback for data retrieval.
	GetDynamic(id string) (DynamicCallback, bool)
}