client

Documentation

Index

• Variables
• func ParseURL(url string, aliases map[string]string) (*url.URL, error)
• type AWSigner
  • func NewAWSigner(sgn *v4.Signer, region string) *AWSigner
  • func (s *AWSigner) Sign(r *http.Request, body io.ReadSeeker) error
• type Client
  • func NewClient(settings Settings, clientLogger *log.Logger, traceLogger *log.Logger) (*Client, error)
  • func (client *Client) BuildRequest(method string, u *url.URL, body []byte, header http.Header) (*http.Request, error)
  • func (client *Client) Send(req *http.Request) (*http.Response, error)
  • func (client *Client) Settings() Settings
• type DefaultSigner
  • func (s DefaultSigner) Sign(r *http.Request, body io.ReadSeeker) error
• type MIMEType
  • func (m MIMEType) String() string
• type RequestSigner
• type Settings
  • func NewSettings() Settings
  • func (s Settings) BuildHTTPClient() (*http.Client, error)
  • func (s Settings) WithNoFollowRedirects(b bool) Settings
  • func (s Settings) WithTLSOptions(opts TLSOptions) Settings
  • func (s Settings) WithTimeout(t time.Duration) Settings
• type TLSOptions
  • func NewTLSOptions() TLSOptions
  • func (tlsOptions TLSOptions) WithPKCS12Cert(pfx []byte, passw string) TLSOptions
  • func (tlsOptions TLSOptions) WithVersions(min, max uint16) TLSOptions
  • func (tlsOptions TLSOptions) WithX509Cert(certfile, keyfile string) TLSOptions
• type Tracer
  • func (t *Tracer) ConnectDone(network, addr string, err error)
  • func (t *Tracer) ConnectStart(network, addr string)
  • func (t *Tracer) DNSDone(info httptrace.DNSDoneInfo)
  • func (t *Tracer) DNSStart(info httptrace.DNSStartInfo)
  • func (t *Tracer) Report(total time.Duration)
  • func (t *Tracer) RoundTrip(req *http.Request) (*http.Response, error)
  • func (t *Tracer) TLSHandshakeDone(state tls.ConnectionState, err error)
  • func (t *Tracer) TLSHandshakeStart()

Variables

var (
	KnownHTTPHeaders map[string][]string
)

var (
	SupportedMethods = []string{
		http.MethodGet,
		http.MethodPost,
		http.MethodPut,
		http.MethodDelete,
		http.MethodHead,
		http.MethodOptions,
		http.MethodPatch,
	}
)

Functions

func ParseURL

func ParseURL(url string, aliases map[string]string) (*url.URL, error)

ParseURL parses the given URL

Types

type AWSigner

type AWSigner struct {
	// contains filtered or unexported fields
}

func NewAWSigner

func NewAWSigner(sgn *v4.Signer, region string) *AWSigner

func (*AWSigner) Sign

func (s *AWSigner) Sign(r *http.Request, body io.ReadSeeker) error

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(
	settings Settings,
	clientLogger *log.Logger,
	traceLogger *log.Logger,
) (*Client, error)

func (*Client) BuildRequest

func (client *Client) BuildRequest(method string, u *url.URL, body []byte, header http.Header) (*http.Request, error)

func (*Client) Send

func (client *Client) Send(req *http.Request) (*http.Response, error)

func (*Client) Settings

func (client *Client) Settings() Settings

type DefaultSigner

type DefaultSigner struct{}

func (DefaultSigner) Sign

func (s DefaultSigner) Sign(r *http.Request, body io.ReadSeeker) error

type MIMEType

type MIMEType string

const (
	MIMETypeHTML           MIMEType = "text/html"
	MIMETypeCSV            MIMEType = "text/csv"
	MIMETypeJSON           MIMEType = "application/json"
	MIMETypeXML            MIMEType = "application/xml"
	MIMETypeFormURLEncoded MIMEType = "application/x-www-form-urlencoded"
	MIMETypeUnknown        MIMEType = "unknown"
)

func (MIMEType) String

func (m MIMEType) String() string

type RequestSigner

type RequestSigner interface {
	Sign(r *http.Request, body io.ReadSeeker) error
}

RequestSigner is used to sign request using AWS sig v4.

type Settings

type Settings struct {
	Timeout         time.Duration
	TLS             TLSOptions
	FollowRedirects bool
}

func NewSettings

func NewSettings() Settings

func (Settings) BuildHTTPClient

func (s Settings) BuildHTTPClient() (*http.Client, error)

func (Settings) WithNoFollowRedirects

func (s Settings) WithNoFollowRedirects(b bool) Settings

func (Settings) WithTLSOptions

func (s Settings) WithTLSOptions(opts TLSOptions) Settings

func (Settings) WithTimeout

func (s Settings) WithTimeout(t time.Duration) Settings

type TLSOptions

type TLSOptions struct {
	Cert               types.Option[certificate]
	MinVersion         uint16
	MaxVersion         uint16
	SkipVerifyInsecure bool
}

func NewTLSOptions

func NewTLSOptions() TLSOptions

func (TLSOptions) WithPKCS12Cert

func (tlsOptions TLSOptions) WithPKCS12Cert(pfx []byte, passw string) TLSOptions

func (TLSOptions) WithVersions

func (tlsOptions TLSOptions) WithVersions(min, max uint16) TLSOptions

func (TLSOptions) WithX509Cert

func (tlsOptions TLSOptions) WithX509Cert(certfile, keyfile string) TLSOptions

type Tracer

type Tracer struct {
	// contains filtered or unexported fields
}

func (*Tracer) ConnectDone

func (t *Tracer) ConnectDone(network, addr string, err error)

func (*Tracer) ConnectStart

func (t *Tracer) ConnectStart(network, addr string)

func (*Tracer) DNSDone

func (t *Tracer) DNSDone(info httptrace.DNSDoneInfo)

func (*Tracer) DNSStart

func (t *Tracer) DNSStart(info httptrace.DNSStartInfo)

func (*Tracer) Report

func (t *Tracer) Report(total time.Duration)

func (*Tracer) RoundTrip

func (t *Tracer) RoundTrip(req *http.Request) (*http.Response, error)

func (*Tracer) TLSHandshakeDone

func (t *Tracer) TLSHandshakeDone(state tls.ConnectionState, err error)

func (*Tracer) TLSHandshakeStart

func (t *Tracer) TLSHandshakeStart()