httpserver

Documentation

Index

• Variables
• type Opt
  • func WithCertFile(value string) Opt
  • func WithHandlers(handlers ...common.HTTPHandler) Opt
  • func WithKeyFile(value string) Opt
  • func WithServerIdleTimeout(value time.Duration) Opt
  • func WithServerReadHeaderTimeout(value time.Duration) Opt
  • func WithTracingEnabled(enable bool) Opt
  • func WithTracingServiceName(serviceName string) Opt
• type Server
  • func New(url string, opts ...Opt) *Server
  • func (s *Server) Start() error
  • func (s *Server) Stop(ctx context.Context) error

Variables

var (

	// BuildVersion contains the version of the Orb build.
	BuildVersion string
)

Types

type Opt

type Opt func(*options)

Opt is an HTTP server option.

func WithCertFile

func WithCertFile(value string) Opt

WithCertFile sets the TLS certificate file.

func WithHandlers

func WithHandlers(handlers ...common.HTTPHandler) Opt

WithHandlers adds HTTP request handlers.

func WithKeyFile

func WithKeyFile(value string) Opt

WithKeyFile sets the TLS key file.

func WithServerIdleTimeout

func WithServerIdleTimeout(value time.Duration) Opt

WithServerIdleTimeout sets the idle timeout.

func WithServerReadHeaderTimeout

func WithServerReadHeaderTimeout(value time.Duration) Opt

WithServerReadHeaderTimeout sets the read header timeout.

func WithTracingEnabled

func WithTracingEnabled(enable bool) Opt

WithTracingEnabled enables/disables OpenTelemetry tracing.

func WithTracingServiceName

func WithTracingServiceName(serviceName string) Opt

WithTracingServiceName sets the name of the OpenTelemetry service.

type Server

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

Server implements an HTTP server.

func New

func New(url string, opts ...Opt) *Server

New returns a new HTTP server.

func (*Server) Start

func (s *Server) Start() error

Start starts the HTTP server in a separate Go routine.

func (*Server) Stop

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

Stop stops the REST service.