Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_process_server.html
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: CProcessServer Class 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>CProcessServer Class Reference</h1><!-- doxytag: class="CProcessServer" -->
<p>
<a href="class_c_process_server-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b38">TDriverState</a> { <br>
<a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b38febfde84b09cb7b3b4bfc1fe81587451">EStateUnknown</a>,
<a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b38e0571fa5b49a37bdac4e3d6e5f6f30a1">EDriverLoaded</a>,
<a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b38d1f2b7048e915bb24c249a40e10c500c">ELogicalChannelOpened</a>,
<a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b38946b4628ef31d91ded88495747be5902">ESendingData</a>,
<br>
<a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b385357bdbb689c819cd07b927e09b11e3f">ELogicalChannelClosed</a>,
<a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b386156c4dd182e5386ec555f3da184fdfd">EDriverUnloaded</a>
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#f9cff6818110c62a7ad6a1c19984297b">~CProcessServer</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">CSession2 * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#0025005d37f3cc34dc8e181373980ce9">NewSessionL</a> (const TVersion &aVersion, const RMessage2 &aMessage) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#d113263093aaa3489308e2ecc6f20c87">IncrementRefCount</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#cc9e2e8092c07e6fbf8aa4f866a1ba89">DecrementRefCount</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#9333ba960d07b42c72d98466b01788ce">LoadDevice</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#3e78b0766ff78223d4ccf77fa717b269">UnloadDevice</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#1861af3b7073acf002b55520397c4678">OpenLogicalChannel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#c381e3ac102f3c720ca1cffec2ab570d">CloseLogicalChannel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#a1e3677c879b6a531f67267ff63ec214">SendDataToDevice</a> (TRequestStatus &aStatus, const TDesC8 &aData)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#853cb371c075e2f74ac3e28a9a66f38e">CancelSendData</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#6af5450445ef1f12826f88a24ec83043">UpdateDriverState</a> (<a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b38">TDriverState</a> aState)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#239278f30e2253b2d0827752355dbef2">NewLC</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Interface for process server.
<p>Definition at line <a class="el" href="processserver_8h-source.html#l00029">29</a> of file <a class="el" href="processserver_8h-source.html">processserver.h</a>.</p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="82cab30ea5d500e0abc51d39a0889b38"></a><!-- doxytag: member="CProcessServer::TDriverState" ref="82cab30ea5d500e0abc51d39a0889b38" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b38">CProcessServer::TDriverState</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enumeration of states of driver. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="82cab30ea5d500e0abc51d39a0889b38febfde84b09cb7b3b4bfc1fe81587451"></a><!-- doxytag: member="EStateUnknown" ref="82cab30ea5d500e0abc51d39a0889b38febfde84b09cb7b3b4bfc1fe81587451" args="" -->EStateUnknown</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="82cab30ea5d500e0abc51d39a0889b38e0571fa5b49a37bdac4e3d6e5f6f30a1"></a><!-- doxytag: member="EDriverLoaded" ref="82cab30ea5d500e0abc51d39a0889b38e0571fa5b49a37bdac4e3d6e5f6f30a1" args="" -->EDriverLoaded</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="82cab30ea5d500e0abc51d39a0889b38d1f2b7048e915bb24c249a40e10c500c"></a><!-- doxytag: member="ELogicalChannelOpened" ref="82cab30ea5d500e0abc51d39a0889b38d1f2b7048e915bb24c249a40e10c500c" args="" -->ELogicalChannelOpened</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="82cab30ea5d500e0abc51d39a0889b38946b4628ef31d91ded88495747be5902"></a><!-- doxytag: member="ESendingData" ref="82cab30ea5d500e0abc51d39a0889b38946b4628ef31d91ded88495747be5902" args="" -->ESendingData</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="82cab30ea5d500e0abc51d39a0889b385357bdbb689c819cd07b927e09b11e3f"></a><!-- doxytag: member="ELogicalChannelClosed" ref="82cab30ea5d500e0abc51d39a0889b385357bdbb689c819cd07b927e09b11e3f" args="" -->ELogicalChannelClosed</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="82cab30ea5d500e0abc51d39a0889b386156c4dd182e5386ec555f3da184fdfd"></a><!-- doxytag: member="EDriverUnloaded" ref="82cab30ea5d500e0abc51d39a0889b386156c4dd182e5386ec555f3da184fdfd" args="" -->EDriverUnloaded</em> </td><td>
</td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="processserver_8h-source.html#l00035">35</a> of file <a class="el" href="processserver_8h-source.html">processserver.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f9cff6818110c62a7ad6a1c19984297b"></a><!-- doxytag: member="CProcessServer::~CProcessServer" ref="f9cff6818110c62a7ad6a1c19984297b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CProcessServer::~CProcessServer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor, The device driver will be unloaded when the server destructor is called.<p>
Destructor
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00050">50</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="239278f30e2253b2d0827752355dbef2"></a><!-- doxytag: member="CProcessServer::NewLC" ref="239278f30e2253b2d0827752355dbef2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CProcessServer::NewLC </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Two phase constructor.
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00024">24</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="0025005d37f3cc34dc8e181373980ce9"></a><!-- doxytag: member="CProcessServer::NewSessionL" ref="0025005d37f3cc34dc8e181373980ce9" args="(const TVersion &aVersion, const RMessage2 &aMessage) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSession2 * CProcessServer::NewSessionL </td>
<td>(</td>
<td class="paramtype">const TVersion & </td>
<td class="paramname"> <em>aVersion</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const RMessage2 & </td>
<td class="paramname"> <em>aMessage</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a server-side session object. <dl class="see" compact><dt><b>See also:</b></dt><dd>CServer2::NewSessionL().</dd></dl>
Creates a new server-side session <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aVersion</em> </td><td>Version argument </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aMessage</em> </td><td>The message to process </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server side client session object </dd></dl>
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00067">67</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="d113263093aaa3489308e2ecc6f20c87"></a><!-- doxytag: member="CProcessServer::IncrementRefCount" ref="d113263093aaa3489308e2ecc6f20c87" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CProcessServer::IncrementRefCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increases reference count and cancels shutdown timer. This function is called when a new session is created.<p>
Increment the count for the number of clients connected
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00086">86</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="cc9e2e8092c07e6fbf8aa4f866a1ba89"></a><!-- doxytag: member="CProcessServer::DecrementRefCount" ref="cc9e2e8092c07e6fbf8aa4f866a1ba89" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CProcessServer::DecrementRefCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decreases reference count and starts shutdown timer. This function is called when a session is destroyed.<p>
Decrement the count for the number of clients connected
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00095">95</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="9333ba960d07b42c72d98466b01788ce"></a><!-- doxytag: member="CProcessServer::LoadDevice" ref="9333ba960d07b42c72d98466b01788ce" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CProcessServer::LoadDevice </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Loads the device, including sample PDD and LDD.<p>
Load both LDD and PDD <dl class="return" compact><dt><b>Returns:</b></dt><dd>KErrNone or standard error code. </dd></dl>
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00107">107</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="3e78b0766ff78223d4ccf77fa717b269"></a><!-- doxytag: member="CProcessServer::UnloadDevice" ref="3e78b0766ff78223d4ccf77fa717b269" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CProcessServer::UnloadDevice </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unloads the device, including sample LDD and PDD.<p>
Unload both LDD and PDD <dl class="return" compact><dt><b>Returns:</b></dt><dd>KErrNone or standard error code. </dd></dl>
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00132">132</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="1861af3b7073acf002b55520397c4678"></a><!-- doxytag: member="CProcessServer::OpenLogicalChannel" ref="1861af3b7073acf002b55520397c4678" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CProcessServer::OpenLogicalChannel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Opens device's logical channel.<p>
Open LDD <dl class="return" compact><dt><b>Returns:</b></dt><dd>KErrNone or standard error code. </dd></dl>
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00158">158</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="c381e3ac102f3c720ca1cffec2ab570d"></a><!-- doxytag: member="CProcessServer::CloseLogicalChannel" ref="c381e3ac102f3c720ca1cffec2ab570d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CProcessServer::CloseLogicalChannel </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Closes device's logical channel.<p>
Close LDD
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00172">172</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="a1e3677c879b6a531f67267ff63ec214"></a><!-- doxytag: member="CProcessServer::SendDataToDevice" ref="a1e3677c879b6a531f67267ff63ec214" args="(TRequestStatus &aStatus, const TDesC8 &aData)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CProcessServer::SendDataToDevice </td>
<td>(</td>
<td class="paramtype">TRequestStatus & </td>
<td class="paramname"> <em>aStatus</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TDesC8 & </td>
<td class="paramname"> <em>aData</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sends data to device asynchronously.<p>
Send data to LDD device <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aStatus</em> </td><td>A TRequestStatus reference </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aData</em> </td><td>Data to be sent </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>KErrNone or standard error code. </dd></dl>
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00186">186</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="853cb371c075e2f74ac3e28a9a66f38e"></a><!-- doxytag: member="CProcessServer::CancelSendData" ref="853cb371c075e2f74ac3e28a9a66f38e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CProcessServer::CancelSendData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cancels send data operation.<p>
Cancel sending data
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00203">203</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="6af5450445ef1f12826f88a24ec83043"></a><!-- doxytag: member="CProcessServer::UpdateDriverState" ref="6af5450445ef1f12826f88a24ec83043" args="(TDriverState aState)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CProcessServer::UpdateDriverState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_process_server.html#82cab30ea5d500e0abc51d39a0889b38">TDriverState</a> </td>
<td class="paramname"> <em>aState</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Updates device state.<p>
Update the states of the driver <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aState</em> </td><td>State of the driver to be updated </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="processserver_8cpp-source.html#l00212">212</a> of file <a class="el" href="processserver_8cpp-source.html">processserver.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:07 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>