httpworker

README

httpworker

Go HTTP worker compatible with Voi SVC https://github.com/voi-oss/svc

Documentation

Index

• type Option
  • func WithAddress(addr string) Option
  • func WithRouter(router chi.Router) Option
  • func WithShutdownCtx(ctx context.Context) Option
• type Worker
  • func New(logger *zap.Logger, opts ...Option) *Worker
  • func (w *Worker) Alive() error
  • func (w *Worker) Init(logger *zap.Logger) error
  • func (w *Worker) Run() error
  • func (w *Worker) Terminate() error

Types

type Option

type Option func(w *Worker)

Option is a functional option for configuring the Worker.

func WithAddress

func WithAddress(addr string) Option

WithAddress sets the address for the Worker. Default is ":8080".

func WithRouter

func WithRouter(router chi.Router) Option

WithRouter sets the chi router for the Worker.

func WithShutdownCtx

func WithShutdownCtx(ctx context.Context) Option

WithShutdownCtx sets the context for the Worker's shutdown timeout.

type Worker

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

Worker is a svc.Worker implementation that uses the go-chi/chi router.

func New

func New(logger *zap.Logger, opts ...Option) *Worker

New creates a new Worker with the provided logger and options.

func (*Worker) Alive

func (w *Worker) Alive() error

Alive checks if the server is running by making a request to the health check route.

func (*Worker) Init

func (w *Worker) Init(logger *zap.Logger) error

func (*Worker) Run

func (w *Worker) Run() error

func (*Worker) Terminate

func (w *Worker) Terminate() error