rhttp

Documentation

Index

• func GetHTTPClient(opts ...Option) *http.Client
• func InitServices(ctx context.Context, services map[string]config.ServicesConfig) (map[string]global.Service, error)
• func NewRequest(ctx context.Context, method, url string, body io.Reader) (*http.Request, error)
• type Config
  • func WithCertAndKeyFiles(cert, key string) Config
  • func WithLogger(log zerolog.Logger) Config
  • func WithMiddlewares(middlewares []global.Middleware) Config
  • func WithServices(services map[string]global.Service) Config
• type Option
  • func Context(val context.Context) Option
  • func DisableKeepAlive(disable bool) Option
  • func Insecure(insecure bool) Option
  • func Timeout(t time.Duration) Option
• type Options
• type Server
  • func New(c ...Config) (*Server, error)
  • func (s *Server) Address() string
  • func (s *Server) GracefulStop() error
  • func (s *Server) Network() string
  • func (s *Server) Start(ln net.Listener) error
  • func (s *Server) Stop() error

Functions

func GetHTTPClient

func GetHTTPClient(opts ...Option) *http.Client

GetHTTPClient returns an http client with open census tracing support. TODO(labkode): harden it. https://medium.com/@nate510/don-t-use-go-s-default-http-client-4804cb19f779

func InitServices

func InitServices(ctx context.Context, services map[string]config.ServicesConfig) (map[string]global.Service, error)

func NewRequest

func NewRequest(ctx context.Context, method, url string, body io.Reader) (*http.Request, error)

NewRequest creates an HTTP request that sets the token if it is passed in ctx.

Types

type Config

type Config func(*Server)

func WithCertAndKeyFiles

func WithCertAndKeyFiles(cert, key string) Config

func WithLogger

func WithLogger(log zerolog.Logger) Config

func WithMiddlewares

func WithMiddlewares(middlewares []global.Middleware) Config

func WithServices

func WithServices(services map[string]global.Service) Config

type Option

type Option func(o *Options)

Option defines a single option function.

func Context

func Context(val context.Context) Option

Context provides a function to set the context option.

func DisableKeepAlive

func DisableKeepAlive(disable bool) Option

DisableKeepAlive provides a function to set the disablee keep alive option.

func Insecure

func Insecure(insecure bool) Option

Insecure provides a function to set the insecure option.

func Timeout

func Timeout(t time.Duration) Option

Timeout provides a function to set the timeout option.

type Options

type Options struct {
	Context          context.Context
	Timeout          time.Duration
	Insecure         bool
	DisableKeepAlive bool
}

Options defines the available options for this package.

type Server

type Server struct {
	Services map[string]global.Service // map key is service name
	CertFile string
	KeyFile  string
	// contains filtered or unexported fields
}

Server contains the server info.

func New

func New(c ...Config) (*Server, error)

New returns a new server.

func (*Server) Address

func (s *Server) Address() string

Address returns the network address.

func (*Server) GracefulStop

func (s *Server) GracefulStop() error

GracefulStop gracefully stops the server.

func (*Server) Network

func (s *Server) Network() string

Network return the network type.

func (*Server) Start

func (s *Server) Start(ln net.Listener) error

Start starts the server.

func (*Server) Stop

func (s *Server) Stop() error

Stop stops the server.