Version 24.2 (latest)

AsyncVirtualDataSourceProviderWorker Class Methods

For a list of all members of this type, see AsyncVirtualDataSourceProviderWorker members.

Public Methods
 NameDescription
Public MethodAddPageRequestAdds a new page request to the worker.  
Public MethodAddPageRequestWithRetryAdds a page request with the specified retry delay.  
Public MethodCreateBatchRequestCreate a batch request with the provided changes.  
Public MethodRemoveAllPageRequestsRemoves all pending or active page requests from the worker.  
Public MethodRemovePageRequestRemoves a page request with the specifiec index from the worker.  
Public MethodShutdownCauses the worker to shut down its operation. Worker should not be reused once entered into this state.  
Protected Methods
 NameDescription
Protected MethodAwaitChangesCalled by the worker to perform a timed wait for changes to occur.  
Protected MethodCheckAndPotentiallyWaitOnTasksChecks the status of the current tasks, and if possible, yields until changes occur to the active tasks or the worker settings.  
Protected MethodDoWorkThe main loop for the worker.  
Protected MethodGetCompletedTaskDataPopulates the implementation specific data for the specified completed task.  
Protected MethodGetTaskDataHolderOverride to provide the implementation specific data holder for the tasks.  
Protected MethodGetTasksDataOverride to populate the implementation specific data for the tasks.  
Protected MethodInitializeCalled when the worker is initializing itself before starting the work loop. Override to add additional initialization before the work loop starts.  
Protected MethodIsLastPageReturns true if the provided index represents the last page of the data.  
Protected MethodMakeTaskForRequestOrverride to specify how a task gets constructed for a request.  
Protected MethodProcessCompletedTaskOverride to specify how a completed task is handled. This should call the PageLoaded callback, synchronizing with the ExecutionContext, if a page has been successfully loaded.  
Protected MethodRemoveCompletedTaskDataOverride to specify how implementation specific data gets removed for a completed task.  
Protected MethodRetryIndexRetries a request with the requested delay.  
Protected MethodSignalChangesOcurredCalled to indicate that something changed that should immediately wake the worker to further process the active requests.  
See Also