permits

Documentation

Overview

Package permits is used to provide permitGiver which maintains a sync map whose values can be deleted if not accessed for a configured time

Index

• type PermitGiver
  • func NewPermitGiver(stalePermitKeyTimeout time.Duration, janitorFrequency time.Duration) PermitGiver

Types

type PermitGiver

type PermitGiver interface {
	RegisterPermits(key string, numPermits int)
	TryPermit(key string, timeout time.Duration) bool
	ReleasePermit(key string)
	DeletePermits(key string)
	Close()
}

PermitGiver provides different operations regarding permit for a given key

func NewPermitGiver

func NewPermitGiver(stalePermitKeyTimeout time.Duration, janitorFrequency time.Duration) PermitGiver

NewPermitGiver returns a new PermitGiver