linuxbase

package
v2.17.0-beta.2 Latest Latest
Warning

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

 Go to latest Published: Aug 29, 2026 License: GPL-3.0 Imports: 33 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// CustomKillTimeout is how long to wait for launcher-specific graceful shutdown.
	CustomKillTimeout = 500 * time.Millisecond
	// SIGTERMTimeout is how long to wait for graceful SIGTERM shutdown.
	SIGTERMTimeout = 3 * time.Second
	// SIGKILLTimeout is how long to wait after SIGKILL before proceeding.
	SIGKILLTimeout = 500 * time.Millisecond
)

Timeout constants for process termination.

Variables

This section is empty.

Functions

func DesktopSessionEnvOverrides 

func DesktopSessionEnvOverrides(gameMode *gamescope.Manager) []string

DesktopSessionEnvOverrides returns GUI and user-directory variables for the active desktop session. This prevents service-specific XDG paths from leaking into launched applications. A detected gamescope display takes precedence.

func IsDesktopSessionEnvKey 

func IsDesktopSessionEnvKey(key string) bool

IsDesktopSessionEnvKey reports whether key belongs to the active GUI session.

func ParseDesktopSessionEnv 

func ParseDesktopSessionEnv(output string) []string

func Settings 

func Settings() platforms.Settings

Settings returns XDG-based settings for Linux platforms.

func SupportedReaders 

func SupportedReaders(cfg *config.Instance, p platforms.Platform) []readers.Reader

SupportedReaders returns the list of enabled readers for Linux platforms. The platform parameter is needed for tty2oled reader initialization.

Types

type Base 

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

Base provides common functionality for all Linux-family platforms. Platforms embed this struct and override methods as needed.

func NewBase 

func NewBase(platformID string) *Base

NewBase creates a new Base with the given platform ID.

func (*Base) ClearTrackedProcessMedia added in v2.16.0 

func (b *Base) ClearTrackedProcessMedia(proc *os.Process) bool

ClearTrackedProcessMedia clears active media only if proc completed without a newer process being tracked. This prevents an old process waiter from clearing the active media published by a replacement launch.

func (*Base) ClearTrackedProcessPID added in v2.16.0 

func (b *Base) ClearTrackedProcessPID(pid int) bool

ClearTrackedProcessPID forgets a completed externally-owned process without signaling it. The PID check prevents an older lifecycle event from clearing a newer tracked process.

func (*Base) ConsoleManager 

func (*Base) ConsoleManager() platforms.ConsoleManager

ConsoleManager returns a no-op console manager.

func (*Base) ForwardCmd 

func (*Base) ForwardCmd(_ *platforms.CmdEnv) (platforms.CmdResult, error)

ForwardCmd is not supported on generic Linux platforms (no command forwarding).

func (*Base) GamepadPress 

func (*Base) GamepadPress(_ string) error

GamepadPress is a no-op for Linux platforms.

func (*Base) ID 

func (b *Base) ID() string

ID returns the platform identifier.

func (*Base) KeyboardPress 

func (*Base) KeyboardPress(_ string) error

KeyboardPress is a no-op for Linux platforms.

func (*Base) LaunchMedia 

func (b *Base) LaunchMedia(
	cfg *config.Instance,
	path string,
	launcher *platforms.Launcher,
	db *database.Database,
	opts *platforms.LaunchOptions,
	p platforms.Platform,
) error

LaunchMedia launches media using the appropriate launcher. The platform parameter is required to access the platform's Launchers method (struct embedding means Base cannot call methods defined on the outer type).

func (*Base) LaunchSystem 

func (*Base) LaunchSystem(_ *config.Instance, _ string) error

LaunchSystem returns an error as launching systems is not supported.

func (*Base) LookupMapping 

func (*Base) LookupMapping(_ *tokens.Token) (string, bool)

LookupMapping returns false (no token mappings on Linux platforms).

func (*Base) ManagedByPackageManager added in v2.10.0 

func (*Base) ManagedByPackageManager() bool

ManagedByPackageManager returns false. Platforms that embed Base and have package manager detection should override this method.

func (*Base) ReturnToMenu 

func (*Base) ReturnToMenu() error

ReturnToMenu is a no-op for the base Linux implementation. Platforms with a menu concept (like SteamOS) should override this method.

func (*Base) RootDirs 

func (*Base) RootDirs(cfg *config.Instance) []string

RootDirs returns the configured index roots.

func (*Base) ScanHook 

func (*Base) ScanHook(_ *tokens.Token) error

ScanHook is a no-op for Linux platforms.

func (*Base) Scrapers added in v2.12.0 

func (*Base) Scrapers(_ *config.Instance) map[string]platforms.Scraper

Scrapers returns the default set of metadata scrapers for Linux-based platforms.

func (*Base) Screenshot added in v2.10.0 

func (*Base) Screenshot() (*platforms.ScreenshotResult, error)

Screenshot is not supported on generic Linux platforms.

func (*Base) SetClock 

func (b *Base) SetClock(clock clockwork.Clock)

SetClock sets the clock for testing. Must be called before using the Base.

func (*Base) SetTrackedProcess 

func (b *Base) SetTrackedProcess(proc *os.Process)

SetTrackedProcess stores a process handle, killing any existing tracked process.

func (*Base) StartPost 

func (b *Base) StartPost(
	ctx context.Context,
	_ *config.Instance,
	launcherManager platforms.LauncherContextManager,
	activeMedia func() *models.ActiveMedia,
	setActiveMedia func(*models.ActiveMedia),
	_ *database.Database,
	_ *idle.Scheduler,
) error

StartPost initializes the platform after service startup.

func (*Base) StartPre 

func (*Base) StartPre(_ *config.Instance) error

StartPre is a no-op for Linux platforms.

func (*Base) Stop 

func (*Base) Stop() error

Stop is a no-op for Linux platforms.

func (*Base) StopActiveLauncher 

func (b *Base) StopActiveLauncher(_ platforms.StopIntent) error

StopActiveLauncher runs launcher-specific shutdown, stops any tracked process tree, and clears active media. Tracked processes receive SIGTERM and SIGKILL fallback.

func (*Base) WaitTrackedProcess added in v2.16.0 

func (b *Base) WaitTrackedProcess(proc *os.Process) error

WaitTrackedProcess waits for and reaps proc. StopActiveLauncher coordinates through the same completion channel so os.Process.Wait is called exactly once.

Source Files

View all Source files

Directories

Path Synopsis
Package gamescope makes externally launched windows visible and focused in gamescope Gaming Mode sessions.
 Package gamescope makes externally launched windows visible and focused in gamescope Gaming Mode sessions.
Package procscanner provides a shared process scanner for monitoring multiple types of processes with a single /proc scan.
 Package procscanner provides a shared process scanner for monitoring multiple types of processes with a single /proc scan.
Package proctracker provides process exit tracking using pidfd_open on Linux 5.3+.
 Package proctracker provides process exit tracking using pidfd_open on Linux 5.3+.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.