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>CPVCmnAsyncEvent 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> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9 <hr><h1>CPVCmnAsyncEvent Class Reference</h1><code>#include <<a class="el" href="pv__common__types_8h-source.html">pv_common_types.h</a>></code> 10 <p> 11 <p>Inheritance diagram for CPVCmnAsyncEvent: 12 <p><center><img src="classCPVCmnAsyncEvent.png" usemap="#CPVCmnAsyncEvent_map" border="0" alt=""></center> 13 <map name="CPVCmnAsyncEvent_map"> 14 <area href="classCPVCmnInterfaceObserverMessage.html" alt="CPVCmnInterfaceObserverMessage" shape="rect" coords="0,0,218,24"> 15 </map> 16 <table border=0 cellpadding=0 cellspacing=0> 17 <tr><td></td></tr> 18 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 19 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#a0">CPVCmnAsyncEvent</a> (<a class="el" href="pv__common__types_8h.html#a4">TPVCmnEventType</a> aEventType, <a class="el" href="pv__common__types_8h.html#a5">TPVCmnExclusivePtr</a> aExclusivePtr, const uint8 *aLocalBuffer=NULL, uint32 aLocalBufSize=0, <a class="el" href="pv__common__types_8h.html#a7">TPVCmnResponseType</a> aResponseType=NULL)</td></tr> 20 <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#a1">~CPVCmnAsyncEvent</a> ()</td></tr> 21 <tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a4">TPVCmnEventType</a> </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#a2">GetEventType</a> () const</td></tr> 22 <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#a3">GetEventData</a> (<a class="el" href="pv__common__types_8h.html#a5">TPVCmnExclusivePtr</a> &aPtr) const</td></tr> 23 <tr><td nowrap align=right valign=top>uint8 * </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#a4">GetLocalBuffer</a> ()</td></tr> 24 <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> 25 <tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a4">TPVCmnEventType</a> </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#n0">iEventType</a></td></tr> 26 <tr><td nowrap align=right valign=top><a class="el" href="pv__common__types_8h.html#a5">TPVCmnExclusivePtr</a> </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#n1">iExclusivePtr</a></td></tr> 27 <tr><td nowrap align=right valign=top>uint8 </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#n2">iLocalBuffer</a> [PV_COMMON_ASYNC_EVENT_LOCAL_BUF_SIZE]</td></tr> 28 </table> 29 <hr><a name="_details"></a><h2>Detailed Description</h2> 30 CPVCmnAsyncEvent Class 31 <p> 32 CPVCmnAsyncEvent is the base class used to pass unsolicited error and informational indications to the user. Additional information can be tagged based on the specific event 33 <p> 34 <hr><h2>Constructor & Destructor Documentation</h2> 35 <a name="a0" doxytag="CPVCmnAsyncEvent::CPVCmnAsyncEvent"></a><p> 36 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 37 <tr> 38 <td class="md"> 39 <table cellpadding="0" cellspacing="0" border="0"> 40 <tr> 41 <td class="md" nowrap valign="top"> CPVCmnAsyncEvent::CPVCmnAsyncEvent </td> 42 <td class="md" valign="top">( </td> 43 <td class="md" nowrap valign="top"><a class="el" href="pv__common__types_8h.html#a4">TPVCmnEventType</a> </td> 44 <td class="mdname" nowrap> <em>aEventType</em>, </td> 45 </tr> 46 <tr> 47 <td></td> 48 <td></td> 49 <td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a5">TPVCmnExclusivePtr</a> </td> 50 <td class="mdname" nowrap> <em>aExclusivePtr</em>, </td> 51 </tr> 52 <tr> 53 <td></td> 54 <td></td> 55 <td class="md" nowrap>const uint8 * </td> 56 <td class="mdname" nowrap> <em>aLocalBuffer</em> = NULL, </td> 57 </tr> 58 <tr> 59 <td></td> 60 <td></td> 61 <td class="md" nowrap>uint32 </td> 62 <td class="mdname" nowrap> <em>aLocalBufSize</em> = 0, </td> 63 </tr> 64 <tr> 65 <td></td> 66 <td></td> 67 <td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a7">TPVCmnResponseType</a> </td> 68 <td class="mdname" nowrap> <em>aResponseType</em> = NULL</td> 69 </tr> 70 <tr> 71 <td></td> 72 <td class="md">) </td> 73 <td class="md" colspan="2"><code> [inline]</code></td> 74 </tr> 75 76 </table> 77 </td> 78 </tr> 79 </table> 80 <table cellspacing=5 cellpadding=0 border=0> 81 <tr> 82 <td> 83 84 </td> 85 <td> 86 87 <p> 88 </td> 89 </tr> 90 </table> 91 <a name="a1" doxytag="CPVCmnAsyncEvent::~CPVCmnAsyncEvent"></a><p> 92 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 93 <tr> 94 <td class="md"> 95 <table cellpadding="0" cellspacing="0" border="0"> 96 <tr> 97 <td class="md" nowrap valign="top"> CPVCmnAsyncEvent::~CPVCmnAsyncEvent </td> 98 <td class="md" valign="top">( </td> 99 <td class="mdname1" valign="top" nowrap> </td> 100 <td class="md" valign="top">) </td> 101 <td class="md" nowrap><code> [inline]</code></td> 102 </tr> 103 104 </table> 105 </td> 106 </tr> 107 </table> 108 <table cellspacing=5 cellpadding=0 border=0> 109 <tr> 110 <td> 111 112 </td> 113 <td> 114 115 <p> 116 </td> 117 </tr> 118 </table> 119 <hr><h2>Member Function Documentation</h2> 120 <a name="a3" doxytag="CPVCmnAsyncEvent::GetEventData"></a><p> 121 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 122 <tr> 123 <td class="md"> 124 <table cellpadding="0" cellspacing="0" border="0"> 125 <tr> 126 <td class="md" nowrap valign="top"> void CPVCmnAsyncEvent::GetEventData </td> 127 <td class="md" valign="top">( </td> 128 <td class="md" nowrap valign="top"><a class="el" href="pv__common__types_8h.html#a5">TPVCmnExclusivePtr</a> & </td> 129 <td class="mdname1" valign="top" nowrap> <em>aPtr</em> </td> 130 <td class="md" valign="top">) </td> 131 <td class="md" nowrap> const<code> [inline]</code></td> 132 </tr> 133 134 </table> 135 </td> 136 </tr> 137 </table> 138 <table cellspacing=5 cellpadding=0 border=0> 139 <tr> 140 <td> 141 142 </td> 143 <td> 144 145 <p> 146 <dl compact><dt><b>Returns: </b></dt><dd> 147 Returns the opaque data asociated with the event. </dl> </td> 148 </tr> 149 </table> 150 <a name="a2" doxytag="CPVCmnAsyncEvent::GetEventType"></a><p> 151 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 152 <tr> 153 <td class="md"> 154 <table cellpadding="0" cellspacing="0" border="0"> 155 <tr> 156 <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a4">TPVCmnEventType</a> CPVCmnAsyncEvent::GetEventType </td> 157 <td class="md" valign="top">( </td> 158 <td class="mdname1" valign="top" nowrap> </td> 159 <td class="md" valign="top">) </td> 160 <td class="md" nowrap> const<code> [inline]</code></td> 161 </tr> 162 163 </table> 164 </td> 165 </tr> 166 </table> 167 <table cellspacing=5 cellpadding=0 border=0> 168 <tr> 169 <td> 170 171 </td> 172 <td> 173 174 <p> 175 <dl compact><dt><b>Returns: </b></dt><dd> 176 Returns the Event type that has been received </dl> </td> 177 </tr> 178 </table> 179 <a name="a4" doxytag="CPVCmnAsyncEvent::GetLocalBuffer"></a><p> 180 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 181 <tr> 182 <td class="md"> 183 <table cellpadding="0" cellspacing="0" border="0"> 184 <tr> 185 <td class="md" nowrap valign="top"> uint8* CPVCmnAsyncEvent::GetLocalBuffer </td> 186 <td class="md" valign="top">( </td> 187 <td class="mdname1" valign="top" nowrap> </td> 188 <td class="md" valign="top">) </td> 189 <td class="md" nowrap><code> [inline]</code></td> 190 </tr> 191 192 </table> 193 </td> 194 </tr> 195 </table> 196 <table cellspacing=5 cellpadding=0 border=0> 197 <tr> 198 <td> 199 200 </td> 201 <td> 202 203 <p> 204 <dl compact><dt><b>Returns: </b></dt><dd> 205 Returns the local data asociated with the event. </dl> </td> 206 </tr> 207 </table> 208 <hr><h2>Field Documentation</h2> 209 <a name="n0" doxytag="CPVCmnAsyncEvent::iEventType"></a><p> 210 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 211 <tr> 212 <td class="md"> 213 <table cellpadding="0" cellspacing="0" border="0"> 214 <tr> 215 <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a4">TPVCmnEventType</a> CPVCmnAsyncEvent::iEventType<code> [protected]</code> 216 </table> 217 </td> 218 </tr> 219 </table> 220 <table cellspacing=5 cellpadding=0 border=0> 221 <tr> 222 <td> 223 224 </td> 225 <td> 226 227 <p> 228 </td> 229 </tr> 230 </table> 231 <a name="n1" doxytag="CPVCmnAsyncEvent::iExclusivePtr"></a><p> 232 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 233 <tr> 234 <td class="md"> 235 <table cellpadding="0" cellspacing="0" border="0"> 236 <tr> 237 <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a5">TPVCmnExclusivePtr</a> CPVCmnAsyncEvent::iExclusivePtr<code> [protected]</code> 238 </table> 239 </td> 240 </tr> 241 </table> 242 <table cellspacing=5 cellpadding=0 border=0> 243 <tr> 244 <td> 245 246 </td> 247 <td> 248 249 <p> 250 </td> 251 </tr> 252 </table> 253 <a name="n2" doxytag="CPVCmnAsyncEvent::iLocalBuffer"></a><p> 254 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 255 <tr> 256 <td class="md"> 257 <table cellpadding="0" cellspacing="0" border="0"> 258 <tr> 259 <td class="md" nowrap valign="top"> uint8 CPVCmnAsyncEvent::iLocalBuffer[PV_COMMON_ASYNC_EVENT_LOCAL_BUF_SIZE]<code> [protected]</code> 260 </table> 261 </td> 262 </tr> 263 </table> 264 <table cellspacing=5 cellpadding=0 border=0> 265 <tr> 266 <td> 267 268 </td> 269 <td> 270 271 <p> 272 </td> 273 </tr> 274 </table> 275 <hr>The documentation for this class was generated from the following file:<ul> 276 <li><a class="el" href="pv__common__types_8h-source.html">pv_common_types.h</a></ul> 277 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small> 278 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 279 </small></address> 280 </body> 281 </html> 282
