227 lines
14 KiB
HTML
227 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.4"/>
|
|
<title>tbb::tbb_exception Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.4 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="a00228.html">tbb</a></li><li class="navelem"><a class="el" href="a00150.html">tbb_exception</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="a00312.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">tbb::tbb_exception Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Interface to be implemented by all exceptions TBB recognizes and propagates across the threads.
|
|
<a href="a00150.html#details">More...</a></p>
|
|
|
|
<p><code>#include <tbb_exception.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for tbb::tbb_exception:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="a00150.png" usemap="#tbb::tbb_exception_map" alt=""/>
|
|
<map id="tbb::tbb_exception_map" name="tbb::tbb_exception_map">
|
|
<area href="a00032.html" title="This class is used by TBB to propagate information about unhandled exceptions into the root thread..." alt="tbb::captured_exception" shape="rect" coords="0,112,248,136"/>
|
|
<area href="a00076.html" title="Template that can be used to implement exception that transfers arbitrary ExceptionData to the root t..." alt="tbb::movable_exception< ExceptionData >" shape="rect" coords="258,112,506,136"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a4bd4ba0d501021013d1473d21b020b69"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00150.html">tbb_exception</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00150.html#a4bd4ba0d501021013d1473d21b020b69">move</a> ()=0 throw ()</td></tr>
|
|
<tr class="memdesc:a4bd4ba0d501021013d1473d21b020b69"><td class="mdescLeft"> </td><td class="mdescRight">Creates and returns pointer to the deep copy of this exception object. <a href="#a4bd4ba0d501021013d1473d21b020b69">More...</a><br/></td></tr>
|
|
<tr class="separator:a4bd4ba0d501021013d1473d21b020b69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3bc09bf78c33f19a0bcdf882fdf9d41"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00150.html#ad3bc09bf78c33f19a0bcdf882fdf9d41">destroy</a> ()=0 throw ()</td></tr>
|
|
<tr class="memdesc:ad3bc09bf78c33f19a0bcdf882fdf9d41"><td class="mdescLeft"> </td><td class="mdescRight">Destroys objects created by the <a class="el" href="a00150.html#a4bd4ba0d501021013d1473d21b020b69" title="Creates and returns pointer to the deep copy of this exception object. ">move()</a> method. <a href="#ad3bc09bf78c33f19a0bcdf882fdf9d41">More...</a><br/></td></tr>
|
|
<tr class="separator:ad3bc09bf78c33f19a0bcdf882fdf9d41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae45c08d36c7ec7ae91785da3515a8828"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00150.html#ae45c08d36c7ec7ae91785da3515a8828">throw_self</a> ()=0</td></tr>
|
|
<tr class="memdesc:ae45c08d36c7ec7ae91785da3515a8828"><td class="mdescLeft"> </td><td class="mdescRight">Throws this exception object. <a href="#ae45c08d36c7ec7ae91785da3515a8828">More...</a><br/></td></tr>
|
|
<tr class="separator:ae45c08d36c7ec7ae91785da3515a8828"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a282bb7dce5f157d044d14d50cd6ff35c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a282bb7dce5f157d044d14d50cd6ff35c"></a>
|
|
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00150.html#a282bb7dce5f157d044d14d50cd6ff35c">name</a> () const =0 throw ()</td></tr>
|
|
<tr class="memdesc:a282bb7dce5f157d044d14d50cd6ff35c"><td class="mdescLeft"> </td><td class="mdescRight">Returns RTTI name of the originally intercepted exception. <br/></td></tr>
|
|
<tr class="separator:a282bb7dce5f157d044d14d50cd6ff35c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa6739787c42d80943e18913cce47f42f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6739787c42d80943e18913cce47f42f"></a>
|
|
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00150.html#aa6739787c42d80943e18913cce47f42f">what</a> () const __TBB_override=0 throw ()</td></tr>
|
|
<tr class="memdesc:aa6739787c42d80943e18913cce47f42f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the result of originally intercepted exception's <a class="el" href="a00150.html#aa6739787c42d80943e18913cce47f42f" title="Returns the result of originally intercepted exception's what() method. ">what()</a> method. <br/></td></tr>
|
|
<tr class="separator:aa6739787c42d80943e18913cce47f42f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a973c37078afedf7d457ff4704bf8cd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00150.html#a6a973c37078afedf7d457ff4704bf8cd">operator delete</a> (void *p)</td></tr>
|
|
<tr class="separator:a6a973c37078afedf7d457ff4704bf8cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Interface to be implemented by all exceptions TBB recognizes and propagates across the threads. </p>
|
|
<p>If an unhandled exception of the type derived from <a class="el" href="a00150.html" title="Interface to be implemented by all exceptions TBB recognizes and propagates across the threads...">tbb::tbb_exception</a> is intercepted by the TBB scheduler in one of the worker threads, it is delivered to and re-thrown in the root thread. The root thread is the thread that has started the outermost algorithm or root task sharing the same <a class="el" href="a00142.html">task_group_context</a> with the guilty algorithm/task (the one that threw the exception first).</p>
|
|
<p>Note: when documentation mentions workers with respect to exception handling, masters are implied as well, because they are completely equivalent in this context. Consequently a root thread can be master or worker thread.</p>
|
|
<p>NOTE: In case of nested algorithms or complex task hierarchies when the nested levels share (explicitly or by means of implicit inheritance) the task group context of the outermost level, the exception may be (re-)thrown multiple times (ultimately - in each worker on each nesting level) before reaching the root thread at the outermost level. IMPORTANT: if you intercept an exception derived from this class on a nested level, you must re-throw it in the catch block by means of the "throw;" operator.</p>
|
|
<p>TBB provides two implementations of this interface: <a class="el" href="a00032.html" title="This class is used by TBB to propagate information about unhandled exceptions into the root thread...">tbb::captured_exception</a> and template class <a class="el" href="a00076.html" title="Template that can be used to implement exception that transfers arbitrary ExceptionData to the root t...">tbb::movable_exception</a>. See their declarations for more info. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="ad3bc09bf78c33f19a0bcdf882fdf9d41"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void tbb::tbb_exception::destroy </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="right">throw </td><td>(</td><td colspan="2"></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="right"></td><td>)</td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destroys objects created by the <a class="el" href="a00150.html#a4bd4ba0d501021013d1473d21b020b69" title="Creates and returns pointer to the deep copy of this exception object. ">move()</a> method. </p>
|
|
<p>Frees memory and calls destructor for this exception object. Can and must be used only on objects created by the move method. </p>
|
|
|
|
<p>Implemented in <a class="el" href="a00076.html#aa4be7e2bf375edcb218fb5d7ed8e279b">tbb::movable_exception< ExceptionData ></a>, and <a class="el" href="a00032.html#abfc1220a6f9da0361082a3f3ad80cdc9">tbb::captured_exception</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4bd4ba0d501021013d1473d21b020b69"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="a00150.html">tbb_exception</a>* tbb::tbb_exception::move </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="right">throw </td><td>(</td><td colspan="2"></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="right"></td><td>)</td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates and returns pointer to the deep copy of this exception object. </p>
|
|
<p>Move semantics is allowed. </p>
|
|
|
|
<p>Implemented in <a class="el" href="a00076.html#a46eee42a3279007f48c9e8f11d074d16">tbb::movable_exception< ExceptionData ></a>, and <a class="el" href="a00032.html#a3b75205c631b51a00faf98c9e107f78a">tbb::captured_exception</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6a973c37078afedf7d457ff4704bf8cd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void tbb::tbb_exception::operator delete </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>p</em>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Operator delete is provided only to allow using existing smart pointers with TBB exception objects obtained as the result of applying <a class="el" href="a00150.html#a4bd4ba0d501021013d1473d21b020b69" title="Creates and returns pointer to the deep copy of this exception object. ">move()</a> operation on an exception thrown out of TBB scheduler.</p>
|
|
<p>When overriding method <a class="el" href="a00150.html#a4bd4ba0d501021013d1473d21b020b69" title="Creates and returns pointer to the deep copy of this exception object. ">move()</a> make sure to override operator delete as well if memory is allocated not by TBB's scalable allocator. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae45c08d36c7ec7ae91785da3515a8828"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void tbb::tbb_exception::throw_self </td>
|
|
<td>(</td>
|
|
<td class="paramname">)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Throws this exception object. </p>
|
|
<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>
|
|
|
|
<p>Implemented in <a class="el" href="a00076.html#a0e9ac8a4468eb0ff3b2bb246b806a10e">tbb::movable_exception< ExceptionData ></a>, and <a class="el" href="a00032.html#a6df0d3a1943ca6f84a9a9aca25e9633d">tbb::captured_exception</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>tbb_exception.h</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<hr>
|
|
<p></p>
|
|
Copyright © 2005-2016 Intel Corporation. All Rights Reserved.
|
|
<p></p>
|
|
Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
|
|
registered trademarks or trademarks of Intel Corporation or its
|
|
subsidiaries in the United States and other countries.
|
|
<p></p>
|
|
* Other names and brands may be claimed as the property of others.
|