api

package
v0.18.15 Latest Latest
Warning

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

Go to latest
Published: Jul 29, 2026 License: Apache-2.0, Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Server

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

Server is the instance of the OpenRun Server

func NewServer

func NewServer(config *ServerConfig) (*Server, error)

NewServer creates a new instance of the OpenRun Server

func (*Server) DrainTimeout added in v0.18.15

func (s *Server) DrainTimeout() time.Duration

DrainTimeout returns the effective shutdown drain timeout: how long Stop waits for in-flight requests and hijacked (websocket) connections to finish before forcing them closed. See clserver.Server.DrainTimeout

func (*Server) Ready added in v0.18.15

func (s *Server) Ready() error

Ready signals that startup has fully completed. See clserver.Server.Ready for why the caller must not call this until every startup step that can still fail (e.g. profiling setup) has passed

func (*Server) Restart added in v0.18.15

func (s *Server) Restart() error

Restart performs a zero downtime in-place restart: the current binary is re-exec'ed and the listeners are handed off to the new process. Blocks until the new process is ready (StopNotify then fires so the caller can drain and exit) or the restart has failed, in which case this server keeps running and the error is returned

func (*Server) Start

func (s *Server) Start() error

Start starts the OpenRun Server

func (*Server) Stop

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

Stop stops the OpenRun Server

func (*Server) StopNotify added in v0.17.8

func (s *Server) StopNotify() <-chan struct{}

StopNotify returns a channel that is closed when server shutdown is requested.

type ServerConfig

type ServerConfig struct {
	*types.ServerConfig
}

ServerConfig is the configuration for the OpenRun Server

func NewServerConfig

func NewServerConfig() (*ServerConfig, error)

Jump to

Keyboard shortcuts

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