Documentation
¶
Overview ¶
Package jobs models the compile-time contract shared by portable job adapters. It discovers typed Job subclasses without coupling the compiler pipeline to a particular queue implementation.
Index ¶
- Constants
- func Declarations(input packageextension.ProjectDeclarationInput) (*declaration.Catalog, error)
- func EnqueueHelperName(jobName, method string) string
- func GenerateProject(input packageextension.ProjectDeclarationInput, ...) (packageextension.ProjectGenerationResponse, error)
- type Job
- type Manifest
- type Parameter
- type PerformKind
Constants ¶
const ( PackageName = "trb/jobs" TypeProvider = "trb.jobs" ProjectProvider = "trb.jobs.manifest" )
Variables ¶
This section is empty.
Functions ¶
func Declarations ¶
func Declarations(input packageextension.ProjectDeclarationInput) (*declaration.Catalog, error)
Declarations derives the Jobs type-provider catalog from the versioned, declaration-only project snapshot. It never receives compiler AST nodes.
func EnqueueHelperName ¶ added in v0.3.15
EnqueueHelperName returns the compiler-reserved portable helper that owns a derived Job enqueue method's serialization and scheduling behavior.
func GenerateProject ¶ added in v0.3.15
func GenerateProject(input packageextension.ProjectDeclarationInput, entrypointModule, configurationModule string, origin packageextension.SourceSpan) (packageextension.ProjectGenerationResponse, error)
GenerateProject returns portable TypeRB source for project-wide Jobs behavior. Runtime adapters remain responsible for persistence and worker lifecycle; this source owns payload encoding, scheduling normalization, payload decoding, and typed Job dispatch.
Types ¶
type Job ¶
type Manifest ¶
type Manifest struct {
Jobs []Job
}
func ManifestFrom ¶
func (*Manifest) ExtensionName ¶
type PerformKind ¶ added in v0.3.0
type PerformKind string
const ( // PerformVoid is the zero value so manifests assembled by package tests and // third-party integrations keep the ordinary infallible Job contract. PerformVoid PerformKind = "" PerformJobResult PerformKind = "job_result" )
Directories
¶
| Path | Synopsis |
|---|---|
|
Package sqladapter owns the compile-time configuration for the official trb/jobs/sql adapter.
|
Package sqladapter owns the compile-time configuration for the official trb/jobs/sql adapter. |
|
Package sqlstore defines the durable state model and dialect-specific SQL used by the portable SQL job adapter.
|
Package sqlstore defines the durable state model and dialect-specific SQL used by the portable SQL job adapter. |