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

gorch

package module

Go to main page

Versions in this module

v0

v0.6.0

Sep 11, 2026

Changes in this version

+ var ErrAlreadyStarted = errors.New("gorch: orchestrator already started")

+ var ErrDependencyCycle = errors.New("gorch: dependency cycle detected")

+ var ErrDuplicateName = errors.New("gorch: duplicate service name")

+ var ErrInvalidCron = errors.New("gorch: invalid cron expression")

+ var ErrStartAborted = errors.New("gorch: start aborted due to dependency failure")

+ var ErrStopTimeout = errors.New("gorch: stop timed out waiting for services")

+ var ErrUnsupportedOption = errors.New("gorch: unsupported option combination")

+ func RegisterType[T any](m *Messenger) error

+ func TypedPublish[T any](m *Messenger, msg T, topics ...string)

+ func TypedRequest[TReq, TResp any](m *Messenger, ctx context.Context, req TReq, topic string) (TResp, error)

+ func TypedRespond[TResp any](m *Messenger, resp TResp, replyTopic string)

+ func TypedSubscribeRequest[TReq any](m *Messenger, topic string) (<-chan TypedEnvelope[TReq], func())

+ func TypedSubscribe[T any](m *Messenger, topic string) (<-chan T, func())

+ type Backoff interface

+ Next func(retry int) time.Duration

+ type ConstantBackoff struct

+ Delay time.Duration

+ func (b ConstantBackoff) Next(retry int) time.Duration

+ type CronMode int

+ const CronParallel

+ const CronQueue

+ const CronSkip

+ type ExponentialBackoff struct

+ Factor float64

+ Initial time.Duration

+ Max time.Duration

+ func (b ExponentialBackoff) Next(retry int) time.Duration

+ type HealthCheckOption func(*config)

+ func WithFailureThreshold(n int) HealthCheckOption

+ func WithProbeTimeout(d time.Duration) HealthCheckOption

+ type HealthChecker interface

+ Health func(ctx context.Context) error

+ type LogLevel int

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelWarn

+ func (l LogLevel) String() string

+ type Logger interface

+ Debug func(msg string, args ...any)

+ Error func(msg string, args ...any)

+ Info func(msg string, args ...any)

+ Warn func(msg string, args ...any)

+ type Message struct

+ Payload []byte

+ ReplyTopic string

+ Topic string

+ TypeName string

+ type Messenger struct

+ func (m *Messenger) Drain()

+ func (m *Messenger) Publish(msg any, topics ...string)

+ func (m *Messenger) Request(ctx context.Context, msg any, topic string) (any, error)

+ func (m *Messenger) RequestAsync(ctx context.Context, msg any, topic string) (<-chan any, error)

+ func (m *Messenger) Subscribe(topic string) (<-chan any, func())

+ func (m *Messenger) SubscribeWithBuffer(topic string, bufSize int) (<-chan any, func())

+ type Metrics struct

+ Crashes int64

+ HealthFails int64

+ Restarts int64

+ Starts int64

+ Stops int64

+ type Option func(*config)

+ func WithAfterHealthCheck(fn func(name string, err error)) Option

+ func WithBeforeHealthCheck(fn func(name string) error) Option

+ func WithDefaultStartTimeout(d time.Duration) Option

+ func WithGlobalOnAfterStart(fn func(name string, err error)) Option

+ func WithGlobalOnAfterStop(fn func(name string, err error)) Option

+ func WithGlobalOnBeforeStart(fn func(name string) error) Option

+ func WithGlobalOnBeforeStop(fn func(name string) error) Option

+ func WithHealthChecks(interval time.Duration, opts ...HealthCheckOption) Option

+ func WithHealthChecksDisabled() Option

+ func WithLogLevel(lvl LogLevel) Option

+ func WithLogger(l Logger) Option

+ func WithOnCrash(fn func(name string, err error)) Option

