Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/sharedmem_8h.html
author Dominic Pinkman <dominic.pinkman@nokia.com>
Fri, 13 Aug 2010 16:47:46 +0100
changeset 14 578be2adaf3e
parent 6 43e37759235e
permissions -rw-r--r--
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: examples/Base/IPC/condvar/condvarglobal/inc/sharedmem.h File 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>examples/Base/IPC/condvar/condvarglobal/inc/sharedmem.h File Reference</h1>
<p><a href="sharedmem_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c144b91ecb225b1131135690ad990f3"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="a1c144b91ecb225b1131135690ad990f3" args="(KChunkName,&quot;chunk&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KChunkName,&quot;chunk&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d1f187f7aeef42475a82c57deac13af"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="a4d1f187f7aeef42475a82c57deac13af" args="(KMutexName,&quot;mutex&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KMutexName,&quot;mutex&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd6aa4dcff651260bbb32f0a7fa526ef"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="acd6aa4dcff651260bbb32f0a7fa526ef" args="(KCondVarName,&quot;condvar&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KCondVarName,&quot;condvar&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0000f2ca37f1cce9f2dde8a32cd311c"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="ab0000f2ca37f1cce9f2dde8a32cd311c" args="(KTxtEPOC32EX,&quot;EXAMPLES&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtEPOC32EX,&quot;EXAMPLES&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf763660b4a00ffda5eed0bfe1dc73e2"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="adf763660b4a00ffda5eed0bfe1dc73e2" args="(KTxtExampleCode,&quot;Symbian platform Example Code&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtExampleCode,&quot;Symbian platform Example Code&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04a908410b4daaf83d48b270d8b58d13"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="a04a908410b4daaf83d48b270d8b58d13" args="(KFormatFailed,&quot;failed: leave code=%d&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KFormatFailed,&quot;failed: leave code=%d&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7495385e5a772ed24251d1d6c68500d4"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="a7495385e5a772ed24251d1d6c68500d4" args="(KTxtOK,&quot;ok&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtOK,&quot;ok&quot;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12bee71c49b2abf7c526d1ad2bb7c3a6"></a><!-- doxytag: member="sharedmem.h::_LIT" ref="a12bee71c49b2abf7c526d1ad2bb7c3a6" args="(KTxtPressAnyKey,&quot; [press any key]&quot;)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtPressAnyKey,&quot; [press any key]&quot;)</td></tr>
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#a1006d8c149c84d799a92f7de74ebcf4c">KChunkSize</a> = 1</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#a817ce7a9d8ca9ead92509953f8dcdcad">KLowerThreshold</a> = 10</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#a0f2ae9d486d80c446844be5480b7bbc2">KUpperThreshold</a> = 20</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#abff4706ef1627715d044011a1f852d7c">KMaxValue</a> = 30</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="sharedmem_8h.html#a6e0ba2cbec05ae135edbcc64ba0f275f">KMinValue</a> = 0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition in file <a class="el" href="sharedmem_8h_source.html">sharedmem.h</a>.</p>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="a1006d8c149c84d799a92f7de74ebcf4c"></a><!-- doxytag: member="sharedmem.h::KChunkSize" ref="a1006d8c149c84d799a92f7de74ebcf4c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#a1006d8c149c84d799a92f7de74ebcf4c">KChunkSize</a> = 1</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The size of the shared memory chunk in bytes. </p>

<p>Definition at line <a class="el" href="sharedmem_8h_source.html#l00044">44</a> of file <a class="el" href="sharedmem_8h_source.html">sharedmem.h</a>.</p>

</div>
</div>
<a class="anchor" id="a817ce7a9d8ca9ead92509953f8dcdcad"></a><!-- doxytag: member="sharedmem.h::KLowerThreshold" ref="a817ce7a9d8ca9ead92509953f8dcdcad" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#a817ce7a9d8ca9ead92509953f8dcdcad">KLowerThreshold</a> = 10</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The lower threshold for the shared memory variable. </p>

<p>Definition at line <a class="el" href="sharedmem_8h_source.html#l00049">49</a> of file <a class="el" href="sharedmem_8h_source.html">sharedmem.h</a>.</p>

</div>
</div>
<a class="anchor" id="a0f2ae9d486d80c446844be5480b7bbc2"></a><!-- doxytag: member="sharedmem.h::KUpperThreshold" ref="a0f2ae9d486d80c446844be5480b7bbc2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#a0f2ae9d486d80c446844be5480b7bbc2">KUpperThreshold</a> = 20</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The upper threshold for the shared memory variable. </p>

<p>Definition at line <a class="el" href="sharedmem_8h_source.html#l00054">54</a> of file <a class="el" href="sharedmem_8h_source.html">sharedmem.h</a>.</p>

</div>
</div>
<a class="anchor" id="abff4706ef1627715d044011a1f852d7c"></a><!-- doxytag: member="sharedmem.h::KMaxValue" ref="abff4706ef1627715d044011a1f852d7c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#abff4706ef1627715d044011a1f852d7c">KMaxValue</a> = 30</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The maximum value for the shared memory variable. </p>

<p>Definition at line <a class="el" href="sharedmem_8h_source.html#l00059">59</a> of file <a class="el" href="sharedmem_8h_source.html">sharedmem.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6e0ba2cbec05ae135edbcc64ba0f275f"></a><!-- doxytag: member="sharedmem.h::KMinValue" ref="a6e0ba2cbec05ae135edbcc64ba0f275f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const TInt <a class="el" href="sharedmem_8h.html#a6e0ba2cbec05ae135edbcc64ba0f275f">KMinValue</a> = 0</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The minimum value for the shared memory variable. </p>

<p>Definition at line <a class="el" href="sharedmem_8h_source.html#l00064">64</a> of file <a class="el" href="sharedmem_8h_source.html">sharedmem.h</a>.</p>

</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>