The Sleuth Kit Framework  4.1
Public Member Functions | List of all members
TskSchedulerQueue Class Reference

Implementation of the Scheduler interface that keeps a local queue of tasks to run. More...

#include <TskSchedulerQueue.h>

Inheritance diagram for TskSchedulerQueue:
Scheduler

Public Member Functions

task_structnextTask ()
 Get the next task to process from the scheduler. More...
 
int schedule (Scheduler::TaskType task, uint64_t startId, uint64_t endId)
 Schedule a new task for the range of IDs. More...
 
- Public Member Functions inherited from Scheduler
int schedule (Scheduler::task_struct &task)
 Schedule a new task for a specific ID. More...
 

Additional Inherited Members

- Public Types inherited from Scheduler
enum  TaskType { Extract, Carve, FileAnalysis, Reporting }
 Types of tasks that can be scheduled or performed. More...
 

Detailed Description

Implementation of the Scheduler interface that keeps a local queue of tasks to run.

Can be used in a non-distributed environment.

Member Function Documentation

Scheduler::task_struct * TskSchedulerQueue::nextTask ( )
virtual

Get the next task to process from the scheduler.

Note that different scheduling systems have a pull versus push architecture. This method is for pulling designs and may return NULL in push designs (i.e. if the scheduler is a wrapper around another distributed system scheduler, then it may constantly push tasks to the system scheduler and this will always return NULL because everything has already been submitted).

Returns
Next task to run or NULL if there are none to process. Caller must free the object.

Implements Scheduler.

int TskSchedulerQueue::schedule ( Scheduler::TaskType  task,
uint64_t  startId,
uint64_t  endId 
)
virtual

Schedule a new task for the range of IDs.

Parameters
taskTask to schedule
startIdStarting ID of object to process
endIdEnding ID of object to process.
Returns
1 on error

Reimplemented from Scheduler.

References Scheduler::task_struct::id, and Scheduler::task_struct::task.


The documentation for this class was generated from the following files:

Copyright © 2011-2013 Brian Carrier. (carrier -at- sleuthkit -dot- org)
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.