tgstation-server 6.12.3
The /tg/station 13 server suite
Loading...
Searching...
No Matches
Classes | Functions
Tgstation.Server.Host.Jobs Namespace Reference

Classes

interface  IJobManager
 Manages the runtime of Jobs. More...
 
interface  IJobService
 The service that manages everything to do with jobs. More...
 
interface  IJobsHubUpdater
 Allows manually triggering jobs hub updates. More...
 
class  JobException
 Operation exceptions thrown from the context of a Models.Job. More...
 
class  JobHandler
 Class for pairing Tasks with CancellationTokenSources. More...
 
class  JobProgressReporter
 Progress reporter for a Job. More...
 
class  JobService
 
class  JobsHub
 A SignalR Hub for pushing job updates. More...
 
class  JobsHubGroupMapper
 Handles mapping groups for the JobsHub. More...
 

Functions

delegate ValueTask JobEntrypoint (IInstanceCore? instance, IDatabaseContextFactory databaseContextFactory, Job job, JobProgressReporter progressReporter, CancellationToken cancellationToken)
 Entrypoint for running a given job.
 

Function Documentation

◆ JobEntrypoint()

delegate ValueTask Tgstation.Server.Host.Jobs.JobEntrypoint ( IInstanceCore instance,
IDatabaseContextFactory  databaseContextFactory,
Job  job,
JobProgressReporter  progressReporter,
CancellationToken  cancellationToken 
)

Entrypoint for running a given job.

Parameters
instanceThe IInstanceCore the job is running on. null only when performing an instance move operation.
databaseContextFactoryThe IDatabaseContextFactory for the operation.
jobThe running Job.
progressReporterThe JobProgressReporter for the job.
cancellationTokenThe CancellationToken for the operation.
Returns
A ValueTask representing the running operation.