SourcePro® API Reference Guide

 
Classes | Macros
Thread-compatible Exceptions

Module Description

The Thread-compatible Exceptions package includes a simple framework for handling exceptions at their point of occurrence and returning a string for display on a GUI or for logging to a file.

This package provides a set of exception classes especially for multithreaded programming. Most of the exceptions produce default error messages, though they can contain other messages, depending on how they are created.

See the Threads Module User's Guide for more information on the Thread-compatible Exceptions package.

Classes

class  RWTHRBoundsError
 Exception thrown when a specified value is invalid or outside the current legal range. More...
 
class  RWTHRExternalError
 Exception thrown for errors caused by external sources over which the library has no control. More...
 
class  RWTHRIllegalAccess
 Exception thrown when an external or internal thread attempts to use a thread object member to which it lacks access. More...
 
class  RWTHRIllegalUsage
 Exception thrown when a thread attempts to access a function, method, or value for which it lacks access. More...
 
class  RWTHRInternalError
 Exception thrown to report errors that occur within the Threads Module. More...
 
class  RWTHRInvalidPointer
 Exception thrown by pointer classes for attempts to deference a pointer that is not pointing to anything. More...
 
class  RWTHROperationAborted
 Exception thrown when a requested operation, or its associated object, has been aborted. More...
 
class  RWTHROperationCanceled
 Exception thrown when an operation is attempted on a canceled thread. More...
 
class  RWTHROperationNotAvailable
 Exception thrown if an operation or attribute is not available in the current environment. More...
 
class  RWTHROperationNotImplemented
 Exception thrown when the requested operation has not been implemented. More...
 
class  RWTHROperationNotSupported
 Exception thrown if the operation or attribute is not supported in the current environment. More...
 
class  RWTHROperationTerminated
 Exception thrown when an operation or its associated object has been terminated. More...
 
class  RWTHRPermissionError
 Exception thrown when the caller does not have appropriate permissions. More...
 
class  RWTHRResourceLimit
 Exception thrown when an operation cannot be performed due to memory or system resource constraints. More...
 
class  RWTHRThreadActive
 Exception thrown when an attempt is made to start, resume, or release an active runnable or thread. More...
 
class  RWTHRThreadNotActive
 Exception thrown by thread object members that require an active thread when none exists. More...
 
class  RWTHRxmsg
 Base class for thread-compatible exceptions. More...
 
class  RWTTHRCompatibleException< Exception >
 Template class for creating a thread-compatible exception from an existing exception class. More...
 

Macros

#define RW_THR_DECLARE_EXCEPTION(Name)
 
#define RW_THR_DECLARE_INLINE_EXCEPTION(Name)
 
#define RW_THR_IMPLEMENT_EXCEPTION(Name)
 
#define RW_THR_IMPLEMENT_TRACEABLE_EXCEPTION(Name)
 

Macro Definition Documentation

#define RW_THR_DECLARE_EXCEPTION (   Name)

Declares the functions necessary to pass RWTHRxmsg-derived exception objects across thread boundaries. This macro must be placed inside your class declaration.

#define RW_THR_DECLARE_INLINE_EXCEPTION (   Name)

Similar to RW_THR_DECLARE_EXCEPTION, instead declaring and defining the necessary functions inline. Do not use either of RW_THR_IMPLEMENT_EXCEPTION or RW_THR_IMPLEMENT_TRACEABLE_EXCEPTION macros if you use this macro.

#define RW_THR_IMPLEMENT_EXCEPTION (   Name)

Defines the functions necessary to pass RWTHRxmsg-derived exception objects across thread boundaries.

#define RW_THR_IMPLEMENT_TRACEABLE_EXCEPTION (   Name)

Defines the functions necessary to pass RWTHRxmsg-derived exception objects across thread boundaries. It is intended to be used for classes that provide tracing support.

Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.