go.temporal.io/server@v1.23.0/common/quotas/rate_limiter.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package quotas
    26  
    27  import (
    28  	"context"
    29  	"time"
    30  )
    31  
    32  //go:generate mockgen -copyright_file ../../LICENSE -package $GOPACKAGE -source $GOFILE -destination rate_limiter_mock.go
    33  
    34  type (
    35  	// RateLimiter corresponds to basic rate limiting functionality.
    36  	RateLimiter interface {
    37  		// Allow attempts to allow a request to go through. The method returns
    38  		// immediately with a true or false indicating if the request can make
    39  		// progress
    40  		Allow() bool
    41  
    42  		// AllowN attempts to allow a request to go through. The method returns
    43  		// immediately with a true or false indicating if the request can make
    44  		// progress
    45  		AllowN(now time.Time, numToken int) bool
    46  
    47  		// Reserve returns a Reservation that indicates how long the caller
    48  		// must wait before event happen.
    49  		Reserve() Reservation
    50  
    51  		// ReserveN returns a Reservation that indicates how long the caller
    52  		// must wait before event happen.
    53  		ReserveN(now time.Time, numToken int) Reservation
    54  
    55  		// Wait waits till the deadline for a rate limit token to allow the request
    56  		// to go through.
    57  		Wait(ctx context.Context) error
    58  
    59  		// WaitN waits till the deadline for n rate limit token to allow the request
    60  		// to go through.
    61  		WaitN(ctx context.Context, numToken int) error
    62  
    63  		// Rate returns the rate per second for this rate limiter
    64  		Rate() float64
    65  
    66  		// Burst returns the burst for this rate limiter
    67  		Burst() int
    68  	}
    69  )