Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_process_server.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: CProcessServer 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>CProcessServer Class Reference</h1><!-- doxytag: class="CProcessServer" --><!-- doxytag: inherits="CServer2" -->
<p>Inherits CServer2.</p>
<p><a href="class_c_process_server-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#a82cab30ea5d500e0abc51d39a0889b38">TDriverState</a> { <br/>
<b>EStateUnknown</b>,
<b>EDriverLoaded</b>,
<b>ELogicalChannelOpened</b>,
<b>ESendingData</b>,
<br/>
<b>ELogicalChannelClosed</b>,
<b>EDriverUnloaded</b>
<br/>
}</td></tr>
<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_process_server.html#af9cff6818110c62a7ad6a1c19984297b">~CProcessServer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">CSession2 * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#a0025005d37f3cc34dc8e181373980ce9">NewSessionL</a> (const TVersion &aVersion, const RMessage2 &aMessage) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#ad113263093aaa3489308e2ecc6f20c87">IncrementRefCount</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#acc9e2e8092c07e6fbf8aa4f866a1ba89">DecrementRefCount</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#a9333ba960d07b42c72d98466b01788ce">LoadDevice</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#a3e78b0766ff78223d4ccf77fa717b269">UnloadDevice</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#a1861af3b7073acf002b55520397c4678">OpenLogicalChannel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#ac381e3ac102f3c720ca1cffec2ab570d">CloseLogicalChannel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#aa1e3677c879b6a531f67267ff63ec214">SendDataToDevice</a> (TRequestStatus &aStatus, const TDesC8 &aData)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#a853cb371c075e2f74ac3e28a9a66f38e">CancelSendData</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#a6af5450445ef1f12826f88a24ec83043">UpdateDriverState</a> (<a class="el" href="class_c_process_server.html#a82cab30ea5d500e0abc51d39a0889b38">TDriverState</a> aState)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_process_server.html#a239278f30e2253b2d0827752355dbef2">NewLC</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Interface for process server. </p>
<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" id="a82cab30ea5d500e0abc51d39a0889b38"></a><!-- doxytag: member="CProcessServer::TDriverState" ref="a82cab30ea5d500e0abc51d39a0889b38" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_c_process_server.html#a82cab30ea5d500e0abc51d39a0889b38">CProcessServer::TDriverState</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enumeration of states of driver. </p>
<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>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af9cff6818110c62a7ad6a1c19984297b"></a><!-- doxytag: member="CProcessServer::~CProcessServer" ref="af9cff6818110c62a7ad6a1c19984297b" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor, The device driver will be unloaded when the server destructor is called.</p>
<p>Destructor </p>
<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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a239278f30e2253b2d0827752355dbef2"></a><!-- doxytag: member="CProcessServer::NewLC" ref="a239278f30e2253b2d0827752355dbef2" 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><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Two phase constructor. </p>
<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>
<a class="anchor" id="a0025005d37f3cc34dc8e181373980ce9"></a><!-- doxytag: member="CProcessServer::NewSessionL" ref="a0025005d37f3cc34dc8e181373980ce9" 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> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a server-side session object. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>CServer2::NewSessionL().</dd></dl>
<p>Creates a new server-side session </p>
<dl><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>
</dd>
</dl>
<dl class="return"><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>
<a class="anchor" id="ad113263093aaa3489308e2ecc6f20c87"></a><!-- doxytag: member="CProcessServer::IncrementRefCount" ref="ad113263093aaa3489308e2ecc6f20c87" 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></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>
<p>Increment the count for the number of clients connected </p>
<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>
<a class="anchor" id="acc9e2e8092c07e6fbf8aa4f866a1ba89"></a><!-- doxytag: member="CProcessServer::DecrementRefCount" ref="acc9e2e8092c07e6fbf8aa4f866a1ba89" 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></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>
<p>Decrement the count for the number of clients connected </p>
<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>
<a class="anchor" id="a9333ba960d07b42c72d98466b01788ce"></a><!-- doxytag: member="CProcessServer::LoadDevice" ref="a9333ba960d07b42c72d98466b01788ce" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads the device, including sample PDD and LDD.</p>
<p>Load both LDD and PDD </p>
<dl class="return"><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>
<a class="anchor" id="a3e78b0766ff78223d4ccf77fa717b269"></a><!-- doxytag: member="CProcessServer::UnloadDevice" ref="a3e78b0766ff78223d4ccf77fa717b269" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unloads the device, including sample LDD and PDD.</p>
<p>Unload both LDD and PDD </p>
<dl class="return"><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>
<a class="anchor" id="a1861af3b7073acf002b55520397c4678"></a><!-- doxytag: member="CProcessServer::OpenLogicalChannel" ref="a1861af3b7073acf002b55520397c4678" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opens device's logical channel.</p>
<p>Open LDD </p>
<dl class="return"><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>
<a class="anchor" id="ac381e3ac102f3c720ca1cffec2ab570d"></a><!-- doxytag: member="CProcessServer::CloseLogicalChannel" ref="ac381e3ac102f3c720ca1cffec2ab570d" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes device's logical channel.</p>
<p>Close LDD </p>
<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>
<a class="anchor" id="aa1e3677c879b6a531f67267ff63ec214"></a><!-- doxytag: member="CProcessServer::SendDataToDevice" ref="aa1e3677c879b6a531f67267ff63ec214" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends data to device asynchronously.</p>
<p>Send data to LDD device </p>
<dl><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>
</dd>
</dl>
<dl class="return"><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>
<a class="anchor" id="a853cb371c075e2f74ac3e28a9a66f38e"></a><!-- doxytag: member="CProcessServer::CancelSendData" ref="a853cb371c075e2f74ac3e28a9a66f38e" 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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancels send data operation.</p>
<p>Cancel sending data </p>
<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>
<a class="anchor" id="a6af5450445ef1f12826f88a24ec83043"></a><!-- doxytag: member="CProcessServer::UpdateDriverState" ref="a6af5450445ef1f12826f88a24ec83043" 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#a82cab30ea5d500e0abc51d39a0889b38">TDriverState</a> </td>
<td class="paramname"> <em>aState</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates device state.</p>
<p>Update the states of the driver </p>
<dl><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>
</dd>
</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>
</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>