resource

package

v0.8.0 Latest Latest Go to latest Published: Apr 25, 2024 License: MPL-2.0 Imports: 3 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

Package resource defines different concurrent access strategies for resources.

This section is empty.

This section is empty.

This section is empty.

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

Bounded is a bounded resource.

func NewBounded(n int) *Bounded

NewBounded creates a new bounded resource that can be acquired n times concurrently.

func (r *Bounded) Acquire(ctx context.Context) bool

Acquire acquires the resource. If the resource is already acquired n times, wait until another one is released.

func (r *Bounded) Release()

Release a previously acquired resource.

type R interface {
	Acquire(ctx context.Context) bool
	Release()
}

R is the resource interface.

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

Throttled in a rate-limited resource.

func NewThrottled(requestsPerSecond int64) *Throttled

NewThrottled creates a resource with the given rate limit.

func (r *Throttled) Acquire(ctx context.Context) bool

Acquire can be called concurrently, and blocks callers so that are let through as the rate limit requires.

func (*Throttled) Release()

Release for this resource type is no-op.