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

     1  // Copyright (c) 2020 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 net
    22  
    23  import (
    24  	gonet "net"
    25  
    26  	"github.com/valyala/tcplisten"
    27  )
    28  
    29  var (
    30  	reusePortConfig = &tcplisten.Config{
    31  		ReusePort:   true,
    32  		DeferAccept: true,
    33  		FastOpen:    true,
    34  	}
    35  )
    36  
    37  // ListenerOptions is a set of listener options that
    38  // can create listeners.
    39  type ListenerOptions struct {
    40  	reusePort bool
    41  }
    42  
    43  // ListenerOption is a listener option that can
    44  // be applied to a set of listener options.
    45  type ListenerOption func(o *ListenerOptions)
    46  
    47  // ListenerReusePort is a listener option to reuse ports.
    48  func ListenerReusePort(value bool) ListenerOption {
    49  	return func(o *ListenerOptions) {
    50  		o.reusePort = true
    51  	}
    52  }
    53  
    54  // NewListenerOptions creates a set of listener options
    55  // with supplied options.
    56  func NewListenerOptions(opts ...ListenerOption) ListenerOptions {
    57  	var result ListenerOptions
    58  	for _, fn := range opts {
    59  		fn(&result)
    60  	}
    61  	return result
    62  }
    63  
    64  // Listen creates a new listener based on options.
    65  func (o ListenerOptions) Listen(
    66  	protocol, address string,
    67  ) (gonet.Listener, error) {
    68  	if o.reusePort {
    69  		if protocol == "tcp" {
    70  			protocol = "tcp4"
    71  		}
    72  		return reusePortConfig.NewListener(protocol, address)
    73  	}
    74  	return gonet.Listen(protocol, address)
    75  }