The highest tagged major version is
Documentation
¶
Index ¶
- Constants
- Variables
- func GetUserConfigFilePath() string
- func InstallDefaultUserConfig() error
- type Config
- func (c *Config) Check() (err error)
- func (c *Config) InitHTTPClient()
- func (c *Config) LoadConfigFromContent(content []byte) (err error)
- func (c *Config) LoadConfigFromFilePath(filePath string) (err error)
- func (c *Config) LoadDefaultConfig() (err error)
- func (c *Config) LoadUserConfig() (err error)
- type HTTPClientSettings
Constants ¶
const DefaultConfigFile = "~/.qingstor/config.yaml"
DefaultConfigFile is the filename of default config file.
const DefaultConfigFileContent = `` /* 310-byte string literal not displayed */
DefaultConfigFileContent is the content of default config file.
Variables ¶
var DefaultHTTPClientSettings = HTTPClientSettings{ ConnectTimeout: time.Second * 30, ReadTimeout: time.Second * 30, WriteTimeout: time.Second * 30, TLSHandshakeTimeout: time.Second * 10, IdleConnTimeout: time.Second * 20, TCPKeepAlive: 0, DualStack: false, MaxIdleConns: 100, MaxIdleConnsPerHost: 10, ExpectContinueTimeout: time.Second * 2, }
DefaultHTTPClientSettings is the default http client settings.
Functions ¶
func GetUserConfigFilePath ¶
func GetUserConfigFilePath() string
GetUserConfigFilePath returns the user config file path.
func InstallDefaultUserConfig ¶
func InstallDefaultUserConfig() error
InstallDefaultUserConfig will install default config file.
Types ¶
type Config ¶
type Config struct {
AccessKeyID string `yaml:"access_key_id"`
SecretAccessKey string `yaml:"secret_access_key"`
Host string `yaml:"host"`
Port int `yaml:"port"`
Protocol string `yaml:"protocol"`
ConnectionRetries int `yaml:"connection_retries"`
AdditionalUserAgent string `yaml:"additional_user_agent"`
LogLevel string `yaml:"log_level"`
HTTPSettings HTTPClientSettings
Connection *http.Client
}
A Config stores a configuration of this sdk.
func NewDefault ¶
NewDefault create a Config with default configuration.
func (*Config) InitHTTPClient ¶
func (c *Config) InitHTTPClient()
InitHTTPClient : After modifying Config.HTTPSettings, you should always call this to initialize the HTTP Client.
func (*Config) LoadConfigFromContent ¶
LoadConfigFromContent loads configuration from a given byte slice. It returns error if yaml decode failed.
func (*Config) LoadConfigFromFilePath ¶
LoadConfigFromFilePath loads configuration from a specified local path. It returns error if file not found or yaml decode failed.
func (*Config) LoadDefaultConfig ¶
LoadDefaultConfig loads the default configuration for Config. It returns error if yaml decode failed.
func (*Config) LoadUserConfig ¶
LoadUserConfig loads user configuration in ~/.qingstor/config.yaml for Config. It returns error if file not found.
type HTTPClientSettings ¶
type HTTPClientSettings struct {
// ConnectTimeout affects making new socket connection
ConnectTimeout time.Duration `yaml:"connect_timeout"`
// ReadTimeout affect each call to HTTPResponse.Body.Read()
ReadTimeout time.Duration `yaml:"read_timeout"`
// WriteTimeout affect each write in io.Copy while sending HTTPRequest
WriteTimeout time.Duration `yaml:"write_timeout" `
// TLSHandshakeTimeout affects https hand shake timeout
TLSHandshakeTimeout time.Duration `yaml:"tls_timeout"`
// IdleConnTimeout affects the time limit to re-use http connections
IdleConnTimeout time.Duration `yaml:"idle_timeout"`
TCPKeepAlive time.Duration `yaml:"tcp_keepalive_time"`
DualStack bool `yaml:"dual_stack"`
// MaxIdleConns affects the idle connections kept for re-use
MaxIdleConns int `yaml:"max_idle_conns"`
MaxIdleConnsPerHost int `yaml:"max_idle_conns_per_host"`
ExpectContinueTimeout time.Duration `yaml:"expect_continue_timeout"`
}
HTTPClientSettings is the http client settings.
Source Files