httpclient

Documentation

Index

• Constants
• Variables
• func IsRedirectError(err error) bool
• func IsTimeoutError(err error) bool
• func Option(o map[string]interface{}) map[int]interface{}
• type Error
  • func (this Error) Error() string
• type HttpClient
  • func NewHttpClient() *HttpClient
  • func (this *HttpClient) Begin() *HttpClient
  • func (this *HttpClient) Connect(url string, params ...map[string]string) (*Response, error)
  • func (this *HttpClient) CookieValue(url_ string, key string) string
  • func (this *HttpClient) CookieValues(url_ string) map[string]string
  • func (this *HttpClient) Cookies(url_ string) []*http.Cookie
  • func (this *HttpClient) Defaults(defaults Map) *HttpClient
  • func (this *HttpClient) Delete(url string, params ...interface{}) (*Response, error)
  • func (this *HttpClient) Do(method string, url string, headers map[string]string, body io.Reader) (*Response, error)
  • func (this *HttpClient) Get(url string, params ...interface{}) (*Response, error)
  • func (this *HttpClient) Head(url string) (*Response, error)
  • func (this *HttpClient) Options(url string, params ...map[string]string) (*Response, error)
  • func (this *HttpClient) Patch(url string, params ...map[string]string) (*Response, error)
  • func (this *HttpClient) PatchJson(url string, data interface{}) (*Response, error)
  • func (this *HttpClient) Post(url string, params interface{}) (*Response, error)
  • func (this *HttpClient) PostJson(url string, data interface{}) (*Response, error)
  • func (this *HttpClient) PostMultipart(url string, params interface{}) (*Response, error)
  • func (this *HttpClient) Put(url string, body io.Reader) (*Response, error)
  • func (this *HttpClient) PutJson(url string, data interface{}) (*Response, error)
  • func (this *HttpClient) Trace(url string, params ...map[string]string) (*Response, error)
  • func (this *HttpClient) WithCookie(cookies ...*http.Cookie) *HttpClient
  • func (this *HttpClient) WithHeader(k string, v string) *HttpClient
  • func (this *HttpClient) WithHeaders(m map[string]string) *HttpClient
  • func (this *HttpClient) WithOption(k int, v interface{}) *HttpClient
  • func (this *HttpClient) WithOptions(m Map) *HttpClient
• type Map
• type Response
  • func (this *Response) ReadAll() ([]byte, error)
  • func (this *Response) ToString() (string, error)

Constants

const (
	VERSION   = "0.6.2"
	USERAGENT = "go-httpclient v" + VERSION

	PROXY_HTTP    = 0
	PROXY_SOCKS4  = 4
	PROXY_SOCKS5  = 5
	PROXY_SOCKS4A = 6

	// CURL like OPT
	OPT_AUTOREFERER       = 58
	OPT_FOLLOWLOCATION    = 52
	OPT_CONNECTTIMEOUT    = 78
	OPT_CONNECTTIMEOUT_MS = 156
	OPT_MAXREDIRS         = 68
	OPT_PROXYTYPE         = 101
	OPT_TIMEOUT           = 13
	OPT_TIMEOUT_MS        = 155
	OPT_COOKIEJAR         = 10082
	OPT_INTERFACE         = 10062
	OPT_PROXY             = 10004
	OPT_REFERER           = 10016
	OPT_USERAGENT         = 10018

	// Other OPT
	OPT_REDIRECT_POLICY = 100000
	OPT_PROXY_FUNC      = 100001
	OPT_DEBUG           = 100002
	OPT_UNSAFE_TLS      = 100004
)

Constants definations CURL options, see https://github.com/bagder/curl/blob/169fedbdce93ecf14befb6e0e1ce6a2d480252a3/packages/OS400/curl.inc.in

const (
	ERR_DEFAULT
	ERR_TIMEOUT
	ERR_REDIRECT_POLICY
)

Package errors

Variables

var CONST = map[string]int{
	"OPT_AUTOREFERER":       58,
	"OPT_FOLLOWLOCATION":    52,
	"OPT_CONNECTTIMEOUT":    78,
	"OPT_CONNECTTIMEOUT_MS": 156,
	"OPT_MAXREDIRS":         68,
	"OPT_PROXYTYPE":         101,
	"OPT_TIMEOUT":           13,
	"OPT_TIMEOUT_MS":        155,
	"OPT_COOKIEJAR":         10082,
	"OPT_INTERFACE":         10062,
	"OPT_PROXY":             10004,
	"OPT_REFERER":           10016,
	"OPT_USERAGENT":         10018,

	"OPT_REDIRECT_POLICY": 100000,
	"OPT_PROXY_FUNC":      100001,
	"OPT_DEBUG":           100002,
	"OPT_UNSAFE_TLS":      100004,
}

