WorkItemHandler(TItem) Delegate

WorkItemHandler TItem Delegate

TIBCO Spotfire 6.0 API Reference

Delegate for handling processed work items. The handler must call ReturnItem when it is finished with the work item.

Namespace: Spotfire.Dxp.Framework.Threading
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

public delegate void WorkItemHandler<TItem>(
	TItem workItem
)
where TItem : WorkItem

public delegate void WorkItemHandler<TItem>(
	TItem workItem
)
where TItem : WorkItem

Parameters

workItem: Type: TItem
Processed work item.

Type Parameters

TItem: Work item type.

Examples

The following example shows how ReturnItem can be used to synchronize with the application thread.

C++

Copy to Clipboard Print

WorkItemHandler<WorkItem> workItemHandler = 
    delegate(WorkItem workItem)
    {
        AnalysisServices.GetService<ApplicationThread>().InvokeAsynchronously(delegate()
        {
            try
            {
                if (workItem.IsResultValid && !workItem.IsCanceled)
                {
                    // do something to the document.
                }
            }
            finally
            {
                // Tell threading framework that your work item handler is done.
                workItem.ReturnItem();
            }

        });
     };

WorkItemHandler<WorkItem> workItemHandler = 
    delegate(WorkItem workItem)
    {
        AnalysisServices.GetService<ApplicationThread>().InvokeAsynchronously(delegate()
        {
            try
            {
                if (workItem.IsResultValid && !workItem.IsCanceled)
                {
                    // do something to the document.
                }
            }
            finally
            {
                // Tell threading framework that your work item handler is done.
                workItem.ReturnItem();
            }

        });
     };