server

package

v0.0.4 Latest Latest Go to latest Published: Jan 3, 2023 License: MIT Imports: 20 Imported by: 0

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

Repository

github.com/ketch-com/go-ketch-forwarder

Links

Open Source Insights

README ¶

server

This folder contains the module for starting the server service.

Documentation ¶

Index ¶

Variables
func BasicAuth(username, password string) func(next http.Handler) http.Handler
func CanAccept(r *http.Request, values ...string) bool
func Lifecycle(lifecycle fx.Lifecycle, listener net.Listener, server *http.Server)
func NewHandler(params HandlerParams) http.Handler
func NewListener(config Config) (net.Listener, error)
func NewServer(handler http.Handler) *http.Server
func NewTLSConfig(cfg TLSConfig) (*tls.Config, error)
func WriteError(w http.ResponseWriter, metadata *types.Metadata, statusCode int, status string, ...)
type Config
- func NewConfig() Config
- func (c Config) Addr() string
type Handler
- func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
type HandlerParams
type TLSConfig
- func (c TLSConfig) GetEnabled() bool

Constants ¶

This section is empty.

Variables ¶

View Source

var Module = fx.Module("server",
	handler.Module,

	fx.Provide(
		NewConfig,
		NewListener,
		NewServer,
		NewHandler,
	),

	fx.Invoke(
		Lifecycle,
	),
)

Functions ¶

func BasicAuth ¶

func BasicAuth(username, password string) func(next http.Handler) http.Handler

func CanAccept ¶

func CanAccept(r *http.Request, values ...string) bool

func Lifecycle ¶

func Lifecycle(lifecycle fx.Lifecycle, listener net.Listener, server *http.Server)

Lifecycle runs the HTTP Server

func NewHandler ¶

func NewHandler(params HandlerParams) http.Handler

func NewListener ¶

func NewListener(config Config) (net.Listener, error)

NewListener returns a net.Listener for the given config

func NewServer ¶

func NewServer(handler http.Handler) *http.Server

NewServer returns a new http.Server

func NewTLSConfig ¶

func NewTLSConfig(cfg TLSConfig) (*tls.Config, error)

NewTLSConfig returns a tls.Config for the given Config

func WriteError ¶

func WriteError(w http.ResponseWriter, metadata *types.Metadata, statusCode int, status string, message string)

Types ¶

type Config ¶

type Config struct {
	Bind     string
	Listen   uint
	TLS      TLSConfig
	Username string
	Password string
}

func NewConfig ¶

func NewConfig() Config

func (Config) Addr ¶

func (c Config) Addr() string

type Handler ¶

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

func (*Handler) ServeHTTP ¶

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type HandlerParams ¶

type HandlerParams struct {
	fx.In

	Config             Config
	Access             types.AccessHandler             `optional:"true"`
	Delete             types.DeleteHandler             `optional:"true"`
	Correction         types.CorrectionHandler         `optional:"true"`
	RestrictProcessing types.RestrictProcessingHandler `optional:"true"`
}

type TLSConfig ¶

type TLSConfig struct {
	CertFile   string
	KeyFile    string
	RootCAFile string
}

func (TLSConfig) GetEnabled ¶

func (c TLSConfig) GetEnabled() bool

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL