com.esri.arcgis.addinframework
Interface IWorkerThread

All Superinterfaces:

Serializable

All Known Implementing Classes:

IWorkerThreadProxy

public interface IWorkerThread
extends Serializable

Method Summary

IRequest	beginExecute(int data) Asynchronously executes a user defined worker.
void	cancelAll() Cancels all requests queued to this thread.
void	destroy() Destroys the worker thread.
IRequest	execute(int data, int timeout) Synchronously executes a user defined worker.
void	getBusy() Returns S_OK if busy, S_FALSE if not busy.
int	getThreadID() Returns the worker's thread ID.

Method Detail

execute

IRequest execute(int data,
                 int timeout)
                 throws IOException,
                        AutomationException

Synchronously executes a user defined worker. Return S_FALSE if request timesout.

Parameters:

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

timeout - The timeout (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginExecute

IRequest beginExecute(int data)
                      throws IOException,
                             AutomationException

Asynchronously executes a user defined worker.

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancelAll

void cancelAll()
               throws IOException,
                      AutomationException

Cancels all requests queued to this thread.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBusy

void getBusy()
             throws IOException,
                    AutomationException

Returns S_OK if busy, S_FALSE if not busy.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThreadID

int getThreadID()
                throws IOException,
                       AutomationException

Returns the worker's thread ID.

Returns:

The pThreadID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

destroy

void destroy()
             throws IOException,
                    AutomationException

Destroys the worker thread.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.