summaryrefslogtreecommitdiff
path: root/doc/html/classRtError.html
diff options
context:
space:
mode:
authorGary Scavone <gary@music.mcgill.ca>2013-10-10 23:57:51 +0200
committerStephen Sinclair <sinclair@music.mcgill.ca>2013-10-10 23:57:51 +0200
commitf58f7c5aafe9b52acf26fad31ac2c01c6a184fbc (patch)
treee6a95e6bce9138be23bffd52c6e9e742b863f73e /doc/html/classRtError.html
parent71d678163c1a267fd006dbddf5f7ff42a5986366 (diff)
Release 2.1 tarball2.1
Diffstat (limited to 'doc/html/classRtError.html')
-rw-r--r--doc/html/classRtError.html370
1 files changed, 50 insertions, 320 deletions
diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html
index 1f59ff7..b81582a 100644
--- a/doc/html/classRtError.html
+++ b/doc/html/classRtError.html
@@ -1,337 +1,67 @@
-<HTML>
-<HEAD>
-<TITLE>The RtAudio Tutorial</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<a class="qindex" href="index.html">Tutorial</a> &nbsp; <a class="qindex" href="annotated.html">Class/Enum List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </CENTER>
+<HTML>
+<HEAD>
+<TITLE>The RtAudio Tutorial</TITLE>
+<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
+</HEAD>
+<BODY BGCOLOR="#FFFFFF">
+<CENTER>
+<a class="qindex" href="index.html">Tutorial</a> &nbsp; <a class="qindex" href="annotated.html">Class/Enum List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>RtError Class Reference</h1><code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
+<h1>RtError Class Reference</h1>Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a>.
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
<p>
<a href="classRtError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#s11">TYPE</a> { <br>
-&nbsp;&nbsp;<a class="el" href="classRtError.html#s11s0">WARNING</a>,
-<a class="el" href="classRtError.html#s11s1">DEBUG_WARNING</a>,
-<a class="el" href="classRtError.html#s11s2">UNSPECIFIED</a>,
-<a class="el" href="classRtError.html#s11s3">NO_DEVICES_FOUND</a>,
+&nbsp;&nbsp;<b>WARNING</b>,
+<b>DEBUG_WARNING</b>,
+<b>UNSPECIFIED</b>,
+<b>NO_DEVICES_FOUND</b>,
<br>
-&nbsp;&nbsp;<a class="el" href="classRtError.html#s11s4">INVALID_DEVICE</a>,
-<a class="el" href="classRtError.html#s11s5">INVALID_STREAM</a>,
-<a class="el" href="classRtError.html#s11s6">MEMORY_ERROR</a>,
-<a class="el" href="classRtError.html#s11s7">INVALID_PARAMETER</a>,
+&nbsp;&nbsp;<b>INVALID_DEVICE</b>,
+<b>INVALID_STREAM</b>,
+<b>MEMORY_ERROR</b>,
+<b>INVALID_PARAMETER</b>,
<br>
-&nbsp;&nbsp;<a class="el" href="classRtError.html#s11s8">DRIVER_ERROR</a>,
-<a class="el" href="classRtError.html#s11s9">SYSTEM_ERROR</a>,
-<a class="el" href="classRtError.html#s11s10">THREAD_ERROR</a>
+&nbsp;&nbsp;<b>DRIVER_ERROR</b>,
+<b>SYSTEM_ERROR</b>,
+<b>THREAD_ERROR</b>
<br>
}</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Defined RtError types.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
-<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a0">RtError</a> (const char *p, <a class="el" href="classRtError.html#s11">TYPE</a> tipe=RtError::UNSPECIFIED)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>The constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>The destructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Prints "thrown" error message to stdout.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classRtError.html#s11">TYPE</a>&amp;&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message TYPE.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
-<tr><td nowrap align=right valign=top>virtual const char*&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr>
-<tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message string.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
-<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
-<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#n0">error_message</a> [256]</td></tr>
-<tr><td nowrap align=right valign=top><a class="el" href="classRtError.html#s11">TYPE</a>&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#n1">type</a></td></tr>
-</table>
-<hr><h2>Member Enumeration Documentation</h2>
-<a name="s11" doxytag="RtError::TYPE"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
- <tr>
- <td class="md">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td nowrap valign="top"><b>
-enum RtError::TYPE
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-<dl compact><dt>
-<b>Enumeration values:</b><dd>
-<table border=0 cellspacing=2 cellpadding=0>
-<tr><td valign=top><a name="s11s0" doxytag="WARNING"></a><em>WARNING</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s1" doxytag="DEBUG_WARNING"></a><em>DEBUG_WARNING</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s2" doxytag="UNSPECIFIED"></a><em>UNSPECIFIED</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s3" doxytag="NO_DEVICES_FOUND"></a><em>NO_DEVICES_FOUND</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s4" doxytag="INVALID_DEVICE"></a><em>INVALID_DEVICE</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s5" doxytag="INVALID_STREAM"></a><em>INVALID_STREAM</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s6" doxytag="MEMORY_ERROR"></a><em>MEMORY_ERROR</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s7" doxytag="INVALID_PARAMETER"></a><em>INVALID_PARAMETER</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s8" doxytag="DRIVER_ERROR"></a><em>DRIVER_ERROR</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s9" doxytag="SYSTEM_ERROR"></a><em>SYSTEM_ERROR</em>
-&nbsp;</td><td>
-</td></tr>
-<tr><td valign=top><a name="s11s10" doxytag="THREAD_ERROR"></a><em>THREAD_ERROR</em>
-&nbsp;</td><td>
-</td></tr>
-</table>
-</dl>
- </td>
- </tr>
-</table>
-<hr><h2>Constructor &amp; Destructor Documentation</h2>
-<a name="a0" doxytag="RtError::RtError"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
- <tr>
- <td class="md">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td nowrap valign="top"><b>
-RtError::RtError (
- </b></td>
- <td valign="bottom"><b>
-const char * <em>p</em>,
- </b></td>
- </tr>
- <tr>
- <td></td>
- <td><b>
-<a class="el" href="classRtError.html#s11">TYPE</a> <em>tipe</em> = RtError::UNSPECIFIED&nbsp;)
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-The constructor.
-<p>
- </td>
- </tr>
-</table>
-<a name="a1" doxytag="RtError::~RtError"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
- <tr>
- <td class="md">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td nowrap valign="top"><b>
-RtError::~RtError (
- </b></td>
- <td valign="bottom"><b>
-void&nbsp;)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-The destructor.
-<p>
- </td>
- </tr>
-</table>
-<hr><h2>Member Function Documentation</h2>
-<a name="a2" doxytag="RtError::printMessage"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
- <tr>
- <td class="md">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td nowrap valign="top"><b>
-void RtError::printMessage (
- </b></td>
- <td valign="bottom"><b>
-void&nbsp;)<code> [virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Prints "thrown" error message to stdout.
+<tr><td nowrap align=right valign=top><a name="a0" doxytag="RtError::RtError"></a>
+&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a0">RtError</a> (const char *p, <a class="el" href="classRtError.html#s11">TYPE</a> tipe=RtError::UNSPECIFIED)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>The constructor.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="a1" doxytag="RtError::~RtError"></a>
+virtual&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>The destructor.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="a2" doxytag="RtError::printMessage"></a>
+virtual void&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Prints "thrown" error message to stdout.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="a3" doxytag="RtError::getType"></a>
+virtual const <a class="el" href="classRtError.html#s11">TYPE</a>&amp;&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message TYPE.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="a4" doxytag="RtError::getMessage"></a>
+virtual const char*&nbsp;</td><td valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Returns the "thrown" error message string.</em></font><br><br></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a>.
<p>
- </td>
- </tr>
-</table>
-<a name="a3" doxytag="RtError::getType"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
- <tr>
- <td class="md">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td nowrap valign="top"><b>
-const <a class="el" href="classRtError.html#s11">TYPE</a> &amp; RtError::getType (
- </b></td>
- <td valign="bottom"><b>
-void&nbsp;)<code> [inline, virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Returns the "thrown" error message TYPE.
-<p>
- </td>
- </tr>
-</table>
-<a name="a4" doxytag="RtError::getMessage"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
- <tr>
- <td class="md">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td nowrap valign="top"><b>
-const char * RtError::getMessage (
- </b></td>
- <td valign="bottom"><b>
-void&nbsp;)<code> [inline, virtual]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Returns the "thrown" error message string.
-<p>
- </td>
- </tr>
-</table>
-<hr><h2>Member Data Documentation</h2>
-<a name="n0" doxytag="RtError::error_message"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
- <tr>
- <td class="md">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td nowrap valign="top"><b>
-char RtError::error_message<code> [protected]</code>
- </b></td>
- </tr>
-
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
+The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#s11">RtError::TYPE</a>. Almost all <a class="el" href="classRtAudio.html">RtAudio</a> 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 <a class="el" href="classRtAudio.html">RtAudio</a> where warning messages may be displayed but an exception is not thrown. There is a private <a class="el" href="classRtAudio.html">RtAudio</a> method, error(), which can be modified to globally control how these messages are handled and reported.
<p>
- </td>
- </tr>
-</table>
-<a name="n1" doxytag="RtError::type"></a><p>
-<table width="100%" cellpadding="2" cellspacing="0" border="0">
- <tr>
- <td class="md">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td nowrap valign="top"><b>
-<a class="el" href="classRtError.html#s11">TYPE</a> RtError::type<code> [protected]</code>
- </b></td>
- </tr>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
+<HR>
- </table>
- </td>
- </tr>
+<table><tr><td><img src="../images/ccrma.gif">
+ <td>&copy;2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.<br>
+ Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
</table>
-<table cellspacing=5 cellpadding=0 border=0>
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-<p>
- </td>
- </tr>
-</table>
-<hr>The documentation for this class was generated from the following file:<ul>
-<li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
-<HR>
-
-<table><tr><td><img src="../images/ccrma.gif">
- <td>&copy;2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
- Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
-</table>
-
-</BODY>
+</BODY>
</HTML>
generated by cgit v1.2.3 (git 2.46.0) at 2026-04-06 14:30:07 +0000