resource

Documentation

Overview

Package resource defines different concurrent access strategies for resources.

Index

• type Bounded
  • func NewBounded(n int) *Bounded
  • func (r *Bounded) Acquire(ctx context.Context) bool
  • func (r *Bounded) Release()
• type R
• type Throttled
  • func NewThrottled(requestsPerSecond int64) *Throttled
  • func (r *Throttled) Acquire(ctx context.Context) bool
  • func (*Throttled) Release()

Types

type Bounded

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

Bounded is a bounded resource.

func NewBounded

func NewBounded(n int) *Bounded

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

func (*Bounded) Acquire

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 (*Bounded) Release

func (r *Bounded) Release()

Release a previously acquired resource.

type R

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

R is the resource interface.

type Throttled

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

Throttled in a rate-limited resource.

func NewThrottled

func NewThrottled(requestsPerSecond int64) *Throttled

NewThrottled creates a resource with the given rate limit.

func (*Throttled) Acquire

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

func (*Throttled) Release()

Release for this resource type is no-op.