github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/ratelimit/options.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  const (
    24  	// defaultLimitEnabled determines whether rate limiting is enabled
    25  	defaultLimitEnabled = false
    26  
    27  	// defaultLimitCheckEvery is the default frequency for checking
    28  	// whether the limit is exceeded
    29  	defaultLimitCheckEvery = 128
    30  
    31  	// defaultLimitMbps is the default limit in Mb/s
    32  	defaultLimitMbps = 100.0
    33  )
    34  
    35  type options struct {
    36  	limitEnabled    bool
    37  	limitMbps       float64
    38  	limitCheckEvery int
    39  }
    40  
    41  // NewOptions creates a new rate limit options
    42  func NewOptions() Options {
    43  	return &options{
    44  		limitEnabled:    defaultLimitEnabled,
    45  		limitMbps:       defaultLimitMbps,
    46  		limitCheckEvery: defaultLimitCheckEvery,
    47  	}
    48  }
    49  
    50  func (o *options) SetLimitEnabled(value bool) Options {
    51  	opts := *o
    52  	opts.limitEnabled = value
    53  	return &opts
    54  }
    55  
    56  func (o *options) LimitEnabled() bool {
    57  	return o.limitEnabled
    58  }
    59  
    60  func (o *options) SetLimitMbps(value float64) Options {
    61  	opts := *o
    62  	opts.limitMbps = value
    63  	return &opts
    64  }
    65  
    66  func (o *options) LimitMbps() float64 {
    67  	return o.limitMbps
    68  }
    69  
    70  func (o *options) SetLimitCheckEvery(value int) Options {
    71  	opts := *o
    72  	opts.limitCheckEvery = value
    73  	return &opts
    74  }
    75  
    76  func (o *options) LimitCheckEvery() int {
    77  	return o.limitCheckEvery
    78  }