Collapse All
ShellBrowser Delphi Components Documentation
ContentsIndexHome
PreviousUpNext
Jam.Threading.TFutureWithParam
Jam.Threading  Legend  Members  Public Methods  IFuture Methods  IFuture Properties
Class Hierarchy
Jam_Threading_TFutureWithParamJam_Threading_TFutureWithParamJam_Threading_TFutureWithParamJam_Threading_TFutureWithParamJam_Threading_TFutureWithParamJam_Threading_TFutureWithParamJam_Threading_TFutureWithParam
Syntax
Pascal
TFutureWithParam<TResult, TParamType> = class(TFuture<TResult>, IFuture<TResult>);
Description

A TFuture, that allows to add a procedure that will be executed synchronously after the workitem has finished. A second generic parameter can be used to pass an object through to the WorkDone procedure.

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.  
IFuture Methods
 
Name 
Description 
 
function GetStatus: TTaskStatus; 
Getter for the Status property.  
 
function GetValue: TResult; 
Returns the result.  
 
function TryGetValue(pTimeout: UInt64; out pValue: TResult): TTaskStatus; 
Tries to access the result and waits for completion a certain time.  
Jam.Threading.ICancellationIndicator
 
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.TFuture
 
Name 
Description 
 
class function Construct(pFunction: TFunc<TResult>; const pCancellationIndicator: ICancellationIndicator = nil): IFuture<TResult>; 
Creates an instance of this class and adds it to the global worker pool.  
 
class function CreateAndQueue(pFunction: TFunc<TResult>; const pCancellationIndicator: ICancellationIndicator = nil): IFuture<TResult>; overload; 
Creates an instance of this class and adds it to the global worker pool.  
Jam.Threading.TFutureWithParam
 
Name 
Description 
 
class function CreateAndQueue(pFunction: TFunc<TParamType, TResult>; const pParam: TParamType; const pCancellationIndicator: ICancellationIndicator = nil; const pWorkDone: TProc<TParamType, TResult> = nil): IFuture<TResult>; overload; 
Creates an instance of this class and adds it to the global worker thread pool.  
IFuture Properties
 
Name 
Description 
 
property Status: TTaskStatus read GetStatus; 
Returns that status of the future, test against TTaskStatus.Completed to check if a valid vlaue is available. 
 
property Value: TResult read GetValue; 
Gives access to the result and waits until it is ready. 
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