requests

Documentation

Index

• Variables
• func InitH2CClient(rwTimeout time.Duration, connectTimeout ...time.Duration)
• func InitHTTPClient(rwTimeout time.Duration, connectTimeout ...time.Duration)
• func InstallMiddleware(handle ...Handler)
• func SetH2CClient(client Client)
• func SetHTTPClient(client Client)
• type Client
• type ClientImpl
  • func NewH2CClient(rwTimeout time.Duration, connectTimeout time.Duration) *ClientImpl
  • func NewHTTPClient(rwTimeout time.Duration, connectTimeout time.Duration) *ClientImpl
  • func (client *ClientImpl) Do(req *http.Request) (*http.Response, error)
• type HTTPTraceInfo
• type Handler
• type Middleware
• type Request
  • func NewH2CRequest(rawurl string) Request
  • func NewHTTPRequest(rawurl string) Request
• type Response
  • func (res *Response) Clone() *Response
  • func (res *Response) Cookie(name string) *http.Cookie
  • func (res *Response) Cookies() []*http.Cookie
  • func (res *Response) ProtoAtLeast(major, minor int) bool
  • func (res *Response) TraceInfo() HTTPTraceInfo

Variables

var ErrDefaultMiddleware = errors.New("middleware stop")

ErrDefaultMiddleware The middleware stops and the request returns the default error.

var Marshal func(v interface{}) ([]byte, error)

Marshal Serialization, the default official JSON processor.

var Unmarshal func(data []byte, v interface{}) error

Unmarshal Deserialization, default to the official JSON processor.

Functions

func InitH2CClient

func InitH2CClient(rwTimeout time.Duration, connectTimeout ...time.Duration)

InitH2CClient Initialize H2C client. The parameter rwTimeout is io timeout. The parameter connectTimeout is connect timeout.

func InitHTTPClient

func InitHTTPClient(rwTimeout time.Duration, connectTimeout ...time.Duration)

InitHTTPClient Initialize HTTP client. The parameter rwTimeout is io timeout. The parameter connectTimeout is connect timeout.

func InstallMiddleware

func InstallMiddleware(handle ...Handler)

InstallMiddleware Install the middleware processor.

func SetH2CClient

func SetH2CClient(client Client)

SetH2CClient Set up H2C client.

func SetHTTPClient

func SetHTTPClient(client Client)

SetHTTPClient Set up client.

Types

type Client

type Client interface {
	Do(req *http.Request) (*http.Response, error)
}

Client The client interface is defined.

type ClientImpl

type ClientImpl struct {
	*http.Client
}

ClientImpl The implementation of the client interface.

func NewH2CClient

func NewH2CClient(rwTimeout time.Duration, connectTimeout time.Duration) *ClientImpl

NewH2CClient . The parameter rwTimeout is io timeout. The parameter connectTimeout is connect timeout.

func NewHTTPClient

func NewHTTPClient(rwTimeout time.Duration, connectTimeout time.Duration) *ClientImpl

NewHTTPClient . The parameter rwTimeout is io timeout. The parameter connectTimeout is connect timeout.

func (*ClientImpl) Do

func (client *ClientImpl) Do(req *http.Request) (*http.Response, error)

Do Launch an http request.

type HTTPTraceInfo

type HTTPTraceInfo struct {
	DNSLookup    time.Duration
	ConnTime     time.Duration
	TCPConnTime  time.Duration
	TLSHandshake time.Duration

	ServerTime   time.Duration
	ResponseTime time.Duration
	TotalTime    time.Duration

	IsConnReused bool

	IsConnWasIdle bool
	ConnIdleTime  time.Duration
}

HTTPTraceInfo Link information for the connection.

type Handler

type Handler func(Middleware)

Handler The definition of the middleware processor.

type Middleware

type Middleware interface {
	//Go on.
	Next()
	Stop(...error)
	// Returns the standard request object.
	GetRequest() *http.Request
	// Returns carry information for HTTP requests.
	GetRespone() *Response
	// Returns http package data.
	GetResponeBody() []byte
	IsStopped() bool
	// Is HTTP/2 Cleartext Request.
	IsH2C() bool
	Context() context.Context
	WithContextFromMiddleware(context.Context)
	// Turn on link tracking for HTTP connections.
	EnableTraceFromMiddleware()
	// Set up client.
	SetClientFromMiddleware(Client)
}

Middleware The interface definition of the middleware.

type Request

type Request interface {
	// HTTP POST method.
	Post() Request
	// HTTP PUT method.
	Put() Request
	// HTTP GET method.
	Get() Request
	// HTTP DELETE method.
	Delete() Request
	// HTTP HEAD method.
	Head() Request
	// HTTP OPTIONS method.
	Options() Request
	// Set up JSON data.
	SetJSONBody(obj interface{}) Request
	// Set the original data.
	SetBody(byts []byte) Request
	// Set up Form data.
	SetFormBody(url.Values) Request
	// Set up File data.
	SetFile(field, file string) Request
	// The data is returned after the request and converted to JSON data.
	ToJSON(obj interface{}) *Response
	// The data is returned after the request and converted into a string.
	ToString() (string, *Response)
	// The data is returned after the request and converted into a []byte.
	ToBytes() ([]byte, *Response)
	// The data is returned after the request and converted to XML data.
	ToXML(v interface{}) *Response
	// Set the request parameters.
	SetQueryParam(key string, value interface{}) Request
	// Set the request parameters.
	SetQueryParams(map[string]interface{}) Request
	URL() string
	Context() context.Context
	WithContext(context.Context) Request
	// idempotent request processing, need to fill in KEY.
	Singleflight(key ...interface{}) Request
	// Set up HTTP Header information.
	SetHeader(header http.Header) Request
	// Add HTTP Header information.
	AddHeader(key, value string) Request
	// Returns the header of the current request.
	Header() http.Header
	// Returns the Request of the standard library.
	GetStdRequest() *http.Request
	// Add cookie information.
	AddCookie(*http.Cookie) Request
	// Turn on link tracking.
	EnableTrace() Request
	// Set up client.
	SetClient(client Client) Request
}

Request The interface definition of the HTTP request package.

func NewH2CRequest

func NewH2CRequest(rawurl string) Request

NewH2CRequest Create an HTTP H2C request object. The URL of the incoming HTTP.

func NewHTTPRequest

func NewHTTPRequest(rawurl string) Request

NewHTTPRequest Create an HTTP request object. The URL of the incoming HTTP.

type Response

type Response struct {
	Error         error
	HTTP11        bool
	ContentType   string
	Status        string // e.g. "200 OK"
	StatusCode    int    // e.g. 200
	Proto         string // e.g. "HTTP/1.0"
	ProtoMajor    int    // e.g. 1
	ProtoMinor    int    // e.g. 0
	Header        http.Header
	ContentLength int64
	Uncompressed  bool
	// contains filtered or unexported fields
}

Response is a return carry information for HTTP requests.

func (*Response) Clone

func (res *Response) Clone() *Response

Clone Copy a new one.

func (*Response) Cookie

func (res *Response) Cookie(name string) *http.Cookie

Cookie returns cookie's value by its name returns empty string if nothing was found.

func (*Response) Cookies

func (res *Response) Cookies() []*http.Cookie

Cookies parses and returns the cookies set in the Set-Cookie headers.

func (*Response) ProtoAtLeast

func (res *Response) ProtoAtLeast(major, minor int) bool

ProtoAtLeast reports whether the HTTP protocol used in the response is at least major.minor.

func (*Response) TraceInfo

func (res *Response) TraceInfo() HTTPTraceInfo

TraceInfo Link information for the connection.