Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_count_server.html
changeset 1 25a17d01db0c
equal deleted inserted replaced
0:89d6a7a84779 1:25a17d01db0c
       
     1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
       
     2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
       
     3 <title>TB10.1 Example Applications: CCountServer Class Reference</title>
       
     4 <link href="doxygen.css" rel="stylesheet" type="text/css">
       
     5 <link href="tabs.css" rel="stylesheet" type="text/css">
       
     6 </head><body>
       
     7 <!-- Generated by Doxygen 1.5.3 -->
       
     8 <h1>CCountServer Class Reference</h1><!-- doxytag: class="CCountServer" -->
       
     9 <p>
       
    10 <a href="class_c_count_server-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
       
    11 <tr><td></td></tr>
       
    12 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
       
    13 <tr><td class="memItemLeft" nowrap align="right" valign="top">CSession2 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_server.html#a55cc54931277a7c76e44a8186b301a8">NewSessionL</a> (const TVersion &amp;aVersion, const RMessage2 &amp;aMessage) const </td></tr>
       
    14 
       
    15 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_server.html#dc5003c1adc92839e6743fcfb2782efa">CCountServer</a> (CActive::TPriority aActiveObjectPriority)</td></tr>
       
    16 
       
    17 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_server.html#3e529e2d1826c0f37c1f4b73cb1d47c9">ConstructL</a> ()</td></tr>
       
    18 
       
    19 <tr><td class="memItemLeft" nowrap align="right" valign="top">CObjectCon *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_server.html#dd42ceba100b3d65f508594b8dc3d13d">NewContainerL</a> ()</td></tr>
       
    20 
       
    21 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_server.html#c09307b31906fc20f310cdc927f22ebf">RemoveContainer</a> (CObjectCon *aCon)</td></tr>
       
    22 
       
    23 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_server.html#aa466d3a10b261f7826f84adf2523b02">~CCountServer</a> ()</td></tr>
       
    24 
       
    25 <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
       
    26 <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_count_server.html">CCountServer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_server.html#d4980524fee227b1ba035b04ecf2cc69">NewL</a> (CActive::TPriority aActiveObjectPriority)</td></tr>
       
    27 
       
    28 <tr><td class="memItemLeft" nowrap align="right" valign="top">static TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_server.html#1e24101970d13e02f3a277a59f26fa67">ThreadFunction</a> (TAny *aStarted)</td></tr>
       
    29 
       
    30 <tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_count_server.html#ac484db8302f90f30a1fbc345412821f">PanicServer</a> (TCountServPanic aPanic)</td></tr>
       
    31 
       
    32 </table>
       
    33 <hr><a name="_details"></a><h2>Detailed Description</h2>
       
    34 
       
    35 <p>Definition at line <a class="el" href="_complex_server_8h-source.html#l00048">48</a> of file <a class="el" href="_complex_server_8h-source.html">ComplexServer.h</a>.</p>
       
    36 <hr><h2>Constructor &amp; Destructor Documentation</h2>
       
    37 <a class="anchor" name="dc5003c1adc92839e6743fcfb2782efa"></a><!-- doxytag: member="CCountServer::CCountServer" ref="dc5003c1adc92839e6743fcfb2782efa" args="(CActive::TPriority aActiveObjectPriority)" -->
       
    38 <div class="memitem">
       
    39 <div class="memproto">
       
    40       <table class="memname">
       
    41         <tr>
       
    42           <td class="memname">CCountServer::CCountServer           </td>
       
    43           <td>(</td>
       
    44           <td class="paramtype">CActive::TPriority&nbsp;</td>
       
    45           <td class="paramname"> <em>aActiveObjectPriority</em>          </td>
       
    46           <td>&nbsp;)&nbsp;</td>
       
    47           <td width="100%"></td>
       
    48         </tr>
       
    49       </table>
       
    50 </div>
       
    51 <div class="memdoc">
       
    52 
       
    53 <p>
       
    54 Constructor takes the server priority value.<p>
       
    55 The server is an active object, and the priority value is the priority of this active object.<p>
       
    56 It passes the priority value to the base class in the Ctor list. By default, the session is not sharable, which is what we want here so no second parameter is passed to the CServer2 constructor. 
       
    57 <p>Definition at line <a class="el" href="_complex_server_c_count_server_8cpp-source.html#l00083">83</a> of file <a class="el" href="_complex_server_c_count_server_8cpp-source.html">ComplexServerCCountServer.cpp</a>.</p>
       
    58 
       
    59 </div>
       
    60 </div><p>
       
    61 <a class="anchor" name="aa466d3a10b261f7826f84adf2523b02"></a><!-- doxytag: member="CCountServer::~CCountServer" ref="aa466d3a10b261f7826f84adf2523b02" args="()" -->
       
    62 <div class="memitem">
       
    63 <div class="memproto">
       
    64       <table class="memname">
       
    65         <tr>
       
    66           <td class="memname">CCountServer::~CCountServer           </td>
       
    67           <td>(</td>
       
    68           <td class="paramname">          </td>
       
    69           <td>&nbsp;)&nbsp;</td>
       
    70           <td width="100%"></td>
       
    71         </tr>
       
    72       </table>
       
    73 </div>
       
    74 <div class="memdoc">
       
    75 
       
    76 <p>
       
    77 Desctructor - deletes the object container index. 
       
    78 <p>Definition at line <a class="el" href="_complex_server_c_count_server_8cpp-source.html#l00101">101</a> of file <a class="el" href="_complex_server_c_count_server_8cpp-source.html">ComplexServerCCountServer.cpp</a>.</p>
       
    79 
       
    80 </div>
       
    81 </div><p>
       
    82 <hr><h2>Member Function Documentation</h2>
       
    83 <a class="anchor" name="a55cc54931277a7c76e44a8186b301a8"></a><!-- doxytag: member="CCountServer::NewSessionL" ref="a55cc54931277a7c76e44a8186b301a8" args="(const TVersion &amp;aVersion, const RMessage2 &amp;aMessage) const " -->
       
    84 <div class="memitem">
       
    85 <div class="memproto">
       
    86       <table class="memname">
       
    87         <tr>
       
    88           <td class="memname">CSession2 * CCountServer::NewSessionL           </td>
       
    89           <td>(</td>
       
    90           <td class="paramtype">const TVersion &amp;&nbsp;</td>
       
    91           <td class="paramname"> <em>aVersion</em>, </td>
       
    92         </tr>
       
    93         <tr>
       
    94           <td class="paramkey"></td>
       
    95           <td></td>
       
    96           <td class="paramtype">const RMessage2 &amp;&nbsp;</td>
       
    97           <td class="paramname"> <em>aMessage</em></td><td>&nbsp;</td>
       
    98         </tr>
       
    99         <tr>
       
   100           <td></td>
       
   101           <td>)</td>
       
   102           <td></td><td></td><td width="100%"> const</td>
       
   103         </tr>
       
   104       </table>
       
   105 </div>
       
   106 <div class="memdoc">
       
   107 
       
   108 <p>
       
   109 Creates a new session with the server. 
       
   110 <p>Definition at line <a class="el" href="_complex_server_c_count_server_8cpp-source.html#l00110">110</a> of file <a class="el" href="_complex_server_c_count_server_8cpp-source.html">ComplexServerCCountServer.cpp</a>.</p>
       
   111 
       
   112 </div>
       
   113 </div><p>
       
   114 <a class="anchor" name="d4980524fee227b1ba035b04ecf2cc69"></a><!-- doxytag: member="CCountServer::NewL" ref="d4980524fee227b1ba035b04ecf2cc69" args="(CActive::TPriority aActiveObjectPriority)" -->
       
   115 <div class="memitem">
       
   116 <div class="memproto">
       
   117       <table class="memname">
       
   118         <tr>
       
   119           <td class="memname"><a class="el" href="class_c_count_server.html">CCountServer</a> * CCountServer::NewL           </td>
       
   120           <td>(</td>
       
   121           <td class="paramtype">CActive::TPriority&nbsp;</td>
       
   122           <td class="paramname"> <em>aActiveObjectPriority</em>          </td>
       
   123           <td>&nbsp;)&nbsp;</td>
       
   124           <td width="100%"><code> [static]</code></td>
       
   125         </tr>
       
   126       </table>
       
   127 </div>
       
   128 <div class="memdoc">
       
   129 
       
   130 <p>
       
   131 First phase construction 
       
   132 <p>Definition at line <a class="el" href="_complex_server_c_count_server_8cpp-source.html#l00041">41</a> of file <a class="el" href="_complex_server_c_count_server_8cpp-source.html">ComplexServerCCountServer.cpp</a>.</p>
       
   133 
       
   134 </div>
       
   135 </div><p>
       
   136 <a class="anchor" name="1e24101970d13e02f3a277a59f26fa67"></a><!-- doxytag: member="CCountServer::ThreadFunction" ref="1e24101970d13e02f3a277a59f26fa67" args="(TAny *aStarted)" -->
       
   137 <div class="memitem">
       
   138 <div class="memproto">
       
   139       <table class="memname">
       
   140         <tr>
       
   141           <td class="memname">TInt CCountServer::ThreadFunction           </td>
       
   142           <td>(</td>
       
   143           <td class="paramtype">TAny *&nbsp;</td>
       
   144           <td class="paramname"> <em>aStarted</em>          </td>
       
   145           <td>&nbsp;)&nbsp;</td>
       
   146           <td width="100%"><code> [static]</code></td>
       
   147         </tr>
       
   148       </table>
       
   149 </div>
       
   150 <div class="memdoc">
       
   151 
       
   152 <p>
       
   153 The count server thread function that initialises the server. <dl compact><dt><b>Parameters: </b></dt><dd>
       
   154 <table border="0" cellspacing="2" cellpadding="0">
       
   155 <tr><td valign="top"><em>aStarted</em>&nbsp;</td><td>
       
   156 aStarted </td></tr>
       
   157 </table>
       
   158 </dl>
       
   159 <p>Definition at line <a class="el" href="_complex_server_8cpp-source.html#l00030">30</a> of file <a class="el" href="_complex_server_8cpp-source.html">ComplexServer.cpp</a>.</p>
       
   160 
       
   161 </div>
       
   162 </div><p>
       
   163 <a class="anchor" name="ac484db8302f90f30a1fbc345412821f"></a><!-- doxytag: member="CCountServer::PanicServer" ref="ac484db8302f90f30a1fbc345412821f" args="(TCountServPanic aPanic)" -->
       
   164 <div class="memitem">
       
   165 <div class="memproto">
       
   166       <table class="memname">
       
   167         <tr>
       
   168           <td class="memname">void CCountServer::PanicServer           </td>
       
   169           <td>(</td>
       
   170           <td class="paramtype">TCountServPanic&nbsp;</td>
       
   171           <td class="paramname"> <em>aPanic</em>          </td>
       
   172           <td>&nbsp;)&nbsp;</td>
       
   173           <td width="100%"><code> [static]</code></td>
       
   174         </tr>
       
   175       </table>
       
   176 </div>
       
   177 <div class="memdoc">
       
   178 
       
   179 <p>
       
   180 A utility function to panic the server. 
       
   181 <p>Definition at line <a class="el" href="_complex_server_c_count_server_8cpp-source.html#l00031">31</a> of file <a class="el" href="_complex_server_c_count_server_8cpp-source.html">ComplexServerCCountServer.cpp</a>.</p>
       
   182 
       
   183 </div>
       
   184 </div><p>
       
   185 <a class="anchor" name="3e529e2d1826c0f37c1f4b73cb1d47c9"></a><!-- doxytag: member="CCountServer::ConstructL" ref="3e529e2d1826c0f37c1f4b73cb1d47c9" args="()" -->
       
   186 <div class="memitem">
       
   187 <div class="memproto">
       
   188       <table class="memname">
       
   189         <tr>
       
   190           <td class="memname">void CCountServer::ConstructL           </td>
       
   191           <td>(</td>
       
   192           <td class="paramname">          </td>
       
   193           <td>&nbsp;)&nbsp;</td>
       
   194           <td width="100%"></td>
       
   195         </tr>
       
   196       </table>
       
   197 </div>
       
   198 <div class="memdoc">
       
   199 
       
   200 <p>
       
   201 Second-phase constructor - creates the object container index. 
       
   202 <p>Definition at line <a class="el" href="_complex_server_c_count_server_8cpp-source.html#l00092">92</a> of file <a class="el" href="_complex_server_c_count_server_8cpp-source.html">ComplexServerCCountServer.cpp</a>.</p>
       
   203 
       
   204 </div>
       
   205 </div><p>
       
   206 <a class="anchor" name="dd42ceba100b3d65f508594b8dc3d13d"></a><!-- doxytag: member="CCountServer::NewContainerL" ref="dd42ceba100b3d65f508594b8dc3d13d" args="()" -->
       
   207 <div class="memitem">
       
   208 <div class="memproto">
       
   209       <table class="memname">
       
   210         <tr>
       
   211           <td class="memname">CObjectCon * CCountServer::NewContainerL           </td>
       
   212           <td>(</td>
       
   213           <td class="paramname">          </td>
       
   214           <td>&nbsp;)&nbsp;</td>
       
   215           <td width="100%"></td>
       
   216         </tr>
       
   217       </table>
       
   218 </div>
       
   219 <div class="memdoc">
       
   220 
       
   221 <p>
       
   222 Creates and returns a new object container using the server's object container index.<p>
       
   223 This is a service that is used by a session. 
       
   224 <p>Definition at line <a class="el" href="_complex_server_c_count_server_8cpp-source.html#l00057">57</a> of file <a class="el" href="_complex_server_c_count_server_8cpp-source.html">ComplexServerCCountServer.cpp</a>.</p>
       
   225 
       
   226 </div>
       
   227 </div><p>
       
   228 <a class="anchor" name="c09307b31906fc20f310cdc927f22ebf"></a><!-- doxytag: member="CCountServer::RemoveContainer" ref="c09307b31906fc20f310cdc927f22ebf" args="(CObjectCon *aCon)" -->
       
   229 <div class="memitem">
       
   230 <div class="memproto">
       
   231       <table class="memname">
       
   232         <tr>
       
   233           <td class="memname">void CCountServer::RemoveContainer           </td>
       
   234           <td>(</td>
       
   235           <td class="paramtype">CObjectCon *&nbsp;</td>
       
   236           <td class="paramname"> <em>aCon</em>          </td>
       
   237           <td>&nbsp;)&nbsp;</td>
       
   238           <td width="100%"></td>
       
   239         </tr>
       
   240       </table>
       
   241 </div>
       
   242 <div class="memdoc">
       
   243 
       
   244 <p>
       
   245 Removes the object container using the server's object container index. This is a service that is used by a session. 
       
   246 <p>Definition at line <a class="el" href="_complex_server_c_count_server_8cpp-source.html#l00067">67</a> of file <a class="el" href="_complex_server_c_count_server_8cpp-source.html">ComplexServerCCountServer.cpp</a>.</p>
       
   247 
       
   248 </div>
       
   249 </div><p>
       
   250 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:03 2010 for TB10.1 Example Applications by&nbsp;
       
   251 <a href="http://www.doxygen.org/index.html">
       
   252 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
       
   253 </body>
       
   254 </html>