Home | History | Annotate | Download | only in pvauthor_html
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
      2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
      3 <title>PVAsyncErrorEvent class Reference</title>
      4 <link href="doxygen.css" rel="stylesheet" type="text/css">
      5 </head><body>
      6 <!-- Generated by Doxygen 1.2.18 -->
      7 <center>
      8 <a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
      9 <hr><h1>PVAsyncErrorEvent Class Reference</h1><code>#include &lt;<a class="el" href="pv__engine__observer__message_8h-source.html">pv_engine_observer_message.h</a>&gt;</code>
     10 <p>
     11 <table border=0 cellpadding=0 cellspacing=0>
     12 <tr><td></td></tr>
     13 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
     14 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncErrorEvent.html#a0">PVAsyncErrorEvent</a> (<a class="el" href="pv__engine__types_8h.html#a1">PVEventType</a> aEventType, <a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a> aEventData=NULL, uint8 *aLocalBuffer=NULL, int32 aLocalBufferSize=0)</td></tr>
     15 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncErrorEvent.html#a1">PVAsyncErrorEvent</a> (<a class="el" href="pv__engine__types_8h.html#a1">PVEventType</a> aEventType, OsclAny *aContext, PVInterface *aEventExtInterface, <a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a> aEventData=NULL, uint8 *aLocalBuffer=NULL, int32 aLocalBufferSize=0)</td></tr>
     16 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncErrorEvent.html#a2">~PVAsyncErrorEvent</a> ()</td></tr>
     17 <tr><td nowrap align=right valign=top><a class="el" href="pv__engine__types_8h.html#a3">PVResponseType</a>&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncErrorEvent.html#a3">GetResponseType</a> () const</td></tr>
     18 <tr><td nowrap align=right valign=top><a class="el" href="pv__engine__types_8h.html#a1">PVEventType</a>&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncErrorEvent.html#a4">GetEventType</a> () const</td></tr>
     19 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncErrorEvent.html#a5">GetEventData</a> (<a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a> &amp;aPtr) const</td></tr>
     20 </table>
     21 <hr><a name="_details"></a><h2>Detailed Description</h2>
     22 PVAsyncErrorEvent Class
     23 <p>
     24 PVAsyncErrorEvent is used to pass unsolicited error indications to the user. Additional information can be tagged based on the specific event 
     25 <p>
     26 <hr><h2>Constructor &amp; Destructor Documentation</h2>
     27 <a name="a0" doxytag="PVAsyncErrorEvent::PVAsyncErrorEvent"></a><p>
     28 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     29   <tr>
     30     <td class="md">
     31       <table cellpadding="0" cellspacing="0" border="0">
     32         <tr>
     33           <td class="md" nowrap valign="top"> PVAsyncErrorEvent::PVAsyncErrorEvent </td>
     34           <td class="md" valign="top">(&nbsp;</td>
     35           <td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a1">PVEventType</a>&nbsp;</td>
     36           <td class="mdname" nowrap>&nbsp; <em>aEventType</em>, </td>
     37         </tr>
     38         <tr>
     39           <td></td>
     40           <td></td>
     41           <td class="md" nowrap><a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a>&nbsp;</td>
     42           <td class="mdname" nowrap>&nbsp; <em>aEventData</em> = NULL, </td>
     43         </tr>
     44         <tr>
     45           <td></td>
     46           <td></td>
     47           <td class="md" nowrap>uint8 *&nbsp;</td>
     48           <td class="mdname" nowrap>&nbsp; <em>aLocalBuffer</em> = NULL, </td>
     49         </tr>
     50         <tr>
     51           <td></td>
     52           <td></td>
     53           <td class="md" nowrap>int32&nbsp;</td>
     54           <td class="mdname" nowrap>&nbsp; <em>aLocalBufferSize</em> = 0</td>
     55         </tr>
     56         <tr>
     57           <td></td>
     58           <td class="md">)&nbsp;</td>
     59           <td class="md" colspan="2"><code> [inline]</code></td>
     60         </tr>
     61 
     62       </table>
     63     </td>
     64   </tr>
     65 </table>
     66 <table cellspacing=5 cellpadding=0 border=0>
     67   <tr>
     68     <td>
     69       &nbsp;
     70     </td>
     71     <td>
     72 
     73 <p>
     74 Constructor for PVAsyncErrorEvent     </td>
     75   </tr>
     76 </table>
     77 <a name="a1" doxytag="PVAsyncErrorEvent::PVAsyncErrorEvent"></a><p>
     78 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     79   <tr>
     80     <td class="md">
     81       <table cellpadding="0" cellspacing="0" border="0">
     82         <tr>
     83           <td class="md" nowrap valign="top"> PVAsyncErrorEvent::PVAsyncErrorEvent </td>
     84           <td class="md" valign="top">(&nbsp;</td>
     85           <td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a1">PVEventType</a>&nbsp;</td>
     86           <td class="mdname" nowrap>&nbsp; <em>aEventType</em>, </td>
     87         </tr>
     88         <tr>
     89           <td></td>
     90           <td></td>
     91           <td class="md" nowrap>OsclAny *&nbsp;</td>
     92           <td class="mdname" nowrap>&nbsp; <em>aContext</em>, </td>
     93         </tr>
     94         <tr>
     95           <td></td>
     96           <td></td>
     97           <td class="md" nowrap>PVInterface *&nbsp;</td>
     98           <td class="mdname" nowrap>&nbsp; <em>aEventExtInterface</em>, </td>
     99         </tr>
    100         <tr>
    101           <td></td>
    102           <td></td>
    103           <td class="md" nowrap><a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a>&nbsp;</td>
    104           <td class="mdname" nowrap>&nbsp; <em>aEventData</em> = NULL, </td>
    105         </tr>
    106         <tr>
    107           <td></td>
    108           <td></td>
    109           <td class="md" nowrap>uint8 *&nbsp;</td>
    110           <td class="mdname" nowrap>&nbsp; <em>aLocalBuffer</em> = NULL, </td>
    111         </tr>
    112         <tr>
    113           <td></td>
    114           <td></td>
    115           <td class="md" nowrap>int32&nbsp;</td>
    116           <td class="mdname" nowrap>&nbsp; <em>aLocalBufferSize</em> = 0</td>
    117         </tr>
    118         <tr>
    119           <td></td>
    120           <td class="md">)&nbsp;</td>
    121           <td class="md" colspan="2"><code> [inline]</code></td>
    122         </tr>
    123 
    124       </table>
    125     </td>
    126   </tr>
    127 </table>
    128 <table cellspacing=5 cellpadding=0 border=0>
    129   <tr>
    130     <td>
    131       &nbsp;
    132     </td>
    133     <td>
    134 
    135 <p>
    136 Constructor with context and event extension interface     </td>
    137   </tr>
    138 </table>
    139 <a name="a2" doxytag="PVAsyncErrorEvent::~PVAsyncErrorEvent"></a><p>
    140 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    141   <tr>
    142     <td class="md">
    143       <table cellpadding="0" cellspacing="0" border="0">
    144         <tr>
    145           <td class="md" nowrap valign="top"> PVAsyncErrorEvent::~PVAsyncErrorEvent </td>
    146           <td class="md" valign="top">(&nbsp;</td>
    147           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    148           <td class="md" valign="top">)&nbsp;</td>
    149           <td class="md" nowrap><code> [inline]</code></td>
    150         </tr>
    151 
    152       </table>
    153     </td>
    154   </tr>
    155 </table>
    156 <table cellspacing=5 cellpadding=0 border=0>
    157   <tr>
    158     <td>
    159       &nbsp;
    160     </td>
    161     <td>
    162 
    163 <p>
    164 Destructor     </td>
    165   </tr>
    166 </table>
    167 <hr><h2>Member Function Documentation</h2>
    168 <a name="a5" doxytag="PVAsyncErrorEvent::GetEventData"></a><p>
    169 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    170   <tr>
    171     <td class="md">
    172       <table cellpadding="0" cellspacing="0" border="0">
    173         <tr>
    174           <td class="md" nowrap valign="top"> void PVAsyncErrorEvent::GetEventData </td>
    175           <td class="md" valign="top">(&nbsp;</td>
    176           <td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a> &amp;&nbsp;</td>
    177           <td class="mdname1" valign="top" nowrap>&nbsp; <em>aPtr</em>          </td>
    178           <td class="md" valign="top">)&nbsp;</td>
    179           <td class="md" nowrap> const<code> [inline]</code></td>
    180         </tr>
    181 
    182       </table>
    183     </td>
    184   </tr>
    185 </table>
    186 <table cellspacing=5 cellpadding=0 border=0>
    187   <tr>
    188     <td>
    189       &nbsp;
    190     </td>
    191     <td>
    192 
    193 <p>
    194 <dl compact><dt><b>Returns: </b></dt><dd>
    195 Returns the opaque data asociated with the event. </dl>    </td>
    196   </tr>
    197 </table>
    198 <a name="a4" doxytag="PVAsyncErrorEvent::GetEventType"></a><p>
    199 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    200   <tr>
    201     <td class="md">
    202       <table cellpadding="0" cellspacing="0" border="0">
    203         <tr>
    204           <td class="md" nowrap valign="top"> <a class="el" href="pv__engine__types_8h.html#a1">PVEventType</a> PVAsyncErrorEvent::GetEventType </td>
    205           <td class="md" valign="top">(&nbsp;</td>
    206           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    207           <td class="md" valign="top">)&nbsp;</td>
    208           <td class="md" nowrap> const<code> [inline]</code></td>
    209         </tr>
    210 
    211       </table>
    212     </td>
    213   </tr>
    214 </table>
    215 <table cellspacing=5 cellpadding=0 border=0>
    216   <tr>
    217     <td>
    218       &nbsp;
    219     </td>
    220     <td>
    221 
    222 <p>
    223 <dl compact><dt><b>Returns: </b></dt><dd>
    224 Returns the Event type that has been received </dl>    </td>
    225   </tr>
    226 </table>
    227 <a name="a3" doxytag="PVAsyncErrorEvent::GetResponseType"></a><p>
    228 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    229   <tr>
    230     <td class="md">
    231       <table cellpadding="0" cellspacing="0" border="0">
    232         <tr>
    233           <td class="md" nowrap valign="top"> <a class="el" href="pv__engine__types_8h.html#a3">PVResponseType</a> PVAsyncErrorEvent::GetResponseType </td>
    234           <td class="md" valign="top">(&nbsp;</td>
    235           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    236           <td class="md" valign="top">)&nbsp;</td>
    237           <td class="md" nowrap> const<code> [inline]</code></td>
    238         </tr>
    239 
    240       </table>
    241     </td>
    242   </tr>
    243 </table>
    244 <table cellspacing=5 cellpadding=0 border=0>
    245   <tr>
    246     <td>
    247       &nbsp;
    248     </td>
    249     <td>
    250 
    251 <p>
    252 WILL BE DEPRECATED SINCE IT IS NOT BEING USED. CURRENTLY RETURNING 0. <dl compact><dt><b>Returns: </b></dt><dd>
    253 Returns the type of Response we get </dl>    </td>
    254   </tr>
    255 </table>
    256 <hr>The documentation for this class was generated from the following file:<ul>
    257 <li><a class="el" href="pv__engine__observer__message_8h-source.html">pv_engine_observer_message.h</a></ul>
    258 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small>
    259 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
    260 </small></address>
    261 </body>
    262 </html>
    263