github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/clock/config.go (about)

     1  // Copyright (c) 2017 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 clock
    22  
    23  import "time"
    24  
    25  // Configuration configures clock options.
    26  type Configuration struct {
    27  	// MaxPositiveSkew is the maximum positive clock skew
    28  	// with regard to a reference clock.
    29  	MaxPositiveSkew time.Duration `yaml:"maxPositiveSkew"`
    30  
    31  	// MaxNegativeSkew is the maximum negative clock skew
    32  	// with regard to a reference clock.
    33  	MaxNegativeSkew time.Duration `yaml:"maxNegativeSkew"`
    34  }
    35  
    36  // NewOptions creates a new set of options.
    37  func (c Configuration) NewOptions() Options {
    38  	opts := NewOptions()
    39  	if c.MaxPositiveSkew != 0 {
    40  		opts = opts.SetMaxPositiveSkew(c.MaxPositiveSkew)
    41  	}
    42  	if c.MaxNegativeSkew != 0 {
    43  		opts = opts.SetMaxNegativeSkew(c.MaxNegativeSkew)
    44  	}
    45  	return opts
    46  }