Documentation
¶
Index ¶
- Variables
- type AuthPlugin
- type IDGenerator
- type JCStore
- type JLStore
- type JRClient
- func (c *JRClient) NewJobChain(jc proto.JobChain) error
- func (c *JRClient) RequestStatus(requestId string) (proto.JobChainStatus, error)
- func (c *JRClient) ResumeJobChain(sjc proto.SuspendedJobChain) error
- func (c *JRClient) StartRequest(requestId string) error
- func (c *JRClient) StopRequest(requestId string) error
- func (c *JRClient) SysStatRunning() ([]proto.JobStatus, error)
- type JRStatus
- type Job
- func (j *Job) Create(jobArgs map[string]interface{}) error
- func (j *Job) Deserialize(jobArgs []byte) error
- func (j *Job) Id() job.Id
- func (j *Job) Run(jobData map[string]interface{}) (job.Return, error)
- func (j *Job) Serialize() ([]byte, error)
- func (j *Job) Status() string
- func (j *Job) Stop() error
- type JobFactory
- type JobReaper
- type RMClient
- func (c *RMClient) CreateJL(requestId string, jl proto.JobLog) error
- func (c *RMClient) CreateRequest(requestId string, args map[string]interface{}) (string, error)
- func (c *RMClient) FinishRequest(requestId string, state byte) error
- func (c *RMClient) GetJL(requestId string) ([]proto.JobLog, error)
- func (c *RMClient) GetJobChain(requestId string) (proto.JobChain, error)
- func (c *RMClient) GetRequest(requestId string) (proto.Request, error)
- func (c *RMClient) RequestList() ([]proto.RequestSpec, error)
- func (c *RMClient) RequestStatus(requestId string) (proto.RequestStatus, error)
- func (c *RMClient) StartRequest(requestId string) error
- func (c *RMClient) StopRequest(requestId string) error
- func (c *RMClient) SuspendRequest(requestId string, sjc proto.SuspendedJobChain) error
- func (c *RMClient) SysStatRunning() (proto.RunningStatus, error)
- type RMStatus
- type ReaperFactory
- type RequestManager
- func (r *RequestManager) Create(reqParams proto.CreateRequestParams) (proto.Request, error)
- func (r *RequestManager) Finish(reqId string, finishParams proto.FinishRequestParams) error
- func (r *RequestManager) Get(reqId string) (proto.Request, error)
- func (r *RequestManager) IncrementFinishedJobs(reqId string) error
- func (r *RequestManager) JobChain(reqId string) (proto.JobChain, error)
- func (r *RequestManager) Specs() []proto.RequestSpec
- func (r *RequestManager) Start(reqId string) error
- func (r *RequestManager) Status(reqId string) (proto.RequestStatus, error)
- func (r *RequestManager) Stop(reqId string) error
- type Runner
- type RunnerFactory
- type Traverser
- type TraverserFactory
Constants ¶
This section is empty.
Variables ¶
View Source
var (
ErrIdGenerator = errors.New("forced error in id generator")
)
View Source
var (
ErrJCStore = errors.New("forced error in jobchain store")
)
View Source
var (
ErrJLStore = errors.New("forced error in joblog store")
)
View Source
var (
ErrJRClient = errors.New("forced error in jr client")
)
View Source
var (
ErrJob = errors.New("forced error in job")
)
View Source
var (
ErrJobReaper = errors.New("forced error in job reaper")
)
View Source
var (
ErrRMClient = errors.New("forced error in rm client")
)
View Source
var (
ErrRequestManager = errors.New("forced error in request manager")
)
View Source
var (
ErrRunner = errors.New("forced error in runner")
)
View Source
var (
ErrTraverser = errors.New("forced error in traverser")
)
Functions ¶
This section is empty.
Types ¶
type AuthPlugin ¶
type AuthPlugin struct {
AuthenticateFunc func(*http.Request) (auth.Caller, error)
AuthorizeFunc func(c auth.Caller, op string, req proto.Request) error
}
func (AuthPlugin) Authenticate ¶
type IDGenerator ¶
func (*IDGenerator) ID ¶
func (g *IDGenerator) ID() string
func (*IDGenerator) UID ¶
func (g *IDGenerator) UID() (string, error)
type JLStore ¶
type JLStore struct {
CreateFunc func(string, proto.JobLog) (proto.JobLog, error)
GetFunc func(string, string) (proto.JobLog, error)
GetFullFunc func(string) ([]proto.JobLog, error)
}
type JRClient ¶
type JRClient struct {
NewJobChainFunc func(proto.JobChain) error
ResumeJobChainFunc func(proto.SuspendedJobChain) error
StartRequestFunc func(string) error
StopRequestFunc func(string) error
RequestStatusFunc func(string) (proto.JobChainStatus, error)
SysStatRunningFunc func() ([]proto.JobStatus, error)
}
func (*JRClient) RequestStatus ¶
func (c *JRClient) RequestStatus(requestId string) (proto.JobChainStatus, error)
func (*JRClient) ResumeJobChain ¶
func (c *JRClient) ResumeJobChain(sjc proto.SuspendedJobChain) error
func (*JRClient) StartRequest ¶
func (*JRClient) StopRequest ¶
type Job ¶
type Job struct {
CreateErr error
SerializeBytes []byte
SerializeErr error
DeserializeErr error
RunReturn job.Return
RunErr error
RunFunc func(jobData map[string]interface{}) (job.Return, error) // can use this instead of RunErr and RunFunc for more involved mocks
StopErr error
StatusResp string
CreatedWithArgs map[string]interface{}
SetJobArgs map[string]interface{}
IdResp job.Id
}
func (*Job) Deserialize ¶
type JobFactory ¶
type RMClient ¶
type RMClient struct {
CreateRequestFunc func(string, map[string]interface{}) (string, error)
GetRequestFunc func(string) (proto.Request, error)
StartRequestFunc func(string) error
FinishRequestFunc func(string, byte) error
StopRequestFunc func(string) error
SuspendRequestFunc func(string, proto.SuspendedJobChain) error
RequestStatusFunc func(string) (proto.RequestStatus, error)
GetJobChainFunc func(string) (proto.JobChain, error)
GetJLFunc func(string) ([]proto.JobLog, error)
CreateJLFunc func(string, proto.JobLog) error
SysStatRunningFunc func() (proto.RunningStatus, error)
}
func (*RMClient) CreateRequest ¶
func (*RMClient) FinishRequest ¶
func (*RMClient) GetJobChain ¶
func (*RMClient) GetRequest ¶
func (*RMClient) RequestList ¶
func (c *RMClient) RequestList() ([]proto.RequestSpec, error)
func (*RMClient) RequestStatus ¶
func (c *RMClient) RequestStatus(requestId string) (proto.RequestStatus, error)
func (*RMClient) StartRequest ¶
func (*RMClient) StopRequest ¶
func (*RMClient) SuspendRequest ¶
func (c *RMClient) SuspendRequest(requestId string, sjc proto.SuspendedJobChain) error
func (*RMClient) SysStatRunning ¶
func (c *RMClient) SysStatRunning() (proto.RunningStatus, error)
type RMStatus ¶
type RMStatus struct {
RunningFunc func(status.Filter) (proto.RunningStatus, error)
}
type ReaperFactory ¶
type ReaperFactory struct {
RunFunc func()
StopFunc func()
FinalizeFunc func()
}
func (*ReaperFactory) Make ¶
func (rf *ReaperFactory) Make() chain.JobReaper
func (*ReaperFactory) MakeRunning ¶
func (rf *ReaperFactory) MakeRunning() chain.JobReaper
func (*ReaperFactory) MakeStopped ¶
func (rf *ReaperFactory) MakeStopped() chain.JobReaper
func (*ReaperFactory) MakeSuspended ¶
func (rf *ReaperFactory) MakeSuspended() chain.JobReaper
type RequestManager ¶
type RequestManager struct {
CreateFunc func(proto.CreateRequestParams) (proto.Request, error)
GetFunc func(string) (proto.Request, error)
StartFunc func(string) error
StopFunc func(string) error
FinishFunc func(string, proto.FinishRequestParams) error
StatusFunc func(string) (proto.RequestStatus, error)
IncrementFinishedJobsFunc func(string) error
SpecsFunc func() []proto.RequestSpec
JobChainFunc func(string) (proto.JobChain, error)
}
func (*RequestManager) Create ¶
func (r *RequestManager) Create(reqParams proto.CreateRequestParams) (proto.Request, error)
func (*RequestManager) Finish ¶
func (r *RequestManager) Finish(reqId string, finishParams proto.FinishRequestParams) error
func (*RequestManager) IncrementFinishedJobs ¶
func (r *RequestManager) IncrementFinishedJobs(reqId string) error
func (*RequestManager) JobChain ¶
func (r *RequestManager) JobChain(reqId string) (proto.JobChain, error)
func (*RequestManager) Specs ¶
func (r *RequestManager) Specs() []proto.RequestSpec
func (*RequestManager) Start ¶
func (r *RequestManager) Start(reqId string) error
func (*RequestManager) Status ¶
func (r *RequestManager) Status(reqId string) (proto.RequestStatus, error)
func (*RequestManager) Stop ¶
func (r *RequestManager) Stop(reqId string) error
type Runner ¶
type Runner struct {
RunReturn runner.Return
RunErr error
RunFunc func(jobData map[string]interface{}) byte // can use this instead of RunErr and RunFunc for more involved mocks
AddedJobData map[string]interface{} // Data to add to jobData.
RunWg *sync.WaitGroup // WaitGroup that gets released from when a runner starts running.
RunBlock chan struct{} // Channel that runner.Run() will block on, if defined.
IgnoreStop bool // false: return immediately after Stop, true: keep running after Stop
StatusResp string
// contains filtered or unexported fields
}
type RunnerFactory ¶
type Traverser ¶
type Traverser struct {
RunErr error
StopErr error
StatusResp proto.JobChainStatus
StatusErr error
}
type TraverserFactory ¶
type TraverserFactory struct {
MakeFunc func(proto.JobChain) (chain.Traverser, error)
MakeFromSJCFunc func(proto.SuspendedJobChain) (chain.Traverser, error)
}
func (*TraverserFactory) MakeFromSJC ¶
func (tf *TraverserFactory) MakeFromSJC(sjc proto.SuspendedJobChain) (chain.Traverser, error)
Click to show internal directories.
Click to hide internal directories.