C# Class SIL.FieldWorks.FDO.Infrastructure.WorkerThreadReadHelper

This is a convenience class for beginning and ending read tasks on worker threads.
Inheritance: IFWDisposable
Show file Open project: sillsdev/FieldWorks

Public Methods

Method Description
CheckDisposed ( ) : void

This method throws an ObjectDisposedException if IsDisposed returns true. This is the case where a method or property in an object is being used but the object itself is no longer valid. This method should be added to all public properties and methods of this object and all other objects derived from it (extensive).
Dispose ( ) : void

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
WorkerThreadReadHelper ( IWorkerThreadReadHandler readHandler ) : System

Initializes a new instance of the WorkerThreadReadHelper class.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.

If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the underlying issue. If subclasses override this method, they should call the base implementation.

Method Details

CheckDisposed() public method

This method throws an ObjectDisposedException if IsDisposed returns true. This is the case where a method or property in an object is being used but the object itself is no longer valid. This method should be added to all public properties and methods of this object and all other objects derived from it (extensive).
public CheckDisposed ( ) : void
return void

Dispose() public method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public Dispose ( ) : void
return void

Dispose() protected method

Executes in two distinct scenarios. 1. If disposing is true, the method has been called directly or indirectly by a user's code via the Dispose method. Both managed and unmanaged resources can be disposed. 2. If disposing is false, the method has been called by the runtime from inside the finalizer and you should not reference (access) other managed objects, as they already have been garbage collected. Only unmanaged resources can be disposed.
If any exceptions are thrown, that is fine. If the method is being done in a finalizer, it will be ignored. If it is thrown by client code calling Dispose, it needs to be handled by fixing the underlying issue. If subclasses override this method, they should call the base implementation.
protected Dispose ( bool disposing ) : void
disposing bool
return void

WorkerThreadReadHelper() public method

Initializes a new instance of the WorkerThreadReadHelper class.
public WorkerThreadReadHelper ( IWorkerThreadReadHandler readHandler ) : System
readHandler IWorkerThreadReadHandler The read handler.
return System