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.

273 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.9.1"/>
  7. <title>Xerces-C++: PanicHandler 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. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">Xerces-C++
  21. &#160;<span id="projectnumber">3.1.2</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.9.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  35. <li><a href="files.html"><span>Files</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  50. <a href="classPanicHandler-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">PanicHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Receive notification of panic.
  56. <a href="classPanicHandler.html#details">More...</a></p>
  57. <div class="dynheader">
  58. Inheritance diagram for PanicHandler:</div>
  59. <div class="dyncontent">
  60. <div class="center">
  61. <img src="classPanicHandler.png" usemap="#PanicHandler_map" alt=""/>
  62. <map id="PanicHandler_map" name="PanicHandler_map">
  63. <area href="classDefaultPanicHandler.html" title="Receive notification of panic. " alt="DefaultPanicHandler" shape="rect" coords="0,56,129,80"/>
  64. </map>
  65. </div></div>
  66. <table class="memberdecls">
  67. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  68. Public Types</h2></td></tr>
  69. <tr><td colspan="2"><div class="groupHeader">Public Types</div></td></tr>
  70. <tr class="memitem:aace4c4f408d68f168e1c2537e0ba5be2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2">PanicReasons</a> { <br />
  71. &#160;&#160;<a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2a2430bd8f71401367e30fe158b3a2a9d1">Panic_NoTransService</a>,
  72. <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2a24249426c2224e2738415715aa288dcf">Panic_NoDefTranscoder</a>,
  73. <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2a33e71b542dd1c65a9847622b22f3f390">Panic_CantFindLib</a>,
  74. <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2a08eadb74b6e54655f9d33382464127e5">Panic_UnknownMsgDomain</a>,
  75. <br />
  76. &#160;&#160;<a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2a6ddb16a86f54a832a08bf9580190bae3">Panic_CantLoadMsgDomain</a>,
  77. <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2ab89078a5505dcd40b96463dd080393d5">Panic_SynchronizationErr</a>,
  78. <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2aa4960fce81ac6da9aa0049a7d50df3e8">Panic_SystemInit</a>,
  79. <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2a25beb3014f563286fbf0b02856eb60bc">Panic_AllStaticInitErr</a>,
  80. <br />
  81. &#160;&#160;<a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2afb6c672288085736787e5d0d9ce43a84">Panic_MutexErr</a>,
  82. <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2a1d01eea19718d4796472d949dcf43237">PanicReasons_Count</a>
  83. <br />
  84. }</td></tr>
  85. <tr class="separator:aace4c4f408d68f168e1c2537e0ba5be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table><table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  88. Public Member Functions</h2></td></tr>
  89. <tr><td colspan="2"><div class="groupHeader">The virtual panic handler interface</div></td></tr>
  90. <tr class="memitem:a8cf11f9bba7395f8bdca47103c8f06bd"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPanicHandler.html#a8cf11f9bba7395f8bdca47103c8f06bd">panic</a> (const <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2">PanicHandler::PanicReasons</a> reason)=0</td></tr>
  91. <tr class="memdesc:a8cf11f9bba7395f8bdca47103c8f06bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive notification of panic. <a href="#a8cf11f9bba7395f8bdca47103c8f06bd">More...</a><br /></td></tr>
  92. <tr class="separator:a8cf11f9bba7395f8bdca47103c8f06bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table><table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  95. Static Public Member Functions</h2></td></tr>
  96. <tr class="memitem:a1697ada99db00b56afb1f8355e5d90b4"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPanicHandler.html#a1697ada99db00b56afb1f8355e5d90b4">getPanicReasonString</a> (const <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2">PanicHandler::PanicReasons</a> reason)</td></tr>
  97. <tr class="separator:a1697ada99db00b56afb1f8355e5d90b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table><table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  100. hidden Constructors</h2></td></tr>
  101. <tr class="memitem:ab2bc634b10a94f9cef4ba1e95a911c8c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPanicHandler.html#ab2bc634b10a94f9cef4ba1e95a911c8c">PanicHandler</a> ()</td></tr>
  102. <tr class="memdesc:ab2bc634b10a94f9cef4ba1e95a911c8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <a href="#ab2bc634b10a94f9cef4ba1e95a911c8c">More...</a><br /></td></tr>
  103. <tr class="separator:ab2bc634b10a94f9cef4ba1e95a911c8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ac7fad72aeffdcf733ae3c2bdf7fe9605"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPanicHandler.html#ac7fad72aeffdcf733ae3c2bdf7fe9605">~PanicHandler</a> ()</td></tr>
  105. <tr class="memdesc:ac7fad72aeffdcf733ae3c2bdf7fe9605"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#ac7fad72aeffdcf733ae3c2bdf7fe9605">More...</a><br /></td></tr>
  106. <tr class="separator:ac7fad72aeffdcf733ae3c2bdf7fe9605"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  109. <div class="textblock"><p>Receive notification of panic. </p>
  110. <p>This is the interface, through which the Xercesc reports a panic to the application. </p>
  111. <p>Application may implement this interface, instantiate an object of the derivative, and plug it to Xercesc in the invocation to <a class="el" href="classXMLPlatformUtils.html#aaa98f8d1346b8b531ee8886d9ce36173" title="Perform per-process parser initialization. ">XMLPlatformUtils::Initialize()</a>, if it prefers to handling panic itself rather than Xercesc doing it. </p>
  112. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  113. <a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2"></a>
  114. <div class="memitem">
  115. <div class="memproto">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">enum <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2">PanicHandler::PanicReasons</a></td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. <table class="fieldtable">
  123. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2a2430bd8f71401367e30fe158b3a2a9d1"></a>Panic_NoTransService&#160;</td><td class="fielddoc">
  124. </td></tr>
  125. <tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2a24249426c2224e2738415715aa288dcf"></a>Panic_NoDefTranscoder&#160;</td><td class="fielddoc">
  126. </td></tr>
  127. <tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2a33e71b542dd1c65a9847622b22f3f390"></a>Panic_CantFindLib&#160;</td><td class="fielddoc">
  128. </td></tr>
  129. <tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2a08eadb74b6e54655f9d33382464127e5"></a>Panic_UnknownMsgDomain&#160;</td><td class="fielddoc">
  130. </td></tr>
  131. <tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2a6ddb16a86f54a832a08bf9580190bae3"></a>Panic_CantLoadMsgDomain&#160;</td><td class="fielddoc">
  132. </td></tr>
  133. <tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2ab89078a5505dcd40b96463dd080393d5"></a>Panic_SynchronizationErr&#160;</td><td class="fielddoc">
  134. </td></tr>
  135. <tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2aa4960fce81ac6da9aa0049a7d50df3e8"></a>Panic_SystemInit&#160;</td><td class="fielddoc">
  136. </td></tr>
  137. <tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2a25beb3014f563286fbf0b02856eb60bc"></a>Panic_AllStaticInitErr&#160;</td><td class="fielddoc">
  138. </td></tr>
  139. <tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2afb6c672288085736787e5d0d9ce43a84"></a>Panic_MutexErr&#160;</td><td class="fielddoc">
  140. </td></tr>
  141. <tr><td class="fieldname"><a class="anchor" id="aace4c4f408d68f168e1c2537e0ba5be2a1d01eea19718d4796472d949dcf43237"></a>PanicReasons_Count&#160;</td><td class="fielddoc">
  142. </td></tr>
  143. </table>
  144. </div>
  145. </div>
  146. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  147. <a class="anchor" id="ab2bc634b10a94f9cef4ba1e95a911c8c"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="mlabels">
  151. <tr>
  152. <td class="mlabels-left">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">PanicHandler::PanicHandler </td>
  156. <td>(</td>
  157. <td class="paramname"></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </td>
  162. <td class="mlabels-right">
  163. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Default constructor. </p>
  168. </div>
  169. </div>
  170. <a class="anchor" id="ac7fad72aeffdcf733ae3c2bdf7fe9605"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="mlabels">
  174. <tr>
  175. <td class="mlabels-left">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">virtual PanicHandler::~PanicHandler </td>
  179. <td>(</td>
  180. <td class="paramname"></td><td>)</td>
  181. <td></td>
  182. </tr>
  183. </table>
  184. </td>
  185. <td class="mlabels-right">
  186. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Destructor. </p>
  191. </div>
  192. </div>
  193. <h2 class="groupheader">Member Function Documentation</h2>
  194. <a class="anchor" id="a1697ada99db00b56afb1f8355e5d90b4"></a>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="mlabels">
  198. <tr>
  199. <td class="mlabels-left">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname">static const char* PanicHandler::getPanicReasonString </td>
  203. <td>(</td>
  204. <td class="paramtype">const <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2">PanicHandler::PanicReasons</a>&#160;</td>
  205. <td class="paramname"><em>reason</em></td><td>)</td>
  206. <td></td>
  207. </tr>
  208. </table>
  209. </td>
  210. <td class="mlabels-right">
  211. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. </div>
  216. </div>
  217. <a class="anchor" id="a8cf11f9bba7395f8bdca47103c8f06bd"></a>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="mlabels">
  221. <tr>
  222. <td class="mlabels-left">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">virtual void PanicHandler::panic </td>
  226. <td>(</td>
  227. <td class="paramtype">const <a class="el" href="classPanicHandler.html#aace4c4f408d68f168e1c2537e0ba5be2">PanicHandler::PanicReasons</a>&#160;</td>
  228. <td class="paramname"><em>reason</em></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Receive notification of panic. </p>
  239. <p>This method is called when an unrecoverable error has occurred in the Xerces library.</p>
  240. <p>This method must not return normally, otherwise, the results are undefined.</p>
  241. <p>Ways of handling this call could include throwing an exception or exiting the process.</p>
  242. <p>Once this method has been called, the results of calling any other Xerces API, or using any existing Xerces objects are undefined.</p>
  243. <dl class="params"><dt>Parameters</dt><dd>
  244. <table class="params">
  245. <tr><td class="paramname">reason</td><td>The reason of panic </td></tr>
  246. </table>
  247. </dd>
  248. </dl>
  249. <p>Implemented in <a class="el" href="classDefaultPanicHandler.html#a8a47168786acceed06ef64b188211df4">DefaultPanicHandler</a>.</p>
  250. </div>
  251. </div>
  252. <hr/>The documentation for this class was generated from the following file:<ul>
  253. <li><a class="el" href="PanicHandler_8hpp_source.html">PanicHandler.hpp</a></li>
  254. </ul>
  255. </div><!-- contents -->
  256. <!-- start footer part -->
  257. <hr class="footer"/><address class="footer"><small>
  258. Generated on Wed Mar 18 2015 10:43:38 for Xerces-C++ by &#160;<a href="http://www.doxygen.org/index.html">
  259. <img class="footer" src="doxygen.png" alt="doxygen"/>
  260. </a> 1.8.9.1
  261. </small></address>
  262. </body>
  263. </html>