tokenbucket

Documentation

Overview

Package tokenbucket registers a job that is used to fetch a token from a token bucket.

Register name: "tokenBucket" Args:

"bucket"(mandatory): The name of the bucket
"fatal"(mandatory): true if a failure should cause a fatal error, false if it should block until it gets one

Result:

If the site is not in decom, will return a fatal error.

Index

• type Job
  • func (j *Job) Run(ctx context.Context, job *pb.Job) error
  • func (j *Job) Validate(job *pb.Job) error

Types

type Job

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

Job implements jobs.Job.

func (*Job) Run

func (j *Job) Run(ctx context.Context, job *pb.Job) error

Run implements jobs.Job.Run().

func (*Job) Validate

func (j *Job) Validate(job *pb.Job) error

Validate implements jobs.Job.Validate().