restc

Documentation

Index

• Constants
• func DefaultPooledTransport() *http.Transport
• func DefaultTransport() *http.Transport
• type Client
  • func New(cfg *Config, middlewares map[string]service.Middleware) Client
• type Config
  • func DefaultCfg() *Config
  • func (t *Config) Build(mm map[string]service.Middleware) (r result.Result[Client])
• type Request
  • func (r *Request) Client() bool
  • func (r *Request) ContentType() string
  • func (r *Request) Endpoint() string
  • func (r *Request) Header() *service.RequestHeader
  • func (r *Request) Kind() string
  • func (r *Request) Operation() string
  • func (r *Request) Payload() interface{}
  • func (r *Request) Service() string
  • func (r *Request) Stream() bool
• type Response
  • func (r *Response) Header() *service.ResponseHeader
  • func (r *Response) Payload() interface{}
  • func (r *Response) Stream() bool
• type TraceInfo

Constants

const Name = "restc"

Functions

func DefaultPooledTransport

func DefaultPooledTransport() *http.Transport

DefaultPooledTransport returns a new http.Transport with similar default values to http.DefaultTransport. Do not use this for transient transports as it can leak file descriptors over time. Only use this for transports that will be re-used for the same host(s).

func DefaultTransport

func DefaultTransport() *http.Transport

DefaultTransport returns a new http.Transport with similar default values to http.DefaultTransport, but with idle connections and keepalives disabled.

Types

type Client

type Client interface {
	Do(ctx context.Context, req *fasthttp.Request) result.Result[*fasthttp.Response]
	Head(ctx context.Context, url string, opts ...func(req *fasthttp.Request)) result.Result[*fasthttp.Response]
	Get(ctx context.Context, url string, opts ...func(req *fasthttp.Request)) result.Result[*fasthttp.Response]
	Delete(ctx context.Context, url string, opts ...func(req *fasthttp.Request)) result.Result[*fasthttp.Response]
	Post(ctx context.Context, url string, data interface{}, opts ...func(req *fasthttp.Request)) result.Result[*fasthttp.Response]
	PostForm(ctx context.Context, url string, val url.Values, opts ...func(req *fasthttp.Request)) result.Result[*fasthttp.Response]
	Put(ctx context.Context, url string, data interface{}, opts ...func(req *fasthttp.Request)) result.Result[*fasthttp.Response]
	Patch(ctx context.Context, url string, data interface{}, opts ...func(req *fasthttp.Request)) result.Result[*fasthttp.Response]
}

Client http client interface

func New

func New(cfg *Config, middlewares map[string]service.Middleware) Client

type Config

type Config struct {
	Trace       bool              `yaml:"trace"`
	Token       string            `yaml:"token"`
	Timeout     time.Duration     `yaml:"timeout"`
	RetryCount  uint32            `yaml:"retry-count"`
	Proxy       bool              `yaml:"proxy"`
	Socks5      string            `yaml:"socks5"`
	Insecure    bool              `yaml:"insecure"`
	Header      map[string]string `yaml:"header"`
	Middlewares []string          `yaml:"middlewares"`
	BasePath    string            `yaml:"base-path"`
	// contains filtered or unexported fields
}

func DefaultCfg

func DefaultCfg() *Config

func (*Config) Build

func (t *Config) Build(mm map[string]service.Middleware) (r result.Result[Client])

type Request

type Request struct {
	// contains filtered or unexported fields
}

func (*Request) Client

func (r *Request) Client() bool

func (*Request) ContentType

func (r *Request) ContentType() string

func (*Request) Endpoint

func (r *Request) Endpoint() string

func (*Request) Header

func (r *Request) Header() *service.RequestHeader

func (*Request) Kind

func (r *Request) Kind() string

func (*Request) Operation

func (r *Request) Operation() string

func (*Request) Payload

func (r *Request) Payload() interface{}

func (*Request) Service

func (r *Request) Service() string

func (*Request) Stream

func (r *Request) Stream() bool

type Response

type Response struct {
	// contains filtered or unexported fields
}

func (*Response) Header

func (r *Response) Header() *service.ResponseHeader

func (*Response) Payload

func (r *Response) Payload() interface{}

func (*Response) Stream

func (r *Response) Stream() bool

type TraceInfo

type TraceInfo struct {
	// DNSLookup is a duration that transport took to perform
	// DNS lookup.
	DNSLookup time.Duration

	// ConnTime is a duration that took to obtain a successful connection.
	ConnTime time.Duration

	// TCPConnTime is a duration that took to obtain the TCP connection.
	TCPConnTime time.Duration

	// TLSHandshake is a duration that TLS handshake took place.
	TLSHandshake time.Duration

	// ServerTime is a duration that server took to respond first byte.
	ServerTime time.Duration

	// ResponseTime is a duration since first Response byte from server to
	// request completion.
	ResponseTime time.Duration

	// TotalTime is a duration that total request took end-to-end.
	TotalTime time.Duration

	// IsConnReused is whether this connection has been previously
	// used for another HTTP request.
	IsConnReused bool

	// IsConnWasIdle is whether this connection was obtained from an
	// idle pool.
	IsConnWasIdle bool

	// ConnIdleTime is a duration how long the connection was previously
	// idle, if IsConnWasIdle is true.
	ConnIdleTime time.Duration

	// RequestAttempt is to represent the request attempt made during a Resty
	// request execution flow, including retry count.
	RequestAttempt uint32

	// RemoteAddr returns the remote network address.
	RemoteAddr net.Addr
}

TraceInfo struct is used provide request trace info such as DNS lookup duration, Connection obtain duration, Server processing duration, etc.

Since v2.0.0