summaryrefslogtreecommitdiff
path: root/plugins/jobs/structs/job.go
blob: 2e3945439c9c24402300fda001bef2faefdb2324 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package structs

import (
	json "github.com/json-iterator/go"
	"github.com/spiral/roadrunner/v2/utils"
)

// Job carries information about single job.
type Job struct {
	// Job contains name of job broker (usually PHP class).
	Job string `json:"job"`

	// Payload is string data (usually JSON) passed to Job broker.
	Payload string `json:"payload"`

	// Options contains set of PipelineOptions specific to job execution. Can be empty.
	Options *Options `json:"options,omitempty"`
}

// Body packs job payload into binary payload.
func (j *Job) Body() []byte {
	return utils.AsBytes(j.Payload)
}

// Context packs job context (job, id) into binary payload.
func (j *Job) Context(id string) []byte {
	ctx, _ := json.Marshal(
		struct {
			ID  string `json:"id"`
			Job string `json:"job"`
		}{ID: id, Job: j.Job},
	)

	return ctx
}