SourcePro 11.1
SourcePro® C++ API Reference Guide
SourcePro C++
Documentation Home
SourcePro 11.1 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Handle class for a threaded runnable object. More...
#include <rw/thread/RWThread.h>
The RWThread class is a handle class for a threaded runnable object.
A threaded runnable object provides the basic mechanisms used to create, control, and monitor the threads of execution within your application. Threaded runnables create their own thread to perform some task or activity.
Each threaded runnable object is reference-counted; a threaded runnable body instance keeps a count of the number of handles that currently reference it. A runnable object is deleted when the last handle that references the body is deleted.
The public interface for a threaded runnable is provided by its handle classes. Many of the public functions in a handle simply forward control to a corresponding protected function in the body class. A threaded runnable handle class instance may be empty. Any attempt to use an empty handle to access a threaded runnable will produce an RWTHRInvalidPointer exception
The RWThread class provides an interface for threads executing outside of a threaded runnable. It defines the member functions that may only be executed by an external thread. The threads executing inside of a threaded runnable should access the runnable using the RWThreadSelf handle class. Those functions that can be accessed from either inside or outside of a threaded runnable are defined in both handle classes.
You may also convert an RWThreadSelf handle to an RWThread handle by calling the RWThreadSelf::getRWThread() member, but any attempt to violate the thread access restrictions imposed by the separate interfaces will generally result in an RWTHRIllegalAccess exception.
| RWThread::RWThread | ( | ) | [inline] |
| RWThread::RWThread | ( | RWStaticCtor | ) | [inline] |
This constructor allows you to create a global static RWThread handle object that may be assigned to before it is constructed. This constructor does not change the static instance.
| RWThread::RWThread | ( | const RWThread & | second | ) | [inline] |
Copy constructor. Creates an RWThread object and binds it to the same threaded runnable, if any, pointed-to by second.
| RWThread::~RWThread | ( | ) | [inline] |
Destructor.
| RWThread::RWThread | ( | RWThreadImp * | threadImpP | ) | [protected] |
Associates a new thread with self.
| RWThreadImp& RWThread::body | ( | void | ) | const [protected] |
Gets a reference for the body instance, if any.
| RWTHRInvalidPointer | Thrown if this handle is not attached to a body. |
Reimplemented from RWRunnableHandle.
Reimplemented in RWRunnableServer, RWServerPool, and RWThreadFunction.
| static bool RWThread::canGetMaxThreads | ( | ) | [static] |
Returns true if the getMaxThreads() function is supported in the current environment, false if not.
| bool RWThread::canGetPriority | ( | ) | const |
Returns true if the priority attribute is supported in the current environment and if the getPriority() function can return a legal value under the current circumstances. For example, canGetPriority() will return true only if RW_THR_HAS_PRIORITY is defined and calling functions such as getPriority() and getMaxPriority() can return a legal value under the current circumstances. Possible exceptions include RWTHRInvalidPointer and RWTHRInternalError.
| bool RWThread::canGetProcessScopePriority | ( | ) | const |
Returns true if the process-scope priority attribute is supported in the current environment and if the getProcessScopePriority() function can return a legal value under the current circumstances. Possible exceptions include RWTHRInvalidPointer and RWTHRInternalError.
| bool RWThread::canGetSchedulingPolicy | ( | ) | const |
Returns true if the scheduling policy attribute is supported in the current environment and if the getSchedulingPolicy() function can return a legal value under the current circumstances. Possible exceptions include RWTHRInvalidPointer and RWTHRInternalError.
| bool RWThread::canGetSystemScopePriority | ( | ) | const |
Returns true if the system-scope priority attribute is supported in the current environment and if the getSystemScopePriority() function can return a legal value under the current circumstances. Possible exceptions include RWTHRInvalidPointer and RWTHRInternalError.
| bool RWThread::canGetTimeSliceQuantum | ( | ) | const |
Returns true if the time-slice quantum attribute is supported in the current environment and if the getTimeSliceQuantum() function can return a legal value under the current circumstances. Possible exceptions include RWTHRInvalidPointer and RWTHRInternalError.
| bool RWThread::canSetPriority | ( | ) | const |
Each of these functions returns true if the corresponding attribute is supported in the current environment and if the corresponding "set" function is callable under the current circumstances. For example, canSetPriority() will return true only if RW_THR_HAS_PRIORITY is defined and calling setPriority() is supported under the current options. In addition, the function will only return true if both the calling thread and process have sufficient privileges to perform the requested operation.
All of these functions can throw exceptions RWTHRInvalidPointer and RWTHRInternalError. In addition, canSetSchedulingPolicy() can throw RWTHRBoundsError.
| bool RWThread::canSetProcessScopePriority | ( | ) | const |
Each of these functions returns true if the corresponding attribute is supported in the current environment and if the corresponding "set" function is callable under the current circumstances. For example, canSetPriority() will return true only if RW_THR_HAS_PRIORITY is defined and calling setPriority() is supported under the current options. In addition, the function will only return true if both the calling thread and process have sufficient privileges to perform the requested operation.All of these functions can throw exceptions RWTHRInvalidPointer and RWTHRInternalError. In addition, canSetSchedulingPolicy() can throw RWTHRBoundsError.
| bool RWThread::canSetSchedulingPolicy | ( | RWSchedulingPolicy | policy | ) | const |
Each of these functions returns true if the corresponding attribute is supported in the current environment and if the corresponding "set" function is callable under the current circumstances. For example, canSetPriority() will return true only if RW_THR_HAS_PRIORITY is defined and calling setPriority() is supported under the current options. In addition, the function will only return true if both the calling thread and process have sufficient privileges to perform the requested operation.All of these functions can throw exceptions RWTHRInvalidPointer and RWTHRInternalError. In addition, canSetSchedulingPolicy() can throw RWTHRBoundsError.
| bool RWThread::canSetSystemScopePriority | ( | ) | const |
Each of these functions returns true if the corresponding attribute is supported in the current environment and if the corresponding "set" function is callable under the current circumstances. For example, canSetPriority() will return true only if RW_THR_HAS_PRIORITY is defined and calling setPriority() is supported under the current options. In addition, the function will only return true if both the calling thread and process have sufficient privileges to perform the requested operation.All of these functions can throw exceptions RWTHRInvalidPointer and RWTHRInternalError. In addition, canSetSchedulingPolicy() can throw RWTHRBoundsError.
| bool RWThread::canSetTimeSliceQuantum | ( | ) | const |
Each of these functions returns true if the corresponding attribute is supported in the current environment and if the corresponding "set" function is callable under the current circumstances. For example, canSetPriority() will return true only if RW_THR_HAS_PRIORITY is defined and calling setPriority() is supported under the current options. In addition, the function will only return true if both the calling thread and process have sufficient privileges to perform the requested operation.All of these functions can throw exceptions RWTHRInvalidPointer and RWTHRInternalError. In addition, canSetSchedulingPolicy() can throw RWTHRBoundsError.
| static bool RWThread::canSuspendResume | ( | ) | [static] |
| RWThreadAttribute RWThread::getActiveAttribute | ( | ) | const |
Returns a handle to the thread attribute instance used to initialize the most recently created thread. If a thread has not yet been created, this function will simply return a copy of a default thread attribute instance. Possible exceptions include RWTHRInvalidPointer and RWTHRInternalError.
| RWThreadAttribute RWThread::getAttribute | ( | ) | const |
Returns a handle to the thread attribute object that will be used to initialize any threads created by future calls to start(). Use getActiveAttribute() to get a copy of the attribute instance actually used to initialize the most recently started thread. Possible exceptions include RWTHRInvalidPointer and RWTHRInternalError.
| RWPriority RWThread::getMaxPriority | ( | ) | const |
Returns the maximum priority value that may be specified for this thread. At runtime use canGetPriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| RWPriority RWThread::getMaxProcessScopePriority | ( | ) | const |
Returns the maximum process-scope priority value that may be specified for this thread. At runtime use canGetProcessScopePriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_PROCESS_SCOPE_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| RWPriority RWThread::getMaxSystemScopePriority | ( | ) | const |
Returns the maximum system-scope priority value that may be specified for this thread. At runtime use canGetSystemScopePriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_SYSTEM_SCOPE_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| static size_t RWThread::getMaxThreads | ( | ) | [static] |
Returns the maximum number of threads that may be created in this environment. This function is not supported in all environments. At runtime use canGetMaxThreads() to determine whether this feature is available. At compile time check to see if RW_THR_HAS_MAX_THREADS is defined. Possible exceptions include RWTHROperationNotSupported.
| unsigned long RWThread::getMaxTimeSliceQuantum | ( | ) | const |
Returns the maximum time-slice quantum value that may be specified for this thread. At runtime use canGetTimeSliceQuantum() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_TIME_SLICE_QUANTUM is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| RWPriority RWThread::getMinPriority | ( | ) | const |
Returns the minimum priority value that may be specified for this thread. At runtime use canGetPriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| RWPriority RWThread::getMinProcessScopePriority | ( | ) | const |
Returns the minimum process-scope priority value that may be specified for this thread. At runtime use canGetProcessScopePriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_PROCESS_SCOPE_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| RWPriority RWThread::getMinSystemScopePriority | ( | ) | const |
Returns the minimum system-scope priority value that may be specified for this thread. At runtime use canGetSystemScopePriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_SYSTEM_SCOPE_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| unsigned long RWThread::getMinTimeSliceQuantum | ( | ) | const |
Returns the minimum time-slice quantum value that may be specified for this thread. At runtime use canGetTimeSliceQuantum() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_TIME_SLICE_QUANTUM is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| RWPriority RWThread::getPriority | ( | ) | const |
Returns the current priority for the active thread associated with self. At runtime use canGetPriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHRThreadNotActive, and RWTHRInternalError.
| RWPriority RWThread::getProcessScopePriority | ( | ) | const |
Returns the current process-scope priority for the active thread associated with self. At runtime use canGetProcessScopePriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_PROCESS_SCOPE_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| RWThreadSelf RWThread::getRWThreadSelf | ( | ) | const |
Returns an internal thread interface associated with the same thread, if any, associated with self.
| RWSchedulingPolicy RWThread::getSchedulingPolicy | ( | ) | const |
Returns the current scheduling policy for the active thread associated with self. At runtime use canGetSchedulingPolicy() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_SCHEDULING_POLICY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHRThreadNotActive, and RWTHRInternalError.
| unsigned RWThread::getSuspendCount | ( | ) | const |
Returns the number of times this thread has been suspended without being released. A return value of zero indicates that the thread is not currently suspended. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, and RWTHRInternalError.
| RWPriority RWThread::getSystemScopePriority | ( | ) | const |
Returns the current system-scope priority for the active thread associated with self. At runtime use canGetSystemScopePriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_SYSTEM_SCOPE_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
| unsigned long RWThread::getTimeSliceQuantum | ( | ) | const |
Returns the current time-slice quantum value for the active thread associated with self. At runtime use canGetTimeSliceQuantum() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_TIME_SLICE_QUANTUM is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, and RWTHRInternalError.
Assignment operator. Binds the handle to the same threaded runnable, if any, pointed-to by second.
| unsigned RWThread::resume | ( | ) |
Resumes this thread after it has been suspended. At runtime use canSuspendResume() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_SUSPEND_RESUME is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHRIllegalAccess, RWTHRThreadNotActive, and RWTHRInternalError.
| void RWThread::setAttribute | ( | const RWThreadAttribute & | second | ) |
Replaces the thread attribute instance that will be used to initialize any threads created by future calls to start(). Changing a thread's attribute object after the thread has been started will not affect its current thread. Possible exceptions include RWTHRInvalidPointer and RWTHRInternalError.
| void RWThread::setPriority | ( | RWPriority | priority | ) |
Changes the priority of thread associated with self. At runtime use canSetPriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, RWTHRBoundsError, RWTHRResourceLimit, and RWTHRInternalError.
| void RWThread::setProcessScopePriority | ( | RWPriority | priority | ) |
Changes the process-scope priority of the thread associated with self. At runtime use canSetProcessScopePriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_PROCESS_SCOPE_PRIORITY is defined.
Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, RWTHRBoundsError, RWTHRResourceLimit, and RWTHRInternalError.
| void RWThread::setSchedulingPolicy | ( | RWSchedulingPolicy | policy | ) |
Changes the scheduling policy of the thread associated with self. At runtime use canSetSchedulingPolicy(policy) to determine the availability of this feature. At compile time check to see if RW_THR_HAS_SCHEDULING_POLICY is defined.
Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, RWTHRBoundsError, RWTHRResourceLimit, and RWTHRInternalError.
| void RWThread::setSystemScopePriority | ( | RWPriority | priority | ) |
Changes the system-scope priority of the thread associated with self. At runtime use canSetSystemScopePriority() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_SYSTEM_SCOPE_PRIORITY is defined. Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, RWTHRBoundsError, RWTHRResourceLimit, and RWTHRInternalError.
| void RWThread::setTimeSliceQuantum | ( | unsigned long | milliseconds | ) |
Changes the time-slice quantum value of the thread associated with self. At runtime use canSetTimeSliceQuantum() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_TIME_SLICE_QUANTUM is defined.
Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHROperationNotAvailable, RWTHRThreadNotActive, RWTHRBoundsError, and RWTHRInternalError.
| unsigned RWThread::suspend | ( | ) |
Suspends the execution of the thread associated with self until a matching resume() operation is performed. Caution: Use of this function may produce unexpected deadlock (see the User's Guide for more information). For deadlock-safe suspension use requestInterrupt() and serviceInterrupt() instead.
At runtime use canSuspendResume() to determine the availability of this feature. At compile time check to see if RW_THR_HAS_SUSPEND_RESUME is defined.
Possible exceptions include RWTHRInvalidPointer, RWTHROperationNotSupported, RWTHRThreadNotActive, and RWTHRInternalError.
| void RWThread::terminate | ( | ) |
Terminates execution of this thread. Possible exceptions include RWTHRInvalidPointer, RWTHRIllegalAccess, RWTHRThreadNotActive, RWTHRThreadActive, and RWTHRInternalError.
© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.