type JobUpdater interface {UpdateJob(ctxcontext.Context, in *proto.UpdateJobRequest) (*proto.UpdateJobResponse,error)FailJob(ctxcontext.Context, in *proto.FailedJob)errorCompleteJob(ctxcontext.Context, in *proto.CompletedJob)error}

type Metrics struct {ConcurrentJobs *prometheus.GaugeVecNumDaemonsprometheus.Gauge// JobTimings also counts the total amount of jobs.JobTimings *prometheus.HistogramVec// WorkspaceBuilds counts workspace build successes and failures.WorkspaceBuilds *prometheus.CounterVec}

type Options struct {UpdaterJobUpdaterQuotaCommitterQuotaCommitterLoggerslog.LoggerFilesystemafero.FsWorkDirectorystringProvisionersdkproto.DRPCProvisionerClientUpdateIntervaltime.DurationForceCancelIntervaltime.DurationLogDebounceIntervaltime.DurationTracertrace.TracerMetricsMetrics}

type QuotaCommitter interface {CommitQuota(ctxcontext.Context, in *proto.CommitQuotaRequest) (*proto.CommitQuotaResponse,error)}

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

funcNew¶added inv0.12.5

func New(ctxcontext.Context,job *proto.AcquiredJob,optsOptions,) *Runner

func (*Runner)Cancel¶

func (r *Runner) Cancel()

Cancel initiates a Cancel on the job, but allows it to keep running to do so gracefully. Read from Done() tobe notified when the job completes.

func (*Runner)Done¶

func (r *Runner) Done() <-chan struct{}

func (*Runner)Fail¶

func (r *Runner) Fail(ctxcontext.Context, f *proto.FailedJob)error

Fail immediately halts updates and, if the job is not complete sends FailJob to the coder server. Running goroutinesare canceled but complete asynchronously (although they are prevented from further updating the job to the coderserver). The provided context sets how long to keep trying to send the FailJob.

func (*Runner)ForceStop¶

func (r *Runner) ForceStop()

ForceStop signals all goroutines to stop and prevents any further API calls back to coder server for this job

func (*Runner)Run¶

func (r *Runner) Run()

Run executes the job.

the idea here is to run two goroutines to work on the job: doCleanFinish and heartbeat, then usethe `r.cond` to wait until the job is either complete or failed. This function then sends thecomplete or failed message --- the exception to this is if something calls Fail() on the Runner;either something external, like the server getting closed, or the heartbeat goroutine timing outafter attempting to gracefully cancel. If something calls Fail(), then the failure is sent onthat goroutine on the context passed into Fail(), and it marks okToSend false to signal us herethat this function should not also send a terminal message.