http

Documentation

Index

• Variables
• func NewClient(opts ...ClientOption) (*http.Client, error)
• func NewRoundTripper(opts ...ClientOption) (http.RoundTripper, error)
• func ServerHandlers() []negroni.Handler
• type ClientOption
  • func WithClientBreaker() ClientOption
  • func WithClientLogger(logger *zap.Logger) ClientOption
  • func WithClientMetrics(meter metric.Meter) ClientOption
  • func WithClientRetry(cfg *retry.Config) ClientOption
  • func WithClientRoundTripper(rt http.RoundTripper) ClientOption
  • func WithClientTracer(tracer htracer.Tracer) ClientOption
  • func WithClientUserAgent(userAgent string) ClientOption
• type Config
• type Server
  • func NewServer(params ServerParams) (*Server, error)
  • func (s *Server) Start() error
  • func (s *Server) Stop(ctx context.Context) error
• type ServerParams

Variables

var ErrInvalidPort = errors.New("invalid port")

ErrInvalidPort for HTTP.

Functions

func NewClient

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

NewClient for HTTP.

func NewRoundTripper

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

NewRoundTripper for HTTP.

func ServerHandlers

func ServerHandlers() []negroni.Handler

ServerHandlers 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 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 *retry.Config) ClientOption

WithClientRetry for HTTP.

func WithClientRoundTripper

func WithClientRoundTripper(rt http.RoundTripper) ClientOption

WithClientRoundTripper for HTTP.

func WithClientTracer

func WithClientTracer(tracer htracer.Tracer) ClientOption

WithClientTracer for HTTP.

func WithClientUserAgent

func WithClientUserAgent(userAgent string) ClientOption

WithUserAgent for HTTP.

type Config

type Config struct {
	Security  security.Config `yaml:"security" json:"security" toml:"security"`
	Port      string          `yaml:"port" json:"port" toml:"port"`
	Retry     retry.Config    `yaml:"retry" json:"retry" toml:"retry"`
	UserAgent string          `yaml:"user_agent" json:"user_agent" toml:"user_agent"`
}

Config for HTTP.

type Server

type Server struct {
	Mux *runtime.ServeMux
	// contains filtered or unexported fields
}

Server for HTTP.

func NewServer

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

NewServer for HTTP.

func (*Server) Start

func (s *Server) Start() error

Start the server.

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) error

Stop the server.

type ServerParams

type ServerParams struct {
	fx.In

	Shutdowner fx.Shutdowner
	Config     *Config
	Logger     *zap.Logger
	Tracer     tracer.Tracer
	Meter      metric.Meter
	Handlers   []negroni.Handler
}

ServerParams for HTTP.