github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/tcp/tcp.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 tcp implements a tcp listener.
    22  package tcp
    23  
    24  import (
    25  	"net"
    26  	"time"
    27  )
    28  
    29  // NewTCPListener is Listener specifically for TCP
    30  //
    31  // TODO(jeromefroe): Move this into the net package which covers network I/O.
    32  func NewTCPListener(listenAddress string, keepAlivePeriod time.Duration) (net.Listener, error) {
    33  	l, err := net.Listen("tcp", listenAddress)
    34  	if err != nil {
    35  		return nil, err
    36  	}
    37  	return tcpKeepAliveListener{l.(*net.TCPListener), keepAlivePeriod}, err
    38  }
    39  
    40  // tcpKeepAliveListener sets TCP keep-alive timeouts on accepted
    41  // connections. It's used by ListenAndServe and ListenAndServeTLS so
    42  // dead TCP connections (e.g. closing laptop mid-download) eventually
    43  // go away. This is cargo culted from http/server.go
    44  type tcpKeepAliveListener struct {
    45  	*net.TCPListener
    46  	keepAlivePeriod time.Duration
    47  }
    48  
    49  func (ln tcpKeepAliveListener) Accept() (c net.Conn, err error) {
    50  	tc, err := ln.AcceptTCP()
    51  	if err != nil {
    52  		return
    53  	}
    54  	tc.SetKeepAlive(true)
    55  	tc.SetKeepAlivePeriod(ln.keepAlivePeriod)
    56  	return tc, nil
    57  }