com.esri.arcgis.addinframework
Interface IThreadPool

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IThreadPoolProxy

public interface IThreadPool
extends java.io.Serializable

COM Interface 'IThreadPool'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\SharedArcGIS\DepFiles\com\DADF\esriDADFSystem.tlb'

Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID132a89fa_e356_48d2_a926_44282c91e071
static int	xxDummy Deprecated. Internal use only

Method Summary

IRequest	beginExecute(int data) Asynchronously executes a user defined worker on any available thread.
void	beginExecuteForEach(int data) Executes a request on all workers in the pool.
void	cancelAll() Cancels all pending requests.
void	compact() Frees unutilized threads in the pool.
IWorkerThread	createThread() Allocates a worker thread for dedicated use outside of the pool.
void	destroy() Destroys the thread pool.
IRequest	execute(int data, int timeout) Synchronously executes a user defined worker on any available thread.
void	executeForEach(int data, int timeout) Executes a request on all workers in the pool, then waits for all to complete.
void	getSize(int[] size) Returns the current size of the pool (thread count).
void	waitAll(int timeout) Waits for all pending requests to complete (or cancel).

Field Detail

IID132a89fa_e356_48d2_a926_44282c91e071

static final int IID132a89fa_e356_48d2_a926_44282c91e071

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

execute

IRequest execute(int data,
                 int timeout)
                 throws java.io.IOException,
                        AutomationException

Synchronously executes a user defined worker on any available thread. Returns S_FALSE if request times out.

Parameters:

data - The data (A COM typedef) (in)

timeout - The timeout (in)

Returns:

A reference to a com.esri.arcgis.addinframework.IRequest

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

executeForEach

void executeForEach(int data,
                    int timeout)
                    throws java.io.IOException,
                           AutomationException

Executes a request on all workers in the pool, then waits for all to complete. Returns S_FALSE if request timesout.

Parameters:

data - The data (A COM typedef) (in)

timeout - The timeout (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginExecute

IRequest beginExecute(int data)
                      throws java.io.IOException,
                             AutomationException

Asynchronously executes a user defined worker on any available thread.

Parameters:

data - The data (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.addinframework.IRequest

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createThread

IWorkerThread createThread()
                           throws java.io.IOException,
                                  AutomationException

Allocates a worker thread for dedicated use outside of the pool.

Returns:

A reference to a com.esri.arcgis.addinframework.IWorkerThread

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

waitAll

void waitAll(int timeout)
             throws java.io.IOException,
                    AutomationException

Waits for all pending requests to complete (or cancel).

Parameters:

timeout - The timeout (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancelAll

void cancelAll()
               throws java.io.IOException,
                      AutomationException

Cancels all pending requests.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSize

void getSize(int[] size)
             throws java.io.IOException,
                    AutomationException

Returns the current size of the pool (thread count).

Parameters:

size - The size (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compact

void compact()
             throws java.io.IOException,
                    AutomationException

Frees unutilized threads in the pool.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

destroy

void destroy()
             throws java.io.IOException,
                    AutomationException

Destroys the thread pool.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginExecuteForEach

void beginExecuteForEach(int data)
                         throws java.io.IOException,
                                AutomationException

Executes a request on all workers in the pool.

Parameters:

data - The data (A COM typedef) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.