| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
| <title>CPVCmnAsyncEvent class Reference</title> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"> |
| </head><body> |
| <!-- Generated by Doxygen 1.2.18 --> |
| <center> |
| <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> |
| <hr><h1>CPVCmnAsyncEvent Class Reference</h1><code>#include <<a class="el" href="pv__common__types_8h-source.html">pv_common_types.h</a>></code> |
| <p> |
| <p>Inheritance diagram for CPVCmnAsyncEvent: |
| <p><center><img src="classCPVCmnAsyncEvent.png" usemap="#CPVCmnAsyncEvent_map" border="0" alt=""></center> |
| <map name="CPVCmnAsyncEvent_map"> |
| <area href="classCPVCmnInterfaceObserverMessage.html" alt="CPVCmnInterfaceObserverMessage" shape="rect" coords="0,0,218,24"> |
| </map> |
| <table border=0 cellpadding=0 cellspacing=0> |
| <tr><td></td></tr> |
| <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> |
| <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> |
| <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#a1">~CPVCmnAsyncEvent</a> ()</td></tr> |
| <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> |
| <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> |
| <tr><td nowrap align=right valign=top>uint8 * </td><td valign=bottom><a class="el" href="classCPVCmnAsyncEvent.html#a4">GetLocalBuffer</a> ()</td></tr> |
| <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
| <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> |
| <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> |
| <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> |
| </table> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| CPVCmnAsyncEvent Class |
| <p> |
| 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 |
| <p> |
| <hr><h2>Constructor & Destructor Documentation</h2> |
| <a name="a0" doxytag="CPVCmnAsyncEvent::CPVCmnAsyncEvent"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> CPVCmnAsyncEvent::CPVCmnAsyncEvent </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top"><a class="el" href="pv__common__types_8h.html#a4">TPVCmnEventType</a> </td> |
| <td class="mdname" nowrap> <em>aEventType</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a5">TPVCmnExclusivePtr</a> </td> |
| <td class="mdname" nowrap> <em>aExclusivePtr</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>const uint8 * </td> |
| <td class="mdname" nowrap> <em>aLocalBuffer</em> = NULL, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>uint32 </td> |
| <td class="mdname" nowrap> <em>aLocalBufSize</em> = 0, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap><a class="el" href="pv__common__types_8h.html#a7">TPVCmnResponseType</a> </td> |
| <td class="mdname" nowrap> <em>aResponseType</em> = NULL</td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"><code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| </td> |
| </tr> |
| </table> |
| <a name="a1" doxytag="CPVCmnAsyncEvent::~CPVCmnAsyncEvent"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> CPVCmnAsyncEvent::~CPVCmnAsyncEvent </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top">) </td> |
| <td class="md" nowrap><code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| </td> |
| </tr> |
| </table> |
| <hr><h2>Member Function Documentation</h2> |
| <a name="a3" doxytag="CPVCmnAsyncEvent::GetEventData"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void CPVCmnAsyncEvent::GetEventData </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top"><a class="el" href="pv__common__types_8h.html#a5">TPVCmnExclusivePtr</a> & </td> |
| <td class="mdname1" valign="top" nowrap> <em>aPtr</em> </td> |
| <td class="md" valign="top">) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| <dl compact><dt><b>Returns: </b></dt><dd> |
| Returns the opaque data asociated with the event. </dl> </td> |
| </tr> |
| </table> |
| <a name="a2" doxytag="CPVCmnAsyncEvent::GetEventType"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a4">TPVCmnEventType</a> CPVCmnAsyncEvent::GetEventType </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top">) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| <dl compact><dt><b>Returns: </b></dt><dd> |
| Returns the Event type that has been received </dl> </td> |
| </tr> |
| </table> |
| <a name="a4" doxytag="CPVCmnAsyncEvent::GetLocalBuffer"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> uint8* CPVCmnAsyncEvent::GetLocalBuffer </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top">) </td> |
| <td class="md" nowrap><code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| <dl compact><dt><b>Returns: </b></dt><dd> |
| Returns the local data asociated with the event. </dl> </td> |
| </tr> |
| </table> |
| <hr><h2>Field Documentation</h2> |
| <a name="n0" doxytag="CPVCmnAsyncEvent::iEventType"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a4">TPVCmnEventType</a> CPVCmnAsyncEvent::iEventType<code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| </td> |
| </tr> |
| </table> |
| <a name="n1" doxytag="CPVCmnAsyncEvent::iExclusivePtr"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> <a class="el" href="pv__common__types_8h.html#a5">TPVCmnExclusivePtr</a> CPVCmnAsyncEvent::iExclusivePtr<code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| </td> |
| </tr> |
| </table> |
| <a name="n2" doxytag="CPVCmnAsyncEvent::iLocalBuffer"></a><p> |
| <table width="100%" cellpadding="2" cellspacing="0" border="0"> |
| <tr> |
| <td class="md"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> uint8 CPVCmnAsyncEvent::iLocalBuffer[PV_COMMON_ASYNC_EVENT_LOCAL_BUF_SIZE]<code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| </td> |
| </tr> |
| </table> |
| <hr>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="pv__common__types_8h-source.html">pv_common_types.h</a></ul> |
| <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV Author Engine</small> |
| <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> |
| </small></address> |
| </body> |
| </html> |