auresthttpclient

Documentation

Index

• func Instrument(client aurestclientapi.Client, ...)
• func New(timeout time.Duration, customCACert []byte, ...) (aurestclientapi.Client, error)
• type AuRestHttpClient
  • func NewHttpClient(timeout time.Duration, customCACert []byte, ...) (*AuRestHttpClient, error)
• type HttpClientImpl
  • func (c *HttpClientImpl) Perform(ctx context.Context, method string, requestUrl string, requestBody interface{}, ...) error
• type HttpClientRoundTripper
  • func (c *HttpClientRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

Functions

func Instrument

func Instrument(
	client aurestclientapi.Client,
	requestMetricsCallback aurestclientapi.MetricsCallbackFunction,
	responseMetricsCallback aurestclientapi.MetricsCallbackFunction,
)

Instrument adds instrumentation to a http client.

Either of the callbacks may be nil.

func New

func New(timeout time.Duration, customCACert []byte, requestManipulator aurestclientapi.RequestManipulatorCallback) (aurestclientapi.Client, error)

New builds a new http client.

Do not share between different logging/circuit breaker/retry stacks, but you should only build each stack once.

timeout MUST be set to 0 if you use a circuit breaker or anything else that may do a context cancel, or you'll get weird behavior.

If len(customCACert) is 0, the default CA certificates are used, but if you specify it, they are excluded to ensure only your certs are accepted.

Types

type AuRestHttpClient

type AuRestHttpClient struct {
	*http.Client

	// Now is exposed so tests can fixate the time by overwriting this field
	Now func() time.Time
}

func NewHttpClient

func NewHttpClient(timeout time.Duration, customCACert []byte,
	requestManipulator aurestclientapi.RequestManipulatorCallback, customHttpTransport *http.RoundTripper) (*AuRestHttpClient, error)

type HttpClientImpl

type HttpClientImpl struct {
	HttpClient         *http.Client
	RequestManipulator aurestclientapi.RequestManipulatorCallback
	Timeout            time.Duration

	RequestMetricsCallback  aurestclientapi.MetricsCallbackFunction
	ResponseMetricsCallback aurestclientapi.MetricsCallbackFunction

	// Now is exposed so tests can fixate the time by overwriting this field
	Now func() time.Time
}

func (*HttpClientImpl) Perform

func (c *HttpClientImpl) Perform(ctx context.Context, method string, requestUrl string, requestBody interface{}, response *aurestclientapi.ParsedResponse) error

type HttpClientRoundTripper

type HttpClientRoundTripper struct {
	RequestManipulator      aurestclientapi.RequestManipulatorCallback
	RequestMetricsCallback  aurestclientapi.MetricsCallbackFunction
	ResponseMetricsCallback aurestclientapi.MetricsCallbackFunction
	// contains filtered or unexported fields
}

func (*HttpClientRoundTripper) RoundTrip

func (c *HttpClientRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)