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

     1  // Copyright (c) 2018 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 server
    22  
    23  import (
    24  	"time"
    25  
    26  	"github.com/m3db/m3/src/x/instrument"
    27  	"github.com/m3db/m3/src/x/retry"
    28  )
    29  
    30  // Configuration configs a server.
    31  type Configuration struct {
    32  	// Server listening address.
    33  	ListenAddress string `yaml:"listenAddress" validate:"nonzero"`
    34  
    35  	// Retry mechanism configuration.
    36  	Retry retry.Configuration `yaml:"retry"`
    37  
    38  	// Whether keep alives are enabled on connections.
    39  	KeepAliveEnabled *bool `yaml:"keepAliveEnabled"`
    40  
    41  	// KeepAlive period.
    42  	KeepAlivePeriod *time.Duration `yaml:"keepAlivePeriod"`
    43  }
    44  
    45  // NewOptions creates server options.
    46  func (c Configuration) NewOptions(iOpts instrument.Options) Options {
    47  	opts := NewOptions().
    48  		SetRetryOptions(c.Retry.NewOptions(iOpts.MetricsScope())).
    49  		SetInstrumentOptions(iOpts)
    50  	if c.KeepAliveEnabled != nil {
    51  		opts = opts.SetTCPConnectionKeepAlive(*c.KeepAliveEnabled)
    52  	}
    53  	if c.KeepAlivePeriod != nil {
    54  		opts = opts.SetTCPConnectionKeepAlivePeriod(*c.KeepAlivePeriod)
    55  	}
    56  	return opts
    57  }
    58  
    59  // NewServer creates a new server.
    60  func (c Configuration) NewServer(handler Handler, iOpts instrument.Options) Server {
    61  	return NewServer(c.ListenAddress, handler, c.NewOptions(iOpts))
    62  }