httpserver

package

v1.0.0 Latest Latest Go to latest Published: Jul 14, 2023 License: Apache-2.0 Imports: 14 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (

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

This section is empty.

type Opt func(*options)

Opt is an HTTP server option.

func WithCertFile(value string) Opt

WithCertFile sets the TLS certificate file.

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

WithHandlers adds HTTP request handlers.

func WithKeyFile(value string) Opt

WithKeyFile sets the TLS key file.

func WithServerIdleTimeout(value time.Duration) Opt

WithServerIdleTimeout sets the idle timeout.

func WithServerReadHeaderTimeout(value time.Duration) Opt

WithServerReadHeaderTimeout sets the read header timeout.

func WithTracingEnabled(enable bool) Opt

WithTracingEnabled enables/disables OpenTelemetry tracing.

func WithTracingServiceName(serviceName string) Opt

WithTracingServiceName sets the name of the OpenTelemetry service.

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

Server implements an HTTP server.

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

New returns a new HTTP server.

func (s *Server) Start() error

Start starts the HTTP server in a separate Go routine.

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

Stop stops the REST service.

Path	Synopsis
auth
signature
signature/mocks Code generated by counterfeiter.	Code generated by counterfeiter.
maintenance