qos

package

v0.0.0-...-711078c Latest Latest Go to latest Published: Dec 16, 2019 License: BSD-2-Clause Imports: 12 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

Repository

github.com/lateefj/shylock

Links

Open Source Insights

Documentation ¶

Index ¶

func Setup(iom *IOMap)
type ByteLimit
- func (bl *ByteLimit) Available() uint64
- func (bl *ByteLimit) Reset()
type IOC
- func NewIOC(duration time.Duration, rLimit, wLimit uint64) *IOC
type IOMap
- func LoadIOCConfig(f io.Reader) *IOMap
- func NewIOMap() *IOMap
type Rest
- func NewRest(m *IOMap) *Rest
- func (r *Rest) Default(w http.ResponseWriter, req *http.Request)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Setup ¶

func Setup(iom *IOMap)

Setup ... This associates the IOMap with rest endpoints

Types ¶

type ByteLimit ¶

type ByteLimit struct {
	Bytes    uint64
	Limit    uint64
	Mutex    *sync.RWMutex
	Notifier *sync.Cond
}

ByteLimit ... Controls how many bytes can be consumed

func (*ByteLimit) Available ¶

func (bl *ByteLimit) Available() uint64

Available ... Returns the amoutn of bytes that are still available

func (*ByteLimit) Reset ¶

func (bl *ByteLimit) Reset()

Reset ... This will reset the allocation of bytes (should get run at the end of every duration)

type IOC ¶

type IOC struct {
	Mutex    sync.RWMutex
	Notifier *sync.Cond
	// contains filtered or unexported fields
}

IOC Input / Ouput Constraint

func NewIOC ¶

func NewIOC(duration time.Duration, rLimit, wLimit uint64) *IOC

NewIOC ... Create a new IOC

func (*IOC) Active ¶

func (ioc *IOC) Active() bool

Active ... Check to see if there is already a goroutine running checks

func (*IOC) Checkout ¶

func (ioc *IOC) Checkout(bl *ByteLimit, requested uint64, stream chan uint64) error

Checkout ... quick way to get a stream of bytes

func (*IOC) CheckoutRead ¶

func (ioc *IOC) CheckoutRead(requested uint64, stream chan uint64) error

CheckoutRead ... gets a read

func (*IOC) CheckoutWrite ¶

func (ioc *IOC) CheckoutWrite(requested uint64, stream chan uint64) error

CheckoutWrite ... gets a stream ow writes

func (*IOC) Start ¶

func (ioc *IOC) Start()

Start ...start wil provision out bytes as needed

func (*IOC) Stop ¶

func (ioc *IOC) Stop()

Stop ... This top the goroutine

func (*IOC) Update ¶

func (ioc *IOC) Update(duration time.Duration, read, write uint64)

Update ... changes duration and read

type IOMap ¶

type IOMap struct {
	Map   map[string]*IOC
	Mutex sync.RWMutex
}

IOMap ... Mapping of key to IOC

func LoadIOCConfig ¶

func LoadIOCConfig(f io.Reader) *IOMap

LoadIOCConfig ... Takes an io.Reader expecting csv file and returns a *IOMap

func NewIOMap ¶

func NewIOMap() *IOMap

NewIOMap ... Creates a new IOMap with default params

func (*IOMap) Add ¶

func (iom *IOMap) Add(key string, duration time.Duration, read, write uint64)

Add ... Add a IOC with a specific key to the map

func (*IOMap) FindPath ¶

func (iom *IOMap) FindPath(p string) *IOC

FindPath ... Search the keys space for first path to match

func (*IOMap) Get ¶

func (iom *IOMap) Get(key string) (*IOC, bool)

Get ... Retrieve based on a key

func (*IOMap) Remove ¶

func (iom *IOMap) Remove(key string)

Remove ... Remove a key

func (*IOMap) Update ¶

func (iom *IOMap) Update(key string, duration time.Duration, read, write uint64)

Update ... Update existing entry

type Rest ¶

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

Rest ... Structure that should make it easier to modify an IOMap mount at runtime

func NewRest ¶

func NewRest(m *IOMap) *Rest

NewRest ... Create an new instance of the Rest struct

func (*Rest) Default ¶

func (r *Rest) Default(w http.ResponseWriter, req *http.Request)

Default ... Default handler for a mounted system

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL