ldhttp

Documentation

Overview

Package ldhttp provides helper functions for custom HTTP configuration. You will not need to use this package unless you need to extend the default Go HTTP client behavior, for instance, to specify additional trusted CA certificates.

Index

• func NewHTTPTransport(options ...TransportOption) (*http.Transport, *net.Dialer, error)
• type TransportOption
  • func CACertFileOption(filePath string) TransportOption
  • func CACertOption(certData []byte) TransportOption
  • func ConnectTimeoutOption(timeout time.Duration) TransportOption
  • func ProxyOption(url url.URL) TransportOption

Functions

func NewHTTPTransport

func NewHTTPTransport(options ...TransportOption) (*http.Transport, *net.Dialer, error)

NewHTTPTransport creates a customized http.Transport struct using the specified options. It returns both the Transport and an associated net.Dialer.

To configure the LaunchDarkly SDK, rather than calling this function directly, it is simpler to use ld.NewHTTPClientFactory().

Types

type TransportOption

type TransportOption interface {
	// contains filtered or unexported methods
}

TransportOption is the interface for optional configuration parameters that can be passed to NewHTTPTransport.

func CACertFileOption

func CACertFileOption(filePath string) TransportOption

CACertFileOption specifies a CA certificate to be added to the trusted root CA list for HTTPS requests, when used with NewHTTPTransport. It reads the certificate data from a file in PEM format.

func CACertOption

func CACertOption(certData []byte) TransportOption

CACertOption specifies a CA certificate to be added to the trusted root CA list for HTTPS requests, when used with NewHTTPTransport.

func ConnectTimeoutOption

func ConnectTimeoutOption(timeout time.Duration) TransportOption

ConnectTimeoutOption specifies the maximum time to wait for a TCP connection, when used with NewHTTPTransport.

func ProxyOption

func ProxyOption(url url.URL) TransportOption

ProxyOption specifies a proxy URL to be used for all requests, when used with NewHTTPTransport. This overrides any setting of the HTTP_PROXY, HTTPS_PROXY, or NO_PROXY environment variables.