DWFCore::DWFThreadPool::Controller Class Reference

#include "dwfcore/ThreadPool.h"

Inheritance diagram for DWFCore::DWFThreadPool::Controller:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFThreadPool::Controller:

Collaboration graph
[legend]
List of all members.

Detailed Description

This interface returned by thread pool for controlling a running pooled worker thread.

Since:
1.0.1
This interface is intended to provide access to the low-level thread library control functions. Thus, some methods may not be supported; so the returned state enumeration should always be evaluted to determine the result of the call. Further, no interaction is made directly with the DWFThreadWorker object - those requirements and behaviors may be filled in by the class specialization.
Examples:

Threads/Threads.cpp.

Definition at line 174 of file ThreadPool.h.

Public Member Functions

_DWFCORE_API ~Controller () throw ()
_DWFCORE_API void end () throw ( DWFException )
_DWFCORE_API DWFThread::teState suspend () throw ( DWFException )
_DWFCORE_API DWFThread::teState resume () throw ( DWFException )

Friends

class DWFThreadPool


Constructor & Destructor Documentation

_DWFCORE_API DWFCore::DWFThreadPool::Controller::~Controller  )  throw ()
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFCORE_API void DWFCore::DWFThreadPool::Controller::end  )  throw ( DWFException )
 

Attempts to end the thread in the most graceful manner possible, but will, as a last resort, forcibly terminate the thread potentially leaking resources and leaving the worker object in an unknown state.

Note:
This request is made on the thread itself, not the worker object.
Exceptions:
DWFException 
Examples:
Threads/Threads.cpp.

_DWFCORE_API DWFThread::teState DWFCore::DWFThreadPool::Controller::resume  )  throw ( DWFException )
 

Request the suspended worker thread to resume running. It will be possible to make a request that is not honored

Returns:
Returns the run state of the worker thread after attempting the resume operation.
Exceptions:
DWFException 

_DWFCORE_API DWFThread::teState DWFCore::DWFThreadPool::Controller::suspend  )  throw ( DWFException )
 

Request the running worker thread to suspend itself. It will be possible to make a request that is not honored.

Returns:
Returns the run state of the worker thread after attempting the suspend operation.
Exceptions:
DWFException 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:39:42 2009 for Autodesk DWF Core Library by  doxygen 1.4.5