You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

214 lines
14 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.4"/>
  7. <title>tbb::captured_exception Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <!-- end header part -->
  16. <!-- Generated by Doxygen 1.8.4 -->
  17. <div id="navrow1" class="tabs">
  18. <ul class="tablist">
  19. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  20. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  21. <li><a href="modules.html"><span>Modules</span></a></li>
  22. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  23. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  24. <li><a href="files.html"><span>Files</span></a></li>
  25. </ul>
  26. </div>
  27. <div id="navrow2" class="tabs2">
  28. <ul class="tablist">
  29. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  30. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  31. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  32. </ul>
  33. </div>
  34. <div id="nav-path" class="navpath">
  35. <ul>
  36. <li class="navelem"><a class="el" href="a00222.html">tbb</a></li><li class="navelem"><a class="el" href="a00031.html">captured_exception</a></li> </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#pub-methods">Public Member Functions</a> &#124;
  42. <a href="a00303.html">List of all members</a> </div>
  43. <div class="headertitle">
  44. <div class="title">tbb::captured_exception Class Reference</div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47. <p>This class is used by TBB to propagate information about unhandled exceptions into the root thread.
  48. <a href="a00031.html#details">More...</a></p>
  49. <p><code>#include &lt;tbb_exception.h&gt;</code></p>
  50. <div class="dynheader">
  51. Inheritance diagram for tbb::captured_exception:</div>
  52. <div class="dyncontent">
  53. <div class="center">
  54. <img src="a00031.png" usemap="#tbb::captured_exception_map" alt=""/>
  55. <map id="tbb::captured_exception_map" name="tbb::captured_exception_map">
  56. <area href="a00146.html" title="Interface to be implemented by all exceptions TBB recognizes and propagates across the threads..." alt="tbb::tbb_exception" shape="rect" coords="0,56,146,80"/>
  57. </map>
  58. </div></div>
  59. <table class="memberdecls">
  60. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  61. Public Member Functions</h2></td></tr>
  62. <tr class="memitem:a56f6c51b6d4f8ce31669457ff8f0c07f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56f6c51b6d4f8ce31669457ff8f0c07f"></a>
  63. &#160;</td><td class="memItemRight" valign="bottom"><b>captured_exception</b> (const <a class="el" href="a00031.html">captured_exception</a> &amp;src)</td></tr>
  64. <tr class="separator:a56f6c51b6d4f8ce31669457ff8f0c07f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:ab3d72662db6a2badffa95a649a6c0bdd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3d72662db6a2badffa95a649a6c0bdd"></a>
  66. &#160;</td><td class="memItemRight" valign="bottom"><b>captured_exception</b> (const char *name_, const char *info)</td></tr>
  67. <tr class="separator:ab3d72662db6a2badffa95a649a6c0bdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a78a66603238d40da9ec6a750b6a2425c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78a66603238d40da9ec6a750b6a2425c"></a>
  69. <a class="el" href="a00031.html">captured_exception</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="a00031.html">captured_exception</a> &amp;src)</td></tr>
  70. <tr class="separator:a78a66603238d40da9ec6a750b6a2425c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:abb221485cd260349efdef681f633a6a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00031.html">captured_exception</a> <br class="typebreak"/>
  72. *__TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#abb221485cd260349efdef681f633a6a4">move</a> () throw ()</td></tr>
  73. <tr class="memdesc:abb221485cd260349efdef681f633a6a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and returns pointer to the deep copy of this exception object. <a href="#abb221485cd260349efdef681f633a6a4">More...</a><br/></td></tr>
  74. <tr class="separator:abb221485cd260349efdef681f633a6a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a3006b6825dda6c746d28fb748f5675de"><td class="memItemLeft" align="right" valign="top">void __TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a3006b6825dda6c746d28fb748f5675de">destroy</a> () throw ()</td></tr>
  76. <tr class="memdesc:a3006b6825dda6c746d28fb748f5675de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys objects created by the <a class="el" href="a00031.html#abb221485cd260349efdef681f633a6a4" title="Creates and returns pointer to the deep copy of this exception object. ">move()</a> method. <a href="#a3006b6825dda6c746d28fb748f5675de">More...</a><br/></td></tr>
  77. <tr class="separator:a3006b6825dda6c746d28fb748f5675de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ac9ae925678fcc0cc02a74df7d06b8d63"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ac9ae925678fcc0cc02a74df7d06b8d63">throw_self</a> ()</td></tr>
  79. <tr class="memdesc:ac9ae925678fcc0cc02a74df7d06b8d63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Throws this exception object. <a href="#ac9ae925678fcc0cc02a74df7d06b8d63">More...</a><br/></td></tr>
  80. <tr class="separator:ac9ae925678fcc0cc02a74df7d06b8d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a23426113851b78d3f0069956afd21976"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23426113851b78d3f0069956afd21976"></a>
  82. const char *__TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a23426113851b78d3f0069956afd21976">name</a> () const throw ()</td></tr>
  83. <tr class="memdesc:a23426113851b78d3f0069956afd21976"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns RTTI name of the originally intercepted exception. <br/></td></tr>
  84. <tr class="separator:a23426113851b78d3f0069956afd21976"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ac97ee315d8613c803dae2f6d3e0b91a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac97ee315d8613c803dae2f6d3e0b91a7"></a>
  86. const char *__TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ac97ee315d8613c803dae2f6d3e0b91a7">what</a> () const throw ()</td></tr>
  87. <tr class="memdesc:ac97ee315d8613c803dae2f6d3e0b91a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the result of originally intercepted exception's <a class="el" href="a00031.html#ac97ee315d8613c803dae2f6d3e0b91a7" title="Returns the result of originally intercepted exception&#39;s what() method. ">what()</a> method. <br/></td></tr>
  88. <tr class="separator:ac97ee315d8613c803dae2f6d3e0b91a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:aa72deb29316e8c08700f7e6afa4a48e8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa72deb29316e8c08700f7e6afa4a48e8"></a>
  90. void __TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><b>set</b> (const char *<a class="el" href="a00031.html#a23426113851b78d3f0069956afd21976">name</a>, const char *info) throw ()</td></tr>
  91. <tr class="separator:aa72deb29316e8c08700f7e6afa4a48e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a0b160c0fc5d2fab90df2be96ea14088a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b160c0fc5d2fab90df2be96ea14088a"></a>
  93. void __TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><b>clear</b> () throw ()</td></tr>
  94. <tr class="separator:a0b160c0fc5d2fab90df2be96ea14088a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="inherit_header pub_methods_a00146"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00146')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="a00146.html">tbb::tbb_exception</a></td></tr>
  96. <tr class="memitem:a6a973c37078afedf7d457ff4704bf8cd inherit pub_methods_a00146"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00146.html#a6a973c37078afedf7d457ff4704bf8cd">operator delete</a> (void *p)</td></tr>
  97. <tr class="separator:a6a973c37078afedf7d457ff4704bf8cd inherit pub_methods_a00146"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table>
  99. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  100. <div class="textblock"><p>This class is used by TBB to propagate information about unhandled exceptions into the root thread. </p>
  101. <p>Exception of this type is thrown by TBB in the root thread (thread that started a parallel algorithm ) if an unhandled exception was intercepted during the algorithm execution in one of the workers. </p>
  102. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00146.html" title="Interface to be implemented by all exceptions TBB recognizes and propagates across the threads...">tbb::tbb_exception</a> </dd></dl>
  103. </div><h2 class="groupheader">Member Function Documentation</h2>
  104. <a class="anchor" id="a3006b6825dda6c746d28fb748f5675de"></a>
  105. <div class="memitem">
  106. <div class="memproto">
  107. <table class="mlabels">
  108. <tr>
  109. <td class="mlabels-left">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname">void __TBB_EXPORTED_METHOD tbb::captured_exception::destroy </td>
  113. <td>(</td>
  114. <td class="paramname">)</td><td></td>
  115. <td></td>
  116. </tr>
  117. <tr>
  118. <td align="right">throw </td><td>(</td><td colspan="2"></td>
  119. </tr>
  120. <tr>
  121. <td align="right"></td><td>)</td><td></td><td></td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Destroys objects created by the <a class="el" href="a00031.html#abb221485cd260349efdef681f633a6a4" title="Creates and returns pointer to the deep copy of this exception object. ">move()</a> method. </p>
  131. <p>Frees memory and calls destructor for this exception object. Can and must be used only on objects created by the move method. </p>
  132. <p>Implements <a class="el" href="a00146.html#ad3bc09bf78c33f19a0bcdf882fdf9d41">tbb::tbb_exception</a>.</p>
  133. </div>
  134. </div>
  135. <a class="anchor" id="abb221485cd260349efdef681f633a6a4"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="mlabels">
  139. <tr>
  140. <td class="mlabels-left">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname"><a class="el" href="a00031.html">captured_exception</a>* __TBB_EXPORTED_METHOD tbb::captured_exception::move </td>
  144. <td>(</td>
  145. <td class="paramname">)</td><td></td>
  146. <td></td>
  147. </tr>
  148. <tr>
  149. <td align="right">throw </td><td>(</td><td colspan="2"></td>
  150. </tr>
  151. <tr>
  152. <td align="right"></td><td>)</td><td></td><td></td>
  153. </tr>
  154. </table>
  155. </td>
  156. <td class="mlabels-right">
  157. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Creates and returns pointer to the deep copy of this exception object. </p>
  162. <p>Move semantics is allowed. </p>
  163. <p>Implements <a class="el" href="a00146.html#a4bd4ba0d501021013d1473d21b020b69">tbb::tbb_exception</a>.</p>
  164. </div>
  165. </div>
  166. <a class="anchor" id="ac9ae925678fcc0cc02a74df7d06b8d63"></a>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="mlabels">
  170. <tr>
  171. <td class="mlabels-left">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">void tbb::captured_exception::throw_self </td>
  175. <td>(</td>
  176. <td class="paramname">)</td><td></td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. <p>Throws this exception object. </p>
  187. <p>Make sure that if you have several levels of derivation from this interface you implement or override this method on the most derived level. The implementation is as simple as "throw *this;". Failure to do this will result in exception of a base class type being thrown. </p>
  188. <p>Implements <a class="el" href="a00146.html#ae45c08d36c7ec7ae91785da3515a8828">tbb::tbb_exception</a>.</p>
  189. </div>
  190. </div>
  191. <hr/>The documentation for this class was generated from the following file:<ul>
  192. <li>tbb_exception.h</li>
  193. </ul>
  194. </div><!-- contents -->
  195. <hr>
  196. <p></p>
  197. Copyright &copy; 2005-2014 Intel Corporation. All Rights Reserved.
  198. <p></p>
  199. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  200. registered trademarks or trademarks of Intel Corporation or its
  201. subsidiaries in the United States and other countries.
  202. <p></p>
  203. * Other names and brands may be claimed as the property of others.