http

Documentation

Index

• func GetIPFromRequest(r *http.Request) (net.IP, error)
• type Client
  • func NewClient(options ...ClientOption) (*Client, error)
  • func (o *Client) ApplyOptions(options ...ClientOption) *Client
  • func (c *Client) Get(url string) ([]byte, error)
  • func (c *Client) Post(url, contentType string, headers map[string]string, body []byte) ([]byte, error)
  • func (c *Client) PostJson(url string, headers map[string]string, body []byte) ([]byte, error)
  • func (c *Client) PostJsonWithAuthorize(url string, headers map[string]string, auth func(r *http.Request) error, ...) ([]byte, error)
  • func (c *Client) PostReader(url, contentType string, headers map[string]string, ...) ([]byte, error)
• type ClientOption
  • func WithDisableKeepAlives(disableKeepAlives bool) ClientOption
  • func WithIdleConnTimeout(idleConnTimeout time.Duration) ClientOption
  • func WithLogger(l *log.Logger) ClientOption
  • func WithMaxIdleConns(maxIdleConns int) ClientOption
  • func WithResonseHeaderTimeout(responseHeaderTimeout time.Duration) ClientOption
  • func WithTimeout(timeout time.Duration) ClientOption
• type ClientOptionFunc
• type EmptyClientOption

Functions

func GetIPFromRequest

func GetIPFromRequest(r *http.Request) (net.IP, error)

returns IP address from request. It will lookup IP in X-Forwarded-For and X-Real-IP headers.

Types

type Client

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

func NewClient

func NewClient(options ...ClientOption) (*Client, error)

func (*Client) ApplyOptions

func (o *Client) ApplyOptions(options ...ClientOption) *Client

func (*Client) Get

func (c *Client) Get(url string) ([]byte, error)

func (*Client) Post

func (c *Client) Post(
	url, contentType string,
	headers map[string]string,
	body []byte,
) ([]byte, error)

func (*Client) PostJson

func (c *Client) PostJson(
	url string,
	headers map[string]string,
	body []byte,
) ([]byte, error)

func (*Client) PostJsonWithAuthorize

func (c *Client) PostJsonWithAuthorize(
	url string,
	headers map[string]string,
	auth func(r *http.Request) error,
	body []byte,
) ([]byte, error)

func (*Client) PostReader

func (c *Client) PostReader(
	url, contentType string,
	headers map[string]string,
	auth func(r *http.Request) error,
	body io.Reader,
) ([]byte, error)

type ClientOption

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

A ClientOption sets options.

func WithDisableKeepAlives

func WithDisableKeepAlives(disableKeepAlives bool) ClientOption

func WithIdleConnTimeout

func WithIdleConnTimeout(idleConnTimeout time.Duration) ClientOption

func WithLogger

func WithLogger(l *log.Logger) ClientOption

WithLogger

func WithMaxIdleConns

func WithMaxIdleConns(maxIdleConns int) ClientOption

func WithResonseHeaderTimeout

func WithResonseHeaderTimeout(responseHeaderTimeout time.Duration) ClientOption

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption

type ClientOptionFunc

type ClientOptionFunc func(*Client)

ClientOptionFunc wraps a function that modifies Client into an implementation of the ClientOption interface.

type EmptyClientOption

type EmptyClientOption struct{}

EmptyClientOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.