go.temporal.io/server@v1.23.0/common/quotas/request_rate_limiter_adapter_impl.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  type (
    33  	RequestRateLimiterAdapterImpl struct {
    34  		rateLimiter RateLimiter
    35  	}
    36  )
    37  
    38  var _ RequestRateLimiter = (*RequestRateLimiterAdapterImpl)(nil)
    39  
    40  func NewRequestRateLimiterAdapter(
    41  	rateLimiter RateLimiter,
    42  ) RequestRateLimiter {
    43  	return &RequestRateLimiterAdapterImpl{
    44  		rateLimiter: rateLimiter,
    45  	}
    46  }
    47  
    48  func (r *RequestRateLimiterAdapterImpl) Allow(
    49  	now time.Time,
    50  	request Request,
    51  ) bool {
    52  	return r.rateLimiter.AllowN(now, request.Token)
    53  }
    54  
    55  func (r *RequestRateLimiterAdapterImpl) Reserve(
    56  	now time.Time,
    57  	request Request,
    58  ) Reservation {
    59  	return r.rateLimiter.ReserveN(now, request.Token)
    60  }
    61  
    62  func (r *RequestRateLimiterAdapterImpl) Wait(
    63  	ctx context.Context,
    64  	request Request,
    65  ) error {
    66  	return r.rateLimiter.WaitN(ctx, request.Token)
    67  }