github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/ratelimit/types.go (about)

     1  // Copyright (c) 2016 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package ratelimit
    22  
    23  // Options provides options for rate limiting
    24  type Options interface {
    25  	// SetLimitEnabled determines whether rate limiting is enabled
    26  	SetLimitEnabled(value bool) Options
    27  
    28  	// LimitEnabled returns whether rate limiting is enabled
    29  	LimitEnabled() bool
    30  
    31  	// SetLimitMbps sets the limit
    32  	SetLimitMbps(value float64) Options
    33  
    34  	// LimitMbps returns the limit
    35  	LimitMbps() float64
    36  
    37  	// SetLimitCheckEvery sets the limit check frequency
    38  	SetLimitCheckEvery(value int) Options
    39  
    40  	// LimitCheckEvery returns the limit check frequency
    41  	LimitCheckEvery() int
    42  }