client

Documentation

Index

• func CanCreateTCPConnection(address string, config *Config) bool
• func CanPerformStartTLS(address string, config *Config) (connected bool, certificate *x509.Certificate, err error)
• func CanPerformTLS(address string, config *Config) (connected bool, certificate *x509.Certificate, err error)
• func GetHTTPClient(config *Config) *http.Client
• func Ping(address string, config *Config) (bool, time.Duration)
• type Config
  • func GetDefaultConfig() *Config
  • func (c *Config) ValidateAndSetDefaults()

Functions

func CanCreateTCPConnection

func CanCreateTCPConnection(address string, config *Config) bool

CanCreateTCPConnection checks whether a connection can be established with a TCP service

func CanPerformStartTLS

func CanPerformStartTLS(address string, config *Config) (connected bool, certificate *x509.Certificate, err error)

CanPerformStartTLS checks whether a connection can be established to an address using the STARTTLS protocol

func CanPerformTLS

func CanPerformTLS(address string, config *Config) (connected bool, certificate *x509.Certificate, err error)

CanPerformTLS checks whether a connection can be established to an address using the TLS protocol

func GetHTTPClient

func GetHTTPClient(config *Config) *http.Client

GetHTTPClient returns the shared HTTP client

func Ping

func Ping(address string, config *Config) (bool, time.Duration)

Ping checks if an address can be pinged and returns the round-trip time if the address can be pinged

Note that this function takes at least 100ms, even if the address is 127.0.0.1

Types

type Config

type Config struct {
	// Insecure determines whether to skip verifying the server's certificate chain and host name
	Insecure bool `yaml:"insecure"`

	// IgnoreRedirect determines whether to ignore redirects (true) or follow them (false, default)
	IgnoreRedirect bool `yaml:"ignore-redirect"`

	// Timeout for the client
	Timeout time.Duration `yaml:"timeout"`
	// contains filtered or unexported fields
}

Config is the configuration for clients

func GetDefaultConfig

func GetDefaultConfig() *Config

GetDefaultConfig returns a copy of the default configuration

func (*Config) ValidateAndSetDefaults

func (c *Config) ValidateAndSetDefaults()

ValidateAndSetDefaults validates the client configuration and sets the default values if necessary