bandwidth

package

v0.0.0-...-fb0f190 Latest Latest Go to latest Published: Oct 26, 2022 License: AGPL-3.0 Imports: 8 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 Monitor struct {
	NodeCount uint64
	// contains filtered or unexported fields
}

Monitor holds the state of the global bucket monitor

func NewMonitor(ctx context.Context, numNodes uint64) *Monitor

NewMonitor returns a monitor with defaults.

func (m *Monitor) DeleteBucket(bucket string)

DeleteBucket deletes monitoring the 'bucket'

func (m *Monitor) GetReport(selectBucket SelectionFunction) *madmin.BucketBandwidthReport

GetReport gets the report for all bucket bandwidth details.

func (m *Monitor) IsThrottled(bucket string) bool

IsThrottled returns true if a bucket has bandwidth throttling enabled.

func (m *Monitor) SetBandwidthLimit(bucket string, limit int64)

SetBandwidthLimit sets the bandwidth limit for a bucket

type MonitorReaderOptions struct {
	Bucket     string
	HeaderSize int
}

MonitorReaderOptions provides configurable options for monitor reader implementation.

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

MonitoredReader represents a throttled reader subject to bandwidth monitoring

func NewMonitoredReader(ctx context.Context, m *Monitor, r io.Reader, opts *MonitorReaderOptions) *MonitoredReader

NewMonitoredReader returns reference to a monitored reader that throttles reads to configured bandwidth for the bucket.

func (r *MonitoredReader) Read(buf []byte) (n int, err error)

Read implements a throttled read

type SelectionFunction func(bucket string) bool

SelectionFunction for buckets

func SelectBuckets(buckets ...string) SelectionFunction

SelectBuckets will select all the buckets passed in.