+ func WithOnStateChange(fn func(name string, from, to ServiceStatus)) Option

+ type Orchestrator struct

+ func New(opts ...Option) *Orchestrator

+ func (o *Orchestrator) Count() int

+ func (o *Orchestrator) Done() <-chan struct{}

+ func (o *Orchestrator) Health() map[string]error

+ func (o *Orchestrator) IsReady(ctx context.Context, name string) bool

+ func (o *Orchestrator) Metrics() Metrics

+ func (o *Orchestrator) Names() []string

+ func (o *Orchestrator) Register(svc Service, opts ...RegisterOption) error

+ func (o *Orchestrator) RegisterFunc(name string, startFn func(ctx ServiceContext) error, stopFn func() error, ...) error

+ func (o *Orchestrator) Run(stopTimeout time.Duration, signals ...os.Signal) error

+ func (o *Orchestrator) Start() error

+ func (o *Orchestrator) StartGroup(group string) error

+ func (o *Orchestrator) Status(name string) (ServiceStatus, bool)

+ func (o *Orchestrator) Statuses() map[string]ServiceStatus

+ func (o *Orchestrator) StatusesByGroup(group string) map[string]ServiceStatus

+ func (o *Orchestrator) StatusesByLabel(key, value string) map[string]ServiceStatus

+ func (o *Orchestrator) Stop(timeout time.Duration) error

+ func (o *Orchestrator) StopGroup(group string, timeout time.Duration) error

+ func (o *Orchestrator) WaitFor(name string, target ServiceStatus, timeout time.Duration) error

+ type ReadinessChecker interface

+ Ready func(ctx context.Context) error

+ type RegisterOption func(*registerConfig)

+ func DependsOn(names ...string) RegisterOption

+ func DependsOnSoft(names ...string) RegisterOption

+ func WithBackoff(b Backoff) RegisterOption

+ func WithCron(spec string, mode CronMode) RegisterOption

+ func WithGroup(name string) RegisterOption

+ func WithLabel(key, value string) RegisterOption

+ func WithMaxRetries(max int) RegisterOption

+ func WithName(name string) RegisterOption

+ func WithOnAfterStart(fn func(name string, err error)) RegisterOption

+ func WithOnAfterStop(fn func(name string, err error)) RegisterOption

+ func WithOnBeforeStart(fn func(name string) error) RegisterOption

+ func WithOnBeforeStop(fn func(name string) error) RegisterOption

+ func WithResetAfter(d time.Duration) RegisterOption

+ func WithRunOnce() RegisterOption

+ func WithSelfHeal(factory func() Service) RegisterOption

+ func WithStartCondition(fn func() bool) RegisterOption

+ func WithStartTimeout(d time.Duration) RegisterOption

+ func WithStopTimeout(d time.Duration) RegisterOption

+ type Service interface

+ Start func(ctx ServiceContext) error

+ Stop func() error

+ type ServiceContext struct

+ Logger *ServiceLogger

+ Messenger *Messenger

+ type ServiceLogger struct

+ func (l *ServiceLogger) Debug(msg string, args ...any)

+ func (l *ServiceLogger) Error(msg string, args ...any)

+ func (l *ServiceLogger) Info(msg string, args ...any)

+ func (l *ServiceLogger) Warn(msg string, args ...any)

+ type ServiceStatus int

+ const StatusCrashed

+ const StatusRegistered

+ const StatusRunning

+ const StatusStarting

+ const StatusStopped

+ const StatusStopping

+ const StatusSucceeded

+ func (s ServiceStatus) String() string

+ type TypedEnvelope struct

+ ReplyTopic string

+ Value T

+ type Validator interface

+ Validate func() error

v0.5.0

Sep 9, 2026

v0.4.0

Sep 9, 2026

v0.3.1

Jul 30, 2026

v0.3.0

Jul 27, 2026

v0.2.0

Jul 27, 2026

v0.1.0

Jul 27, 2026