Documentation
¶
Index ¶
- Variables
- func AutomaticContentLength(enable bool)
- func AutomaticHostHeader(enable bool)
- func Do(req *http.Request) (*http.Response, error)
- func DoRaw(method, url, uripath string, headers map[string][]string, body io.Reader) (*http.Response, error)
- func DoRawWithOptions(method, url, uripath string, headers map[string][]string, body io.Reader, ...) (*http.Response, error)
- func Dor(req *retryablehttp.Request) (*http.Response, error)
- func DumpRequestRaw(method, url, uripath string, headers map[string][]string, body io.Reader, ...) ([]byte, error)
- func Get(url string) (*http.Response, error)
- func Post(url string, mimetype string, r io.Reader) (*http.Response, error)
- func TlsHandshake(conn net.Conn, addr string, timeout time.Duration) (net.Conn, error)
- type Client
- func (c *Client) Do(req *http.Request) (*http.Response, error)
- func (c *Client) DoRaw(method, url, uripath string, headers map[string][]string, body io.Reader) (*http.Response, error)
- func (c *Client) DoRawWithOptions(method, url, uripath string, headers map[string][]string, body io.Reader, ...) (*http.Response, error)
- func (c *Client) Dor(req *retryablehttp.Request) (*http.Response, error)
- func (c *Client) Get(url string) (*http.Response, error)
- func (c *Client) Head(url string) (*http.Response, error)
- func (c *Client) Post(url string, mimetype string, body io.Reader) (*http.Response, error)
- type Conn
- type Dialer
- type Options
- type PipelineClient
- func (c *PipelineClient) Do(req *http.Request) (*http.Response, error)
- func (c *PipelineClient) DoRaw(method, url, uripath string, headers map[string][]string, body io.Reader) (*http.Response, error)
- func (c *PipelineClient) DoRawWithOptions(method, url, uripath string, headers map[string][]string, body io.Reader, ...) (*http.Response, error)
- func (c *PipelineClient) Dor(req *retryablehttp.Request) (*http.Response, error)
- func (c *PipelineClient) Get(url string) (*http.Response, error)
- func (c *PipelineClient) Head(url string) (*http.Response, error)
- func (c *PipelineClient) Post(url string, mimetype string, body io.Reader) (*http.Response, error)
- type PipelineOptions
- type RedirectStatus
- type StatusError
Constants ¶
This section is empty.
Variables ¶
var DefaultClient = Client{ Options: DefaultOptions, // contains filtered or unexported fields }
DefaultClient is the default HTTP client for doing raw requests
var DefaultOptions = &Options{ Timeout: 30 * time.Second, FollowRedirects: true, MaxRedirects: 10, AutomaticHostHeader: true, AutomaticContentLength: true, }
DefaultOptions is the default configuration options for the client
var DefaultPipelineOptions = PipelineOptions{ Timeout: 30 * time.Second, MaxConnections: 5, MaxPendingRequests: 100, AutomaticHostHeader: true, }
DefaultPipelineOptions is the default options for pipelined http client
Functions ¶
func AutomaticContentLength ¶
func AutomaticContentLength(enable bool)
AutomaticContentLength performs automatic calculation of request content length.
func AutomaticHostHeader ¶
func AutomaticHostHeader(enable bool)
AutomaticHostHeader sets Host header for requests automatically
func DoRaw ¶
func DoRaw(method, url, uripath string, headers map[string][]string, body io.Reader) (*http.Response, error)
DoRaw does a raw request with some configuration
func DoRawWithOptions ¶ added in v0.0.8
func DoRawWithOptions(method, url, uripath string, headers map[string][]string, body io.Reader, options *Options) (*http.Response, error)
DoRawWithOptions does a raw request with some configuration
func Dor ¶
func Dor(req *retryablehttp.Request) (*http.Response, error)
Dor sends a retryablehttp request and returns a response
func DumpRequestRaw ¶ added in v0.0.2
func DumpRequestRaw(method, url, uripath string, headers map[string][]string, body io.Reader, options *Options) ([]byte, error)
DumpRequestRaw to string
Types ¶
type Client ¶
type Client struct {
Options *Options
// contains filtered or unexported fields
}
Client is a client for making raw http requests with go
func (*Client) DoRaw ¶
func (c *Client) DoRaw(method, url, uripath string, headers map[string][]string, body io.Reader) (*http.Response, error)
DoRaw does a raw request with some configuration
func (*Client) DoRawWithOptions ¶ added in v0.0.2
func (c *Client) DoRawWithOptions(method, url, uripath string, headers map[string][]string, body io.Reader, options *Options) (*http.Response, error)
DoRawWithOptions performs a raw request with additional options
type Conn ¶
type Conn interface {
client.Client
io.Closer
SetDeadline(time.Time) error
SetReadDeadline(time.Time) error
SetWriteDeadline(time.Time) error
Release()
}
Conn is an interface implemented by a connection
type Dialer ¶
type Dialer interface {
// Dial dials a remote http server returning a Conn.
Dial(protocol, addr string, options *Options) (Conn, error)
DialWithProxy(protocol, addr, proxyURL string, timeout time.Duration, options *Options) (Conn, error)
// Dial dials a remote http server with timeout returning a Conn.
DialTimeout(protocol, addr string, timeout time.Duration, options *Options) (Conn, error)
}
Dialer can dial a remote HTTP server.
type Options ¶
type Options struct {
Timeout time.Duration
FollowRedirects bool
MaxRedirects int
AutomaticHostHeader bool
AutomaticContentLength bool
CustomHeaders client.Headers
ForceReadAllBody bool // ignores content length and reads all body
CustomRawBytes []byte
Proxy string
ProxyDialTimeout time.Duration
SNI string
FastDialer *fastdialer.Dialer
}
Options contains configuration options for rawhttp client
type PipelineClient ¶
type PipelineClient struct {
// contains filtered or unexported fields
}
PipelineClient is a client for making pipelined http requests
func NewPipelineClient ¶
func NewPipelineClient(options PipelineOptions) *PipelineClient
NewPipelineClient creates a new pipelined http request client
func (*PipelineClient) DoRaw ¶
func (c *PipelineClient) DoRaw(method, url, uripath string, headers map[string][]string, body io.Reader) (*http.Response, error)
DoRaw does a raw request with some configuration
func (*PipelineClient) DoRawWithOptions ¶ added in v0.0.2
func (c *PipelineClient) DoRawWithOptions(method, url, uripath string, headers map[string][]string, body io.Reader, options PipelineOptions) (*http.Response, error)
DoRawWithOptions performs a raw request with additional options
func (*PipelineClient) Dor ¶
func (c *PipelineClient) Dor(req *retryablehttp.Request) (*http.Response, error)
Dor sends a retryablehttp request and returns a response
func (*PipelineClient) Get ¶
func (c *PipelineClient) Get(url string) (*http.Response, error)
Get makes a GET request to a given URL
type PipelineOptions ¶
type PipelineOptions struct {
Dialer clientpipeline.DialFunc
Host string
Timeout time.Duration
MaxConnections int
MaxPendingRequests int
AutomaticHostHeader bool
}
PipelineOptions contains options for pipelined http client
type RedirectStatus ¶
RedirectStatus is the current redirect status for the request
type StatusError ¶
StatusError is a HTTP status error object
func (*StatusError) Error ¶
func (s *StatusError) Error() string