blob: 3a853f0d6eaed2c822270f5ea3d0703138715c19 [file] [log] [blame]
<!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>PVAsyncInformationalEvent 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> &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>
<hr><h1>PVAsyncInformationalEvent 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>
<p>
<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>&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncInformationalEvent.html#a0">PVAsyncInformationalEvent</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>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncInformationalEvent.html#a1">PVAsyncInformationalEvent</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>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncInformationalEvent.html#a2">~PVAsyncInformationalEvent</a> ()</td></tr>
<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="classPVAsyncInformationalEvent.html#a3">GetResponseType</a> () const</td></tr>
<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="classPVAsyncInformationalEvent.html#a4">GetEventType</a> () const</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classPVAsyncInformationalEvent.html#a5">GetEventData</a> (<a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a> &amp;aPtr) const</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
PVAsyncInformationalEvent Class
<p>
PVAsyncInformationalEvent is used to pass unsolicited informational indications to the user. Additional information can be tagged based on the specific event
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="PVAsyncInformationalEvent::PVAsyncInformationalEvent"></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"> PVAsyncInformationalEvent::PVAsyncInformationalEvent </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a1">PVEventType</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aEventType</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aEventData</em> = NULL, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>uint8 *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aLocalBuffer</em> = NULL, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aLocalBufferSize</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor for PVAsyncInformationalEvent </td>
</tr>
</table>
<a name="a1" doxytag="PVAsyncInformationalEvent::PVAsyncInformationalEvent"></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"> PVAsyncInformationalEvent::PVAsyncInformationalEvent </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a1">PVEventType</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aEventType</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>OsclAny *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aContext</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>PVInterface *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aEventExtInterface</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aEventData</em> = NULL, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>uint8 *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aLocalBuffer</em> = NULL, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aLocalBufferSize</em> = 0</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor with context and event extension interface </td>
</tr>
</table>
<a name="a2" doxytag="PVAsyncInformationalEvent::~PVAsyncInformationalEvent"></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"> PVAsyncInformationalEvent::~PVAsyncInformationalEvent </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destructor </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a5" doxytag="PVAsyncInformationalEvent::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 PVAsyncInformationalEvent::GetEventData </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="pv__engine__types_8h.html#a2">PVExclusivePtr</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>aPtr</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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="a4" doxytag="PVAsyncInformationalEvent::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__engine__types_8h.html#a1">PVEventType</a> PVAsyncInformationalEvent::GetEventType </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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="a3" doxytag="PVAsyncInformationalEvent::GetResponseType"></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__engine__types_8h.html#a3">PVResponseType</a> PVAsyncInformationalEvent::GetResponseType </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
WILL BE DEPRECATED SINCE IT IS NOT BEING USED. CURRENTLY RETURNING 0. <dl compact><dt><b>Returns: </b></dt><dd>
Returns the type of Response we get </dl> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__engine__observer__message_8h-source.html">pv_engine_observer_message.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>