go.temporal.io/server@v1.23.0/common/quotas/noop_reservation_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  	"time"
    29  )
    30  
    31  type (
    32  	NoopReservationImpl struct{}
    33  )
    34  
    35  var _ Reservation = (*NoopReservationImpl)(nil)
    36  
    37  var NoopReservation Reservation = &NoopReservationImpl{}
    38  
    39  // OK returns whether the limiter can provide the requested number of tokens
    40  func (r *NoopReservationImpl) OK() bool {
    41  	return true
    42  }
    43  
    44  // Cancel indicates that the reservation holder will not perform the reserved action
    45  // and reverses the effects of this Reservation on the rate limit as much as possible
    46  func (r *NoopReservationImpl) Cancel() {
    47  	// noop
    48  }
    49  
    50  // CancelAt indicates that the reservation holder will not perform the reserved action
    51  // and reverses the effects of this Reservation on the rate limit as much as possible
    52  func (r *NoopReservationImpl) CancelAt(_ time.Time) {
    53  	// noop
    54  }
    55  
    56  // Delay returns the duration for which the reservation holder must wait
    57  // before taking the reserved action.  Zero duration means act immediately.
    58  func (r *NoopReservationImpl) Delay() time.Duration {
    59  	return time.Duration(0) // no delay
    60  }
    61  
    62  // DelayFrom returns the duration for which the reservation holder must wait
    63  // before taking the reserved action.  Zero duration means act immediately.
    64  func (r *NoopReservationImpl) DelayFrom(_ time.Time) time.Duration {
    65  	return time.Duration(0) // no delay
    66  }