String map of options

Functions

func IsRedirectError

func IsRedirectError(err error) bool

Check a redirect error

func IsTimeoutError

func IsTimeoutError(err error) bool

Check a timeout error.

func Option

func Option(o map[string]interface{}) map[int]interface{}

Convert options with string keys to desired format.

Types

type Error

type Error struct {
	Code    int
	Message string
}

Custom error

func (Error) Error

func (this Error) Error() string

Implement the error interface

type HttpClient

type HttpClient struct {

	// Default headers of this client.
	Headers map[string]string
	// contains filtered or unexported fields
}

Powerful and easy to use HTTP client.

func NewHttpClient

func NewHttpClient() *HttpClient

Create an HTTP client.

func (*HttpClient) Begin

func (this *HttpClient) Begin() *HttpClient

Begin marks the begining of a request, it's necessary for concurrent requests.

func (*HttpClient) Connect

func (this *HttpClient) Connect(url string, params ...map[string]string) (*Response, error)

The CONNECT request

func (*HttpClient) CookieValue

func (this *HttpClient) CookieValue(url_ string, key string) string

Get cookie value of a specified cookie name.

func (*HttpClient) CookieValues

func (this *HttpClient) CookieValues(url_ string) map[string]string

Get cookie values(k-v map) of the client jar.

func (*HttpClient) Cookies

func (this *HttpClient) Cookies(url_ string) []*http.Cookie

Get cookies of the client jar.

func (*HttpClient) Defaults

func (this *HttpClient) Defaults(defaults Map) *HttpClient

Set default options and headers.

func (*HttpClient) Delete

func (this *HttpClient) Delete(url string, params ...interface{}) (*Response, error)

The DELETE request

func (*HttpClient) Do

func (this *HttpClient) Do(method string, url string, headers map[string]string,
	body io.Reader) (*Response, error)

Start a request, and get the response.

Usually we just need the Get and Post method.

func (*HttpClient) Get

func (this *HttpClient) Get(url string, params ...interface{}) (*Response, error)

The GET request

func (*HttpClient) Head

func (this *HttpClient) Head(url string) (*Response, error)

The HEAD request

func (*HttpClient) Options

func (this *HttpClient) Options(url string, params ...map[string]string) (*Response, error)

The OPTIONS request

func (*HttpClient) Patch

func (this *HttpClient) Patch(url string, params ...map[string]string) (*Response, error)

The PATCH request

func (*HttpClient) PatchJson

func (this *HttpClient) PatchJson(url string, data interface{}) (*Response, error)

Patch json data

func (*HttpClient) Post

func (this *HttpClient) Post(url string, params interface{}) (*Response,
	error)

The POST request

With multipart set to true, the request will be encoded as "multipart/form-data".

If any of the params key starts with "@", it is considered as a form file (similar to CURL but different).

func (*HttpClient) PostJson

func (this *HttpClient) PostJson(url string, data interface{}) (*Response, error)

func (*HttpClient) PostMultipart

func (this *HttpClient) PostMultipart(url string, params interface{}) (
	*Response, error)

Post with the request encoded as "multipart/form-data".

func (*HttpClient) Put

func (this *HttpClient) Put(url string, body io.Reader) (*Response, error)

The PUT request

func (*HttpClient) PutJson

func (this *HttpClient) PutJson(url string, data interface{}) (*Response, error)

Put json data

func (*HttpClient) Trace

func (this *HttpClient) Trace(url string, params ...map[string]string) (*Response, error)

The TRACE request

func (*HttpClient) WithCookie

func (this *HttpClient) WithCookie(cookies ...*http.Cookie) *HttpClient

Specify cookies of the current request.

func (*HttpClient) WithHeader

func (this *HttpClient) WithHeader(k string, v string) *HttpClient

Temporarily specify a header of the current request.

func (*HttpClient) WithHeaders

func (this *HttpClient) WithHeaders(m map[string]string) *HttpClient

Temporarily specify multiple headers of the current request.

func (*HttpClient) WithOption

func (this *HttpClient) WithOption(k int, v interface{}) *HttpClient

Temporarily specify an option of the current request.

func (*HttpClient) WithOptions

func (this *HttpClient) WithOptions(m Map) *HttpClient

Temporarily specify multiple options of the current request.

type Map

type Map map[interface{}]interface{}

Map is a mixed structure with options and headers

type Response

type Response struct {
	*http.Response
}

Thin wrapper of http.Response(can also be used as http.Response).

func (*Response) ReadAll

func (this *Response) ReadAll() ([]byte, error)

Read response body into a byte slice.

func (*Response) ToString

func (this *Response) ToString() (string, error)

Read response body into string.