requests

package
v2.17.0-beta.1 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: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RequestEnv

type RequestEnv struct {
	// Context is the per-request context. It should be derived from the app's
	// state context (st.GetContext()) with config.APIRequestTimeout, so it
	// cancels on app shutdown and on timeout. For HTTP, it should also cancel
	// when the HTTP connection closes.
	Context         context.Context
	Platform        platforms.Platform
	Config          *config.Instance
	State           *state.State
	Database        *database.Database
	LimitsManager   *playtime.LimitsManager
	Profiles        *profiles.Service
	LauncherCache   *helpers.LauncherCache
	Player          audio.Player
	PlaybackManager audio.PlaybackManager
	UI              *uievents.Service
	TokenQueue      chan<- tokens.Token
	ConfirmQueue    chan<- chan error
	IndexPauser     *syncutil.Pauser
	ScrapePauser    *syncutil.Pauser
	BackupPauser    *syncutil.Pauser
	// InputSession is non-nil only for durable transports such as WebSocket.
	// It owns keyboard and gamepad inputs held across requests.
	InputSession platforms.InputSession
	ClientID     string
	PlatformID   string
	// ClientRole is the paired client's permission role ("admin" or
	// "member"), or "" when the request carries no paired identity (local
	// connections, plaintext WebSocket, HTTP). See pkg/api/permissions.
	ClientRole string
	Params     json.RawMessage
	IsLocal    bool
	// APIKeyAuthenticated is true when static API-key middleware authenticated
	// this non-paired request. It grants admin authority, not localhost access.
	APIKeyAuthenticated bool
}

Jump to

Keyboard shortcuts

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