http

Documentation

Index

• Variables
• func IsEnabled(cfg *Config) bool
• func NewClient(opts ...ClientOption) *http.Client
• func NewRoundTripper(opts ...ClientOption) http.RoundTripper
• func RegisterMetrics(cfg *metrics.Config, mux *http.ServeMux)
• func Transport() *http.Transport
• type ClientOption
  • func WithClientBreaker() ClientOption
  • func WithClientCompression() ClientOption
  • func WithClientLogger(logger *zap.Logger) ClientOption
  • func WithClientMetrics(meter metric.Meter) ClientOption
  • func WithClientRetry(cfg *r.Config) ClientOption
  • func WithClientRoundTripper(rt http.RoundTripper) ClientOption
  • func WithClientTLS(sec *st.Config) (ClientOption, error)
  • func WithClientTimeout(timeout string) ClientOption
  • func WithClientTokenGenerator(gen token.Generator) ClientOption
  • func WithClientTracer(tracer trace.Tracer) ClientOption
  • func WithClientUserAgent(userAgent env.UserAgent) ClientOption
• type Config
• type Server
  • func NewServer(params ServerParams) (*Server, error)
• type ServerParams

Variables

var Module = fx.Options(
	fx.Provide(http.NewServeMux),
	fx.Invoke(nh.Register),
	fx.Provide(NewServer),
	fx.Invoke(RegisterMetrics),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for HTTP.

func NewClient

func NewClient(opts ...ClientOption) *http.Client

NewClient for HTTP.

func NewRoundTripper

func NewRoundTripper(opts ...ClientOption) http.RoundTripper

NewRoundTripper for HTTP.

func RegisterMetrics

func RegisterMetrics(cfg *metrics.Config, mux *http.ServeMux)

RegisterMetrics for HTTP.

func Transport

func Transport() *http.Transport

Transport for HTTP.

Types

type ClientOption

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption for HTTP.

func WithClientBreaker

func WithClientBreaker() ClientOption

WithClientBreaker for HTTP.

func WithClientCompression

func WithClientCompression() ClientOption

WithClientBreaker for HTTP.

func WithClientLogger

func WithClientLogger(logger *zap.Logger) ClientOption

WithClientLogger for HTTP.

func WithClientMetrics

func WithClientMetrics(meter metric.Meter) ClientOption

WithClientMetrics for HTTP.

func WithClientRetry

func WithClientRetry(cfg *r.Config) ClientOption

WithClientRetry for HTTP.

func WithClientRoundTripper

func WithClientRoundTripper(rt http.RoundTripper) ClientOption

WithClientRoundTripper for HTTP.

func WithClientTLS

func WithClientTLS(sec *st.Config) (ClientOption, error)

WithClientTLS for HTTP.

func WithClientTimeout

func WithClientTimeout(timeout string) ClientOption

WithClientTimeout for HTTP.

func WithClientTokenGenerator

func WithClientTokenGenerator(gen token.Generator) ClientOption

WithClientTokenGenerator for HTTP.

func WithClientTracer

func WithClientTracer(tracer trace.Tracer) ClientOption

WithClientTracer for HTTP.

func WithClientUserAgent

func WithClientUserAgent(userAgent env.UserAgent) ClientOption

WithUserAgent for HTTP.

type Config

type Config struct {
	*server.Config `yaml:",inline" json:",inline" toml:",inline"`
}

Config for HTTP.

type Server

type Server struct {
	*server.Server
}

Server for HTTP.

func NewServer

func NewServer(params ServerParams) (*Server, error)

NewServer for HTTP.

type ServerParams

type ServerParams struct {
	fx.In

	Shutdowner fx.Shutdowner
	Mux        *http.ServeMux
	Config     *Config
	Logger     *zap.Logger
	Tracer     trace.Tracer
	Meter      metric.Meter
	UserAgent  env.UserAgent
	Version    env.Version
	Limiter    limiter.Store     `optional:"true"`
	Key        lm.KeyFunc        `optional:"true"`
	Verifier   token.Verifier    `optional:"true"`
	Handlers   []negroni.Handler `optional:"true"`
}

ServerParams for HTTP.