api

package
v0.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 24, 2026 License: BSD-3-Clause Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Deps

type Deps struct {
	DB        *db.DB
	Collector *collector.Collector
	Exporter  *export.Builder
	Targets   []config.TargetConfig
}

Deps holds handler dependencies.

type Server

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

Server is the Arq Signals HTTP API server.

func NewServer

func NewServer(addr string, readTimeout, writeTimeout time.Duration, apiToken string, deps *Deps) *Server

NewServer creates a new API Server with signals-only endpoints.

func (*Server) Handler

func (s *Server) Handler() http.Handler

Handler returns the HTTP handler for testing.

func (*Server) Shutdown

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

Shutdown gracefully stops the server.

func (*Server) Start

func (s *Server) Start() error

Start begins listening and serving. It blocks until the server stops.

Jump to

Keyboard shortcuts

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