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
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

runtime

package

Go to main page

Versions in this module

v0

v0.8.0

Jan 21, 2026

Changes in this version

+ const EnvBifrostRole

+ const RoleWorker

+ var ErrMasterShuttingDown = errors.New("master is shutting down")

+ var ErrRestartLimitExceeded = errors.New("restart limit exceeded: too many restarts in the last minute")

+ func GetControlSocketPath() string

+ func InheritedListeners() (map[string]*os.File, error)

+ func IsWorker() bool

+ func NotifySystemdReady()

+ func SetProcessName(name string) error

+ type CommandRunner interface

+ Command func(name string, arg ...string) *exec.Cmd

+ type ControlMessage struct

+ Payload []byte

+ Type MessageType

+ WorkerPID int

+ type ControlPlane struct

+ func NewControlPlane(opts *ControlPlaneOptions) *ControlPlane

+ func (cp *ControlPlane) Accept(ctx context.Context) error

+ func (cp *ControlPlane) Close() error

+ func (cp *ControlPlane) Listen() error

+ func (cp *ControlPlane) ReceiveFDsFromConn(conn net.Conn) ([]*os.File, error)

+ func (cp *ControlPlane) SendMessage(workerPID int, msg *ControlMessage) error

+ func (cp *ControlPlane) SetFDHandler(handler func(fds []*os.File, keys []string))

+ func (cp *ControlPlane) SetMessageHandler(handler func(conn net.Conn, msg *ControlMessage))

+ func (cp *ControlPlane) SocketPath() string

+ type ControlPlaneClient interface

+ SendFDs func(files []*os.File, keys []string) error

+ type ControlPlaneOptions struct

+ SocketPath string

+ type EnvGetter func(string) string

+ type FDHandler interface

+ HandleFDRequest func() error

+ type FileOpener func(name string) (*os.File, error)

+ type KeepAlive struct

+ func NewKeepAlive(opts *KeepAliveOptions) *KeepAlive

+ func (k *KeepAlive) CurrentBackoff() time.Duration

+ func (k *KeepAlive) RecordRestart()

+ func (k *KeepAlive) Reset()

+ func (k *KeepAlive) RestartsInLastMinute() int

+ func (k *KeepAlive) ShouldRestart() (shouldRestart bool, backoffDuration time.Duration, err error)

+ type KeepAliveOptions struct

+ InitialBackoff time.Duration

+ MaxBackoff time.Duration

+ MaxRestartsPerMinute int

+ func DefaultKeepAliveOptions() *KeepAliveOptions

+ type ListenerOptions struct

+ Address string

+ Config *net.ListenConfig

+ Network string

+ ProxyProtocol bool

+ type Master struct

+ func NewMaster(opts *MasterOptions) *Master

+ func (m *Master) ControlPlane() *ControlPlane

+ func (m *Master) Run(ctx context.Context) error

+ func (m *Master) Shutdown(ctx context.Context) error

+ func (m *Master) State() MasterState

+ func (m *Master) WorkerPID() int

+ type MasterOptions struct

+ Args []string

+ Binary string

+ ConfigPath string

+ GracefulTimeout time.Duration

+ KeepAlive *KeepAliveOptions

+ type MasterState int8

+ const MasterStateIdle

+ const MasterStateReloading

+ const MasterStateRunning

+ const MasterStateShuttingDown

+ func (s MasterState) String() string

+ type MessageType string

+ const MessageTypeAck

+ const MessageTypeFDRequest

+ const MessageTypeFDTransferStart

+ const MessageTypeReady

+ const MessageTypeRegister

+ const MessageTypeShutdown

+ type Options struct

+ QuitTimout time.Duration

+ type ProcessFinder interface

+ FindProcess func(pid int) (process, error)

+ type State int8

+ type WorkerControlPlane struct

+ func NewWorkerControlPlane(socketPath string) *WorkerControlPlane

+ func (wcp *WorkerControlPlane) Close() error

+ func (wcp *WorkerControlPlane) Connect() error

+ func (wcp *WorkerControlPlane) NotifyReady() error

+ func (wcp *WorkerControlPlane) Register() error

+ func (wcp *WorkerControlPlane) SendFDs(files []*os.File, keys []string) error

+ func (wcp *WorkerControlPlane) Start(ctx context.Context, fdHandler FDHandler) error

+ type WorkerFDHandler struct

+ func NewWorkerFDHandler(wcp ControlPlaneClient) *WorkerFDHandler

+ func (h *WorkerFDHandler) HandleFDRequest() error

+ func (h *WorkerFDHandler) ListenerCount() int

+ func (h *WorkerFDHandler) RegisterListener(listener net.Listener, key string)

+ type ZeroDownTime struct

+ QuitTimeout time.Duration

+ func New(opts Options) *ZeroDownTime

+ func (z *ZeroDownTime) Close(ctx context.Context) error

+ func (z *ZeroDownTime) GetListeners() []*listenInfo

+ func (z *ZeroDownTime) IsUpgraded() bool

+ func (z *ZeroDownTime) IsWaiting() bool

+ func (z *ZeroDownTime) Listener(ctx context.Context, options *ListenerOptions) (net.Listener, error)

+ func (z *ZeroDownTime) WaitForUpgrade(ctx context.Context) error

v0.3.0

Mar 29, 2025

v0.2.0

Feb 14, 2025

v0.1.0

Dec 22, 2024

Changes in this version

+ func StackTrace() string