Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: examples/Base/IPC/pubsub/pubsub.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>examples/Base/IPC/pubsub/pubsub.h File Reference</h1>
<p>
<a href="pubsub_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a0037066f576bf78524226106ee857e"></a><!-- doxytag: member="pubsub.h::_LIT16" ref="0a0037066f576bf78524226106ee857e" args="(KStop,"STOP")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT16</b> (KStop,"STOP")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="07a84fa20a98cb8db0696357403239d7"></a><!-- doxytag: member="pubsub.h::_LIT" ref="07a84fa20a98cb8db0696357403239d7" args="(KTxtEnter,"Press enter to publish\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtEnter,"Press enter to publish\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="644c40bcb7dd69bb7bb877407c6dde9d"></a><!-- doxytag: member="pubsub.h::_LIT" ref="644c40bcb7dd69bb7bb877407c6dde9d" args="(KTxtNewLine,"\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtNewLine,"\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7bf5e66607801fda1d667d65fbcdb0a6"></a><!-- doxytag: member="pubsub.h::_LIT" ref="7bf5e66607801fda1d667d65fbcdb0a6" args="(KTxtSpecPublish,"**** PUBLISH [SPECULATIVE] ****\n\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtSpecPublish,"**** PUBLISH [SPECULATIVE] ****\n\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e485505c026f616e668880f37373ed2"></a><!-- doxytag: member="pubsub.h::_LIT" ref="7e485505c026f616e668880f37373ed2" args="(KTxtCreateHandle,"Creating a handle to the property...\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtCreateHandle,"Creating a handle to the property...\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c5b81557024e8fff3a84b1010ef6b0a2"></a><!-- doxytag: member="pubsub.h::_LIT" ref="c5b81557024e8fff3a84b1010ef6b0a2" args="(KTxtPublish,"Publishing the byte-array property...\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtPublish,"Publishing the byte-array property...\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a44c33c9fcf9e701b59113c930eee8e"></a><!-- doxytag: member="pubsub.h::_LIT" ref="0a44c33c9fcf9e701b59113c930eee8e" args="(KTxtArray,"Array contents:\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtArray,"Array contents:\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d1bf7b8198290dbbca9a9634e31d705"></a><!-- doxytag: member="pubsub.h::_LIT" ref="3d1bf7b8198290dbbca9a9634e31d705" args="(KTxtArrayElement,"%x\t")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtArrayElement,"%x\t")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf7950a3141545dd280bc2f391b524a0"></a><!-- doxytag: member="pubsub.h::_LIT" ref="bf7950a3141545dd280bc2f391b524a0" args="(KTxtNotFound,"Property Not Found\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtNotFound,"Property Not Found\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e451af7ae9afc1b120d07e96afb46184"></a><!-- doxytag: member="pubsub.h::_LIT" ref="e451af7ae9afc1b120d07e96afb46184" args="(KTxtSpecSub,"*** SUBSCRIBER [SPECULATIVE] ***\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtSpecSub,"*** SUBSCRIBER [SPECULATIVE] ***\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="394dba7fafca7ef3c8c0a5cca6659568"></a><!-- doxytag: member="pubsub.h::_LIT" ref="394dba7fafca7ef3c8c0a5cca6659568" args="(KTxtSpecSt,"*** SUBSCRIBER [STANDARD STATE] ***\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtSpecSt,"*** SUBSCRIBER [STANDARD STATE] ***\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="06548a5f35222a8aafeb8e41ffd62dc9"></a><!-- doxytag: member="pubsub.h::_LIT" ref="06548a5f35222a8aafeb8e41ffd62dc9" args="(KTxtStPublish,"**** PUBLISH [STANDARD STATE] ****\n\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtStPublish,"**** PUBLISH [STANDARD STATE] ****\n\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="304ed63afd198865f88d6b0709b9848c"></a><!-- doxytag: member="pubsub.h::_LIT" ref="304ed63afd198865f88d6b0709b9848c" args="(KTxtDefine,"Defining a byte-array property and allocating memory for the same...\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtDefine,"Defining a byte-array property and allocating memory for the same...\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a23f5c8becc0bc49c5d27b093743257"></a><!-- doxytag: member="pubsub.h::_LIT" ref="2a23f5c8becc0bc49c5d27b093743257" args="(KTxtValChange,"Value of the property : %d\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtValChange,"Value of the property : %d\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51c4dbcd248efa73e16a28472fc83211"></a><!-- doxytag: member="pubsub.h::_LIT" ref="51c4dbcd248efa73e16a28472fc83211" args="(KTxtPESub,"*** SUBSCRIBER [PURE EVENT] ***\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtPESub,"*** SUBSCRIBER [PURE EVENT] ***\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="335ff3d66beaca25da25a62175cae6f7"></a><!-- doxytag: member="pubsub.h::_LIT" ref="335ff3d66beaca25da25a62175cae6f7" args="(KTxtPEPublish,"*** PUBLISHER [PURE EVENT] ***\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtPEPublish,"*** PUBLISHER [PURE EVENT] ***\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4a90fa6a3bb8ce7466018b8070940858"></a><!-- doxytag: member="pubsub.h::_LIT" ref="4a90fa6a3bb8ce7466018b8070940858" args="(KTxtInt,"Publishing : %d\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtInt,"Publishing : %d\n")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6e337108a58f33447fdf7f6d3d5b02a"></a><!-- doxytag: member="pubsub.h::_LIT" ref="e6e337108a58f33447fdf7f6d3d5b02a" args="(KTxtEPOC32EX,"Project::Publish and Subscribe")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtEPOC32EX,"Project::Publish and Subscribe")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6b5ba46dc290493845908ff475b0fd05"></a><!-- doxytag: member="pubsub.h::_LIT" ref="6b5ba46dc290493845908ff475b0fd05" args="(KTxtExampleCode,"Publish and Subscribe Example")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtExampleCode,"Publish and Subscribe Example")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="04a908410b4daaf83d48b270d8b58d13"></a><!-- doxytag: member="pubsub.h::_LIT" ref="04a908410b4daaf83d48b270d8b58d13" args="(KFormatFailed,"failed: leave code=%d")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KFormatFailed,"failed: leave code=%d")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7495385e5a772ed24251d1d6c68500d4"></a><!-- doxytag: member="pubsub.h::_LIT" ref="7495385e5a772ed24251d1d6c68500d4" args="(KTxtOK,"ok")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtOK,"ok")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12bee71c49b2abf7c526d1ad2bb7c3a6"></a><!-- doxytag: member="pubsub.h::_LIT" ref="12bee71c49b2abf7c526d1ad2bb7c3a6" args="(KTxtPressAnyKey," [press any key]")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtPressAnyKey," [press any key]")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dfc730042ae1d69ad16cd8c09bb2a5bf"></a><!-- doxytag: member="pubsub.h::_LIT" ref="dfc730042ae1d69ad16cd8c09bb2a5bf" args="(KTextConsoleTitle,"Console")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTextConsoleTitle,"Console")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9935f72ce83f6c42ca010bfad2381b43"></a><!-- doxytag: member="pubsub.h::_LIT" ref="9935f72ce83f6c42ca010bfad2381b43" args="(KTextFailed," failed, leave code = %d")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTextFailed," failed, leave code = %d")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c81b0ae4c5093cd9997583ca1d62e74a"></a><!-- doxytag: member="pubsub.h::_LIT" ref="c81b0ae4c5093cd9997583ca1d62e74a" args="(KTextPressAnyKey," [press any key]\n")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTextPressAnyKey," [press any key]\n")</td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ecb6127867eb677890bbf45edc8e4e76"></a><!-- doxytag: member="pubsub.h::KMyPropertyName" ref="ecb6127867eb677890bbf45edc8e4e76" args="" -->
const TUint </td><td class="memItemRight" valign="bottom"><a class="el" href="pubsub_8h.html#ecb6127867eb677890bbf45edc8e4e76">KMyPropertyName</a> = 0x0003</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0ca92acc78f916915b7e1cf2b2c3c809"></a><!-- doxytag: member="pubsub.h::KMyPropertyCat" ref="0ca92acc78f916915b7e1cf2b2c3c809" args="" -->
const TUid </td><td class="memItemRight" valign="bottom"><a class="el" href="pubsub_8h.html#0ca92acc78f916915b7e1cf2b2c3c809">KMyPropertyCat</a> = {0x10034567}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0735bf327c9644c10281b7815bf519d"></a><!-- doxytag: member="pubsub.h::KArraySize" ref="a0735bf327c9644c10281b7815bf519d" args="" -->
const TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="pubsub_8h.html#a0735bf327c9644c10281b7815bf519d">KArraySize</a> = 10</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d50a30ae986a2eb95e875b96296c482"></a><!-- doxytag: member="pubsub.h::KBufSize" ref="4d50a30ae986a2eb95e875b96296c482" args="" -->
const TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="pubsub_8h.html#4d50a30ae986a2eb95e875b96296c482">KBufSize</a> = 20</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7764fafcf6f031968904a2ab1965dcc9"></a><!-- doxytag: member="pubsub.h::KMax" ref="7764fafcf6f031968904a2ab1965dcc9" args="" -->
const TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="pubsub_8h.html#7764fafcf6f031968904a2ab1965dcc9">KMax</a> = 100</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a34c75c4ca70d89fe2aaf1ab8444d420"></a><!-- doxytag: member="pubsub.h::KTimeInterval" ref="a34c75c4ca70d89fe2aaf1ab8444d420" args="" -->
const TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="pubsub_8h.html#a34c75c4ca70d89fe2aaf1ab8444d420">KTimeInterval</a> = 3000000</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition in file <a class="el" href="pubsub_8h-source.html">pubsub.h</a>.</p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:02 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>