Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_msg_q_active.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: CMsgQActive Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="contents">
<h1>CMsgQActive Class Reference</h1><!-- doxytag: class="CMsgQActive" -->
<p><a href="class_c_msg_q_active-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_msg_q_active.html#a09f25693ce20e9d35ecf6256b38d516c">CMsgQActive</a> (TInt aPriority=EPriorityStandard)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_msg_q_active.html#a0562e2d68518460db5147b51cd89ca32">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_msg_q_active.html#aa09a136a396de91c207346ea74a00435">RunL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_msg_q_active.html#a5753cfd0f59382c0811757825e0462f5">StartRecieving</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_msg_q_active.html#ae600949e5c701ee556a2f457ef2414a3">ConstructL</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8641e0ac42ce6b913d1ba11a8d40e2a5"></a><!-- doxytag: member="CMsgQActive::NewL" ref="a8641e0ac42ce6b913d1ba11a8d40e2a5" args="(TInt aPriority=EPriorityStandard)" -->
static <a class="el" href="class_c_msg_q_active.html">CMsgQActive</a> * </td><td class="memItemRight" valign="bottom"><b>NewL</b> (TInt aPriority=EPriorityStandard)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_c_msg_q_active_8h_source.html#l00022">22</a> of file <a class="el" href="_c_msg_q_active_8h_source.html">CMsgQActive.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a09f25693ce20e9d35ecf6256b38d516c"></a><!-- doxytag: member="CMsgQActive::CMsgQActive" ref="a09f25693ce20e9d35ecf6256b38d516c" args="(TInt aPriority=EPriorityStandard)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CMsgQActive::CMsgQActive </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aPriority</em> = <code>EPriorityStandard</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor </p>
<p>Definition at line <a class="el" href="_c_msg_q_active_8cpp_source.html#l00034">34</a> of file <a class="el" href="_c_msg_q_active_8cpp_source.html">CMsgQActive.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0562e2d68518460db5147b51cd89ca32"></a><!-- doxytag: member="CMsgQActive::DoCancel" ref="a0562e2d68518460db5147b51cd89ca32" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMsgQActive::DoCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancel any outstanding request when stop command is given. </p>
<p>Definition at line <a class="el" href="_c_msg_q_active_8cpp_source.html#l00080">80</a> of file <a class="el" href="_c_msg_q_active_8cpp_source.html">CMsgQActive.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa09a136a396de91c207346ea74a00435"></a><!-- doxytag: member="CMsgQActive::RunL" ref="aa09a136a396de91c207346ea74a00435" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMsgQActive::RunL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function recieves the message from inverter and display in the console. </p>
<p>Definition at line <a class="el" href="_c_msg_q_active_8cpp_source.html#l00091">91</a> of file <a class="el" href="_c_msg_q_active_8cpp_source.html">CMsgQActive.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5753cfd0f59382c0811757825e0462f5"></a><!-- doxytag: member="CMsgQActive::StartRecieving" ref="a5753cfd0f59382c0811757825e0462f5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMsgQActive::StartRecieving </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Recieve data from the InverterOut message queue, requests notification when there is at least one message in the queue </p>
<p>Definition at line <a class="el" href="_c_msg_q_active_8cpp_source.html#l00067">67</a> of file <a class="el" href="_c_msg_q_active_8cpp_source.html">CMsgQActive.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae600949e5c701ee556a2f457ef2414a3"></a><!-- doxytag: member="CMsgQActive::ConstructL" ref="ae600949e5c701ee556a2f457ef2414a3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CMsgQActive::ConstructL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opens the global message queue so that data can be recieved. </p>
<p>Definition at line <a class="el" href="_c_msg_q_active_8cpp_source.html#l00052">52</a> of file <a class="el" href="_c_msg_q_active_8cpp_source.html">CMsgQActive.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>