github.com/cloudwego/kitex@v0.9.0/internal/server/config.go (about)

     1  /*
     2   * Copyright 2021 CloudWeGo Authors
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *     http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package server
    18  
    19  import (
    20  	"net"
    21  	"time"
    22  
    23  	"github.com/cloudwego/kitex/pkg/utils"
    24  )
    25  
    26  const (
    27  	defaultExitWaitTime          = 5 * time.Second
    28  	defaultAcceptFailedDelayTime = 10 * time.Millisecond
    29  	defaultConnectionIdleTime    = 10 * time.Minute
    30  )
    31  
    32  var defaultAddress = utils.NewNetAddr("tcp", ":8888")
    33  
    34  // Config contains some server-side configuration.
    35  type Config struct {
    36  	Address net.Addr
    37  
    38  	// Duration that server waits for to allow any existing connection to be closed gracefully.
    39  	ExitWaitTime time.Duration
    40  
    41  	// Duration that server waits for after error occurs during connection accepting.
    42  	AcceptFailedDelayTime time.Duration
    43  
    44  	// Duration that the accepted connection waits for to read or write data, only works under NIO.
    45  	MaxConnectionIdleTime time.Duration
    46  }
    47  
    48  // NewConfig creates a new default config.
    49  func NewConfig() *Config {
    50  	return &Config{
    51  		Address:               defaultAddress,
    52  		ExitWaitTime:          defaultExitWaitTime,
    53  		AcceptFailedDelayTime: defaultAcceptFailedDelayTime,
    54  		MaxConnectionIdleTime: defaultConnectionIdleTime,
    55  	}
    56  }