Documentation
¶
Index ¶
- Constants
- Variables
- type Agent
- type ProfileType
- type RedactedTask
- type Task
- type TaskManager
- func (s *TaskManager) FindAndStallTaskForCaller(callerName string) (task *Task, err error)
- func (s *TaskManager) FindTask(id string) (t *Task, err error)
- func (s *TaskManager) GarbageCollectExpiredAgents(callerName string) (changeInfo *mgo.ChangeInfo, err error)
- func (s *TaskManager) NewTask(callerName string, profile ProfileType, status string) (t *Task)
- func (s *TaskManager) SaveTask(t *Task) (*Task, error)
- func (s *TaskManager) ScheduleTask(t *Task, expireTime time.Time)
- func (s *TaskManager) SubscribeToSchedule(callerName string) (subscription chan *Task)
- type TaskManagerInterface
Constants ¶
View Source
const ( //TaskAgentLongRunning -- TaskAgentLongRunning ProfileType = "agent_task_long_running" //TaskAgentScheduledTask -- TaskAgentScheduledTask ProfileType = "agent_scheduled_task" //TaskLeaseProcurement -- TaskLeaseProcurement ProfileType = "lease_procurement" //TaskLeaseReStock -- TaskLeaseReStock ProfileType = "lease_restock" //TaskInventoryLedger -- TaskInventoryLedger ProfileType = "inventory_ledger" //TaskLongPollQueue -- TaskLongPollQueue ProfileType = "longpoll_queue" //TaskChildID -- child task spawned from current task TaskChildID = "child_task_id" //TaskActionMetaName -- TaskActionMetaName = "task_action" //ExpiredTask - ExpiredTask int64 = 0 //TaskStatusAvailable --- task status is set to available TaskStatusAvailable = "available" //AgentTaskStatusInitializing --- AgentTaskStatusInitializing = "initializing" //AgentTaskStatusScheduled --- AgentTaskStatusScheduled = "scheduled" //AgentTaskStatusRunning --- AgentTaskStatusRunning = "running" //AgentTaskStatusComplete --- AgentTaskStatusComplete = "complete" //AgentTaskStatusFailed --- AgentTaskStatusFailed = "failed" )
Variables ¶
View Source
var ( //ErrNoResults - no results found in query ErrNoResults = errors.New("no results found") //AgentTaskPollerInterval - time offset to poll a task from an agent AgentTaskPollerInterval = time.Duration(30) * time.Second //AgentTaskPollerTimeout - time until a agent will expire its task if not polled AgentTaskPollerTimeout = time.Duration(5) * time.Minute )
Functions ¶
This section is empty.
Types ¶
type Agent ¶ added in v0.0.163
type Agent struct {
// contains filtered or unexported fields
}
Agent an object which knows how to handle long running tasks. polling, timeouts etc
func NewAgent ¶ added in v0.0.163
func NewAgent(t TaskManagerInterface, callerName string) *Agent
NewAgent -- creates a new initialized agent object
type ProfileType ¶
type ProfileType string
ProfileType - indicator of the purpose of the task to be performed
type RedactedTask ¶ added in v0.0.163
type RedactedTask struct {
ID bson.ObjectId `bson:"_id"`
Timestamp int64 `bson:"timestamp"`
Expires int64 `bson:"expires"`
Status string `bson:"status"`
Profile ProfileType `bson:"profile"`
CallerName string `bson:"caller_name"`
MetaData map[string]interface{} `bson:"metadata"`
}
RedactedTask - a task object without sensitive information
type Task ¶
type Task struct {
ID bson.ObjectId `bson:"_id"`
Timestamp int64 `bson:"timestamp"`
Expires int64 `bson:"expires"`
Status string `bson:"status"`
Profile ProfileType `bson:"profile"`
CallerName string `bson:"caller_name"`
MetaData map[string]interface{} `bson:"metadata"`
PrivateMetaData map[string]interface{} `bson:"private_metadata"`
}
Task - a task object
func (*Task) GetPrivateMeta ¶ added in v0.0.163
GetPrivateMeta - get a private meta record
func (*Task) GetPublicMeta ¶ added in v0.0.163
GetPublicMeta - get a public metadata record
func (*Task) GetRedactedVersion ¶ added in v0.0.163
func (s *Task) GetRedactedVersion() RedactedTask
GetRedactedVersion - returns a redacted version of this task, removing private info
func (*Task) SetPrivateMeta ¶ added in v0.0.163
SetPrivateMeta - set a private meta data record
func (*Task) SetPublicMeta ¶ added in v0.0.163
SetPublicMeta - set a public metadata record
type TaskManager ¶
type TaskManager struct {
// contains filtered or unexported fields
}
TaskManager - manages task interactions crud stuff
func NewTaskManager ¶
func NewTaskManager(taskCollection integrations.Collection) (tm *TaskManager)
NewTaskManager - this creates a new task manager object and returns it
func (*TaskManager) FindAndStallTaskForCaller ¶ added in v0.0.163
func (s *TaskManager) FindAndStallTaskForCaller(callerName string) (task *Task, err error)
FindAndStallTaskForCaller - find and lock the first matching task, then return it
func (*TaskManager) FindTask ¶
func (s *TaskManager) FindTask(id string) (t *Task, err error)
FindTask - this will find and return a task with a given ID
func (*TaskManager) GarbageCollectExpiredAgents ¶ added in v0.0.163
func (s *TaskManager) GarbageCollectExpiredAgents(callerName string) (changeInfo *mgo.ChangeInfo, err error)
func (*TaskManager) NewTask ¶
func (s *TaskManager) NewTask(callerName string, profile ProfileType, status string) (t *Task)
NewTask - get us a new empty task
func (*TaskManager) SaveTask ¶
func (s *TaskManager) SaveTask(t *Task) (*Task, error)
SaveTask - saves the given task
func (*TaskManager) ScheduleTask ¶ added in v0.0.163
func (s *TaskManager) ScheduleTask(t *Task, expireTime time.Time)
func (*TaskManager) SubscribeToSchedule ¶ added in v0.0.163
func (s *TaskManager) SubscribeToSchedule(callerName string) (subscription chan *Task)
SubscribeToSchedule - subscribe to a schedule and get a channel to listen on for a task when it hits its scheduled time
type TaskManagerInterface ¶ added in v0.0.163
type TaskManagerInterface interface {
NewTask(callerName string, profile ProfileType, status string) (t *Task)
FindTask(id string) (t *Task, err error)
FindAndStallTaskForCaller(callerName string) (task *Task, err error)
SaveTask(t *Task) (*Task, error)
ScheduleTask(t *Task, expireTime time.Time)
}
TaskManagerInterface ---
Source Files
Click to show internal directories.
Click to hide internal directories.