RtError Class Reference

Exception handling class for RtAudio. More...

#include <RtAudio.hxx>

Public Types
enum	TYPE { WARNING, DEBUG_WARNING, UNSPECIFIED, NO_DEVICES_FOUND, INVALID_DEVICE, INVALID_STREAM, MEMORY_ERROR, INVALID_PARAMETER, DRIVER_ERROR, SYSTEM_ERROR, THREAD_ERROR }
	Defined RtError types. More...
Public Member Functions
	RtError (const char *p, TYPE tipe=RtError::UNSPECIFIED)
	The constructor.
virtual	~RtError (void)
	The destructor.
virtual void	printMessage (void)
	Prints "thrown" error message to stdout.
virtual const TYPE &	getType (void)
	Returns the "thrown" error message TYPE.
virtual const char *	getMessage (void)
	Returns the "thrown" error message string.
Protected Attributes
char	error_message [256]
TYPE	type

Detailed Description

Exception handling class for RtAudio.

The RtError class is quite simple but it does allow errors to be "caught" by RtError::TYPE. Almost all RtAudio methods can "throw" an RtError, most typically if an invalid stream identifier is supplied to a method or a driver error occurs. There are a number of cases within RtAudio where warning messages may be displayed but an exception is not thrown. There is a private RtAudio method, error(), which can be modified to globally control how these messages are handled and reported.

Definition at line 153 of file RtAudio.hxx.

Member Enumeration Documentation

enum RtError::TYPE

Defined RtError types.

Enumerator:

WARNING
DEBUG_WARNING
UNSPECIFIED
NO_DEVICES_FOUND
INVALID_DEVICE
INVALID_STREAM
MEMORY_ERROR
INVALID_PARAMETER
DRIVER_ERROR
SYSTEM_ERROR
THREAD_ERROR