concurrencylimiter

Documentation

Index

• func TemporarilyRelease(ctx context.Context, f func())
• func With(ctx context.Context, limit int) context.Context
• type ReleaseFunc
  • func Acquire(ctx context.Context) (context.Context, ReleaseFunc)

Functions

func TemporarilyRelease

func TemporarilyRelease(ctx context.Context, f func())

TemporarilyRelease temporarily releases a concurrency limiter token (if any) while calling a long-running but no-resource-using function f.

func With

func With(ctx context.Context, limit int) context.Context

With attaches a new limiter to the context with the given limit.

Types

type ReleaseFunc

type ReleaseFunc func()

A ReleaseFunc releases a concurrency limiter token.

func Acquire

func Acquire(ctx context.Context) (context.Context, ReleaseFunc)

Acquire acquires a concurrency limiter token. If the context is canceled or if there is no concurrency limit associated with the context it succeeds immediately and returns a no-op release function.

The returned release function is idempotent.