Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

frame

package module

Go to main page

Versions in this module

v2

v2.0.2

Jul 2, 2026

Changes in this version

type Option

+ func WithHTTPRequestTimeout(timeout time.Duration) Option

type Service

+ func (s *Service) SetShutdownTimeout(timeout time.Duration)

v2.0.1

Jun 29, 2026

Changes in this version

+ const ManifestRegistrationPath

+ const ManifestRegistrationURLEnvVar

+ var ErrHTTPServerConfigRequired = errors.New("configuration must implement config.ConfigurationHTTPServer")

+ var ErrHealthCheckFailed = errors.New("health check failed")

+ func ErrorIsNotFound(err error) bool

+ func FormatNamespaceDisplay(namespace string) string

+ func SubmitJob[T any](ctx context.Context, s *Service, job workerpool.Job[T]) error

+ func ToContext(ctx context.Context, service *Service) context.Context

+ type Checker interface

+ CheckHealth func() error

+ type CheckerFunc func() error

+ func (f CheckerFunc) CheckHealth() error

+ type HealthCheckResult struct

+ Error string

+ Name string

+ Status string

+ type HealthResponse struct

+ BuildDate string

+ Checks []HealthCheckResult

+ Commit string

+ Repository string

+ Service string

+ Status string

+ Uptime string

+ Version string

+ type NamedChecker interface

+ Name func() string

+ type OPLSpec struct

+ Data []byte

+ Namespace string

+ type Option func(ctx context.Context, service *Service)

+ func WithBackgroundConsumer(deque func(_ context.Context) error) Option

+ func WithCache(name string, rawCache cache.RawCache) Option

+ func WithCacheManager() Option

+ func WithConfig(cfg any) Option

+ func WithDatastore(opts ...pool.Option) Option

+ func WithDatastoreConnection(postgresqlConnection string, readOnly bool) Option

+ func WithDatastoreConnectionWithName(name string, postgresqlConnection string, readOnly bool, opts ...pool.Option) Option

+ func WithDatastoreConnectionWithOptions(name string, opts ...pool.Option) Option

+ func WithDatastoreManager() Option

+ func WithDebugEndpoints() Option

+ func WithDebugEndpointsAt(basePath string) Option

+ func WithDriver(driver server.Driver) Option

+ func WithEnvironment(environment string) Option

+ func WithHTTPClient(opts ...client.HTTPOption) Option

+ func WithHTTPHandler(h http.Handler) Option

+ func WithHTTPMiddleware(middleware ...func(http.Handler) http.Handler) Option

+ func WithHealthCheckPath(path string) Option

+ func WithInMemoryCache(name string) Option

+ func WithLogger(opts ...util.Option) Option

+ func WithName(name string) Option

+ func WithOPL(namespace string, data []byte) Option

+ func WithOpenAPIBasePath(path string) Option

+ func WithOpenAPISpec(name, filename string, content []byte) Option

+ func WithOpenAPISpecsFromFS(f fs.FS, dir string) Option

+ func WithPermissionRegistration(sd protoreflect.ServiceDescriptor) Option

+ func WithPlugin(name string, opt Option) Option

+ func WithRegisterEvents(evt ...events.EventI) Option

+ func WithRegisterPublisher(reference string, queueURL string) Option

+ func WithRegisterSubscriber(reference string, queueURL string, handlers ...queue.SubscribeWorker) Option

+ func WithTelemetry(opts ...telemetry.Option) Option

+ func WithTenancyProvider(prov tenancy.Provider) Option

+ func WithTranslation(translationsFolder string, languages ...string) Option

+ func WithVersion(version string) Option

+ func WithWorkerPoolOptions(options ...workerpool.Option) Option

+ type RouteInfo struct

+ Handler string

+ Method string

+ Path string

+ type RouteLister interface

+ Routes func() []RouteInfo

+ type RouteRegistry struct

+ func NewRouteRegistry() *RouteRegistry

+ func (r *RouteRegistry) Handle(pattern string, handler http.Handler)

+ func (r *RouteRegistry) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))

+ func (r *RouteRegistry) HandleRoute(method, pattern, name string, handler func(http.ResponseWriter, *http.Request))

+ func (r *RouteRegistry) Routes() []RouteInfo

+ func (r *RouteRegistry) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type Service struct

+ func FromContext(ctx context.Context) *Service

+ func NewService(opts ...Option) (context.Context, *Service)

+ func NewServiceWithContext(ctx context.Context, opts ...Option) (context.Context, *Service)

+ func (s *Service) AddCleanupMethod(f func(ctx context.Context))

+ func (s *Service) AddHealthCheck(checker Checker)

+ func (s *Service) AddPreStartMethod(f func(ctx context.Context, s *Service))

+ func (s *Service) AddPublisherStartup(f func(ctx context.Context, s *Service))

+ func (s *Service) AddStartupError(err error)

+ func (s *Service) AddSubscriberStartup(f func(ctx context.Context, s *Service))

+ func (s *Service) CacheManager() cache.Manager

+ func (s *Service) Config() any

+ func (s *Service) DatastoreManager() datastore.Manager

+ func (s *Service) Environment() string

+ func (s *Service) EventsManager() events.Manager

+ func (s *Service) GetRawCache(name string) (cache.RawCache, bool)

+ func (s *Service) GetStartupErrors() []error

+ func (s *Service) H() http.Handler

+ func (s *Service) HTTPClientManager() client.Manager

+ func (s *Service) HandleHealth(w http.ResponseWriter, _ *http.Request)

+ func (s *Service) HandleHealthByDefault(w http.ResponseWriter, r *http.Request)

+ func (s *Service) HealthCheckers() []Checker

+ func (s *Service) Init(ctx context.Context, opts ...Option)

+ func (s *Service) LocalizationManager() localization.Manager

+ func (s *Service) Log(ctx context.Context) *util.LogEntry

+ func (s *Service) Name() string

+ func (s *Service) OpenAPIRegistry() *openapi.Registry

+ func (s *Service) QueueManager() queue.Manager

+ func (s *Service) Run(ctx context.Context, address string) error

+ func (s *Service) SLog(ctx context.Context) *slog.Logger

+ func (s *Service) SecurityManager() security.Manager

+ func (s *Service) Stop(ctx context.Context)

+ func (s *Service) TLSEnabled() bool

+ func (s *Service) TelemetryManager() telemetry.Manager

+ func (s *Service) TenancyProvider() tenancy.Provider

+ func (s *Service) Version() string

+ func (s *Service) WorkManager() workerpool.Manager

Other modules containing this package

github.com/pitabwire/frame