Collapse All
ShellBrowser Delphi Components Documentation
ContentsIndexHome
PreviousUpNext
Jam.Threading.TDelayedProcedure
Jam.Threading  Legend  Members  Public Methods  ICancellationIndicator Methods  IWorkItem Properties

This work item helps to delay the call to a method. The method must not have paramters. The work item adds itself to the global thread pool of ShellBrowser. The metod will be called synchronized.

Class Hierarchy
Jam_Threading_TDelayedProcedureJam_Threading_TDelayedProcedureJam_Threading_TDelayedProcedureJam_Threading_TDelayedProcedureJam_Threading_TDelayedProcedure
Syntax
Pascal
TDelayedProcedure = class(TBasicWorkItem);
Namespace
Public Methods
Jam.Threading.TBasicWorkItem
 
Name 
Description 
 
constructor Create(pCancellationToken: ICancellationIndicator = nil; pOnWorkDone: TWorkDoneEvent = nil); 
Default constructor that creates an object instance of this class.  
Jam.Threading.TDelayedProcedure
 
Name 
Description 
 
constructor Create(pMethod: TThreadProcedure; pDelay: Integer = 300; pExecuteAsynchronous: Boolean = False; const pCancellationToken: ICancellationIndicator = nil); overload; 
Creates an instance of this object. 
ICancellationIndicator Methods
 
Name 
Description 
 
function IsCancellationRequested: Boolean; 
Gets whether cancellation has been requested for this token. 
Jam.Threading.ITerminatable
 
Name 
Description 
 
procedure Cancel; 
This method should terminate the work done by this item  
Jam.Threading.IWorkItem
 
Name 
Description 
 
function Classtype: TClass; 
Returns the class type of the workitem, Implemented automatically by TObject.Classtype.  
 
procedure DoWork; 
The method that actually does the work. This method should always be thread safe 
 
procedure Finished; overload; 
Is called by the TWorkerThreadPool after DoWork() has finished. 
 
function GetOnWorkDone: TWorkDoneEvent; 
Getter for the OnWorkDone event.  
 
function GetStatus: TTaskStatus; 
Returns the current status of the work item, like running or finished.  
 
function GetTag: NativeInt; 
Getter for the Tag property.  
 
procedure SetOnWorkDone(pEvent: TWorkDoneEvent); 
Setter for the OnWorkDone event.  
 
procedure SetStatus(pValue: TTaskStatus); 
Allows set the status of a worlk item and e.g. to pause it.  
 
procedure Wait; 
Waits until the workitem has finished its work and then returns. 
Jam.Threading.TDelayedProcedure
 
Name 
Description 
 
class function CreateAndQueue(pMethod: TThreadProcedure; const pCancellationToken: ICancellationIndicator): IWorkItem; overload; deprecated; 
Creates an instance of this object and adds it to the global thread pool. 
 
class function CreateAndQueue(pMethod: TThreadProcedure; pDelay: Integer = 300; pExecuteAsynchronous: Boolean = False; const pCancellationToken: ICancellationIndicator = nil): IWorkItem; overload; 
Creates an instance of this object and adds it to the global thread pool. 
IWorkItem Properties
Jam.Threading.IWorkItem
 
Name 
Description 
 
property OnWorkDone: TWorkDoneEvent read GetOnWorkDone write SetOnWorkDone; 
This event is fired synchronized when the work of the work item is finished 
 
property Tag: NativeInt read GetTag; 
A tag that can be freely used to identify a workitem or store custom data. 
Links
Contents | Index | Home