client

package

v0.3.0 Latest Latest Go to latest Published: Aug 29, 2022 License: Apache-2.0 Imports: 10 Imported by: 25

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloudwego/hertz

Links

Documentation ¶

Index ¶

func DoDeadline(ctx context.Context, req *protocol.Request, resp *protocol.Response, ...) error
func DoRequestFollowRedirects(ctx context.Context, req *protocol.Request, resp *protocol.Response, ...) (statusCode int, body []byte, err error)
func DoTimeout(ctx context.Context, req *protocol.Request, resp *protocol.Response, ...) error
func GetURL(ctx context.Context, dst []byte, url string, c Doer, ...) (statusCode int, body []byte, err error)
func GetURLDeadline(ctx context.Context, dst []byte, url string, deadline time.Time, c Doer, ...) (statusCode int, body []byte, err error)
func GetURLTimeout(ctx context.Context, dst []byte, url string, timeout time.Duration, c Doer, ...) (statusCode int, body []byte, err error)
func PostURL(ctx context.Context, dst []byte, url string, postArgs *protocol.Args, c Doer, ...) (statusCode int, body []byte, err error)
func StatusCodeIsRedirect(statusCode int) bool
type Doer
type DynamicConfig
type HostClient
type HostClientConfig
type RetryIfFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DoDeadline ¶

func DoDeadline(ctx context.Context, req *protocol.Request, resp *protocol.Response, deadline time.Time, c Doer) error

func DoRequestFollowRedirects ¶

func DoRequestFollowRedirects(ctx context.Context, req *protocol.Request, resp *protocol.Response, url string, maxRedirectsCount int, c Doer) (statusCode int, body []byte, err error)

func DoTimeout ¶

func DoTimeout(ctx context.Context, req *protocol.Request, resp *protocol.Response, timeout time.Duration, c Doer) error

func GetURL ¶

func GetURL(ctx context.Context, dst []byte, url string, c Doer, requestOptions ...config.RequestOption) (statusCode int, body []byte, err error)

func GetURLDeadline ¶

func GetURLDeadline(ctx context.Context, dst []byte, url string, deadline time.Time, c Doer, requestOptions ...config.RequestOption) (statusCode int, body []byte, err error)

func GetURLTimeout ¶

func GetURLTimeout(ctx context.Context, dst []byte, url string, timeout time.Duration, c Doer, requestOptions ...config.RequestOption) (statusCode int, body []byte, err error)

func PostURL ¶

func PostURL(ctx context.Context, dst []byte, url string, postArgs *protocol.Args, c Doer, requestOptions ...config.RequestOption) (statusCode int, body []byte, err error)

func StatusCodeIsRedirect ¶

func StatusCodeIsRedirect(statusCode int) bool

StatusCodeIsRedirect returns true if the status code indicates a redirect.

Types ¶

type Doer ¶

type Doer interface {
	Do(ctx context.Context, req *protocol.Request, resp *protocol.Response) error
}

type DynamicConfig ¶ added in v0.2.0

type DynamicConfig struct {
	Addr     string
	ProxyURI *protocol.URI
	IsTLS    bool
}

DynamicConfig is config set which will be confirmed when starts a request.

type HostClient ¶

type HostClient interface {
	Doer
	SetDynamicConfig(dc *DynamicConfig)
	CloseIdleConnections()
	ShouldRemove() bool
	ConnectionCount() int
}

type HostClientConfig ¶

type HostClientConfig struct {
	DynamicConfig

	Name string

	NoDefaultUserAgentHeader      bool
	DialDualStack                 bool
	DisableHeaderNamesNormalizing bool
	DisablePathNormalizing        bool
	IsTLS                         bool

	TLSConfig *tls.Config

	MaxConns                  int
	MaxIdempotentCallAttempts int
	MaxResponseBodySize       int

	RetryIf            RetryIfFunc
	ResponseBodyStream bool

	DialTimeout         time.Duration
	MaxIdleConnDuration time.Duration
	MaxConnDuration     time.Duration
	ReadTimeout         time.Duration
	WriteTimeout        time.Duration
	MaxConnWaitTimeout  time.Duration
}

type RetryIfFunc ¶

type RetryIfFunc func(request *protocol.Request) bool

RetryIfFunc signature of retry if function

Request argument passed to RetryIfFunc, if there are any request errors.

Source Files ¶

View all Source files

client.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL