Home | History | Annotate | Download | only in oscl_html
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
      2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
      3 <title>OsclRegistryClient class Reference</title>
      4 <link href="doxygen.css" rel="stylesheet" type="text/css">
      5 </head><body>
      6 <!-- Generated by Doxygen 1.2.18 -->
      7 <center>
      8 <a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
      9 <hr><h1>OsclRegistryClient Class Reference<br>
     10 <small>
     11 [<a class="el" href="group__osclutil.html">OSCL Util</a>]</small>
     12 </h1><code>#include &lt;<a class="el" href="oscl__registry__client_8h-source.html">oscl_registry_client.h</a>&gt;</code>
     13 <p>
     14 <p>Inheritance diagram for OsclRegistryClient:
     15 <p><center><img src="classOsclRegistryClient.png" usemap="#OsclRegistryClient_map" border="0" alt=""></center>
     16 <map name="OsclRegistryClient_map">
     17 <area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,116,80">
     18 <area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,116,24">
     19 </map>
     20 <table border=0 cellpadding=0 cellspacing=0>
     21 <tr><td></td></tr>
     22 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
     23 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF&nbsp;</td><td valign=bottom><a class="el" href="classOsclRegistryClient.html#a0">OsclRegistryClient</a> ()</td></tr>
     24 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF&nbsp;</td><td valign=bottom><a class="el" href="classOsclRegistryClient.html#a1">~OsclRegistryClient</a> ()</td></tr>
     25 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclRegistryClient.html#a2">Connect</a> (bool aPerThread=false)</td></tr>
     26 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclRegistryClient.html#a3">Register</a> (<a class="el" href="classOSCL__String.html">OSCL_String</a> &amp;aComponentID, <a class="el" href="group__osclutil.html#a0">OsclComponentFactory</a> aFactory)</td></tr>
     27 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32&nbsp;</td><td valign=bottom><a class="el" href="classOsclRegistryClient.html#a4">UnRegister</a> (<a class="el" href="classOSCL__String.html">OSCL_String</a> &amp;aComponentID)</td></tr>
     28 <tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void&nbsp;</td><td valign=bottom><a class="el" href="classOsclRegistryClient.html#a5">Close</a> ()</td></tr>
     29 </table>
     30 <hr><h2>Constructor &amp; Destructor Documentation</h2>
     31 <a name="a0" doxytag="OsclRegistryClient::OsclRegistryClient"></a><p>
     32 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     33   <tr>
     34     <td class="md">
     35       <table cellpadding="0" cellspacing="0" border="0">
     36         <tr>
     37           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclRegistryClient::OsclRegistryClient </td>
     38           <td class="md" valign="top">(&nbsp;</td>
     39           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     40           <td class="md" valign="top">)&nbsp;</td>
     41           <td class="md" nowrap></td>
     42         </tr>
     43 
     44       </table>
     45     </td>
     46   </tr>
     47 </table>
     48 <table cellspacing=5 cellpadding=0 border=0>
     49   <tr>
     50     <td>
     51       &nbsp;
     52     </td>
     53     <td>
     54 
     55 <p>
     56     </td>
     57   </tr>
     58 </table>
     59 <a name="a1" doxytag="OsclRegistryClient::~OsclRegistryClient"></a><p>
     60 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     61   <tr>
     62     <td class="md">
     63       <table cellpadding="0" cellspacing="0" border="0">
     64         <tr>
     65           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclRegistryClient::~OsclRegistryClient </td>
     66           <td class="md" valign="top">(&nbsp;</td>
     67           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     68           <td class="md" valign="top">)&nbsp;</td>
     69           <td class="md" nowrap></td>
     70         </tr>
     71 
     72       </table>
     73     </td>
     74   </tr>
     75 </table>
     76 <table cellspacing=5 cellpadding=0 border=0>
     77   <tr>
     78     <td>
     79       &nbsp;
     80     </td>
     81     <td>
     82 
     83 <p>
     84     </td>
     85   </tr>
     86 </table>
     87 <hr><h2>Member Function Documentation</h2>
     88 <a name="a5" doxytag="OsclRegistryClient::Close"></a><p>
     89 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     90   <tr>
     91     <td class="md">
     92       <table cellpadding="0" cellspacing="0" border="0">
     93         <tr>
     94           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclRegistryClient::Close </td>
     95           <td class="md" valign="top">(&nbsp;</td>
     96           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     97           <td class="md" valign="top">)&nbsp;</td>
     98           <td class="md" nowrap></td>
     99         </tr>
    100 
    101       </table>
    102     </td>
    103   </tr>
    104 </table>
    105 <table cellspacing=5 cellpadding=0 border=0>
    106   <tr>
    107     <td>
    108       &nbsp;
    109     </td>
    110     <td>
    111 
    112 <p>
    113 Close and cleanup. All components registered in this session are are automatically unregistered.     </td>
    114   </tr>
    115 </table>
    116 <a name="a2" doxytag="OsclRegistryClient::Connect"></a><p>
    117 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    118   <tr>
    119     <td class="md">
    120       <table cellpadding="0" cellspacing="0" border="0">
    121         <tr>
    122           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 OsclRegistryClient::Connect </td>
    123           <td class="md" valign="top">(&nbsp;</td>
    124           <td class="md" nowrap valign="top">bool&nbsp;</td>
    125           <td class="mdname1" valign="top" nowrap>&nbsp; <em>aPerThread</em> = false          </td>
    126           <td class="md" valign="top">)&nbsp;</td>
    127           <td class="md" nowrap></td>
    128         </tr>
    129 
    130       </table>
    131     </td>
    132   </tr>
    133 </table>
    134 <table cellspacing=5 cellpadding=0 border=0>
    135   <tr>
    136     <td>
    137       &nbsp;
    138     </td>
    139     <td>
    140 
    141 <p>
    142 Create a session. <dl compact><dt><b>Parameters: </b></dt><dd>
    143 <table border=0 cellspacing=2 cellpadding=0>
    144 <tr><td valign=top><em>aPerThread:</em>&nbsp;</td><td>
    145 Select per-thread registry instead of global registry. </td></tr>
    146 </table>
    147 </dl><dl compact><dt><b>Returns: </b></dt><dd>
    148 OsclErrNone on success. </dl>    </td>
    149   </tr>
    150 </table>
    151 <a name="a3" doxytag="OsclRegistryClient::Register"></a><p>
    152 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    153   <tr>
    154     <td class="md">
    155       <table cellpadding="0" cellspacing="0" border="0">
    156         <tr>
    157           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 OsclRegistryClient::Register </td>
    158           <td class="md" valign="top">(&nbsp;</td>
    159           <td class="md" nowrap valign="top"><a class="el" href="classOSCL__String.html">OSCL_String</a> &amp;&nbsp;</td>
    160           <td class="mdname" nowrap>&nbsp; <em>aComponentID</em>, </td>
    161         </tr>
    162         <tr>
    163           <td></td>
    164           <td></td>
    165           <td class="md" nowrap><a class="el" href="group__osclutil.html#a0">OsclComponentFactory</a>&nbsp;</td>
    166           <td class="mdname" nowrap>&nbsp; <em>aFactory</em></td>
    167         </tr>
    168         <tr>
    169           <td></td>
    170           <td class="md">)&nbsp;</td>
    171           <td class="md" colspan="2"></td>
    172         </tr>
    173 
    174       </table>
    175     </td>
    176   </tr>
    177 </table>
    178 <table cellspacing=5 cellpadding=0 border=0>
    179   <tr>
    180     <td>
    181       &nbsp;
    182     </td>
    183     <td>
    184 
    185 <p>
    186 Register a component factory by registry ID and component ID.<dl compact><dt><b>Parameters: </b></dt><dd>
    187 <table border=0 cellspacing=2 cellpadding=0>
    188 <tr><td valign=top><em>aComponentID:</em>&nbsp;</td><td>
    189 registry + component mime-string. </td></tr>
    190 <tr><td valign=top><em>aFactory:</em>&nbsp;</td><td>
    191 factory function pointer. </td></tr>
    192 <tr><td valign=top><em>aParam:</em>&nbsp;</td><td>
    193 component Create param. </td></tr>
    194 </table>
    195 </dl><dl compact><dt><b>Returns: </b></dt><dd>
    196 OsclErrNone on success. </dl>    </td>
    197   </tr>
    198 </table>
    199 <a name="a4" doxytag="OsclRegistryClient::UnRegister"></a><p>
    200 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    201   <tr>
    202     <td class="md">
    203       <table cellpadding="0" cellspacing="0" border="0">
    204         <tr>
    205           <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 OsclRegistryClient::UnRegister </td>
    206           <td class="md" valign="top">(&nbsp;</td>
    207           <td class="md" nowrap valign="top"><a class="el" href="classOSCL__String.html">OSCL_String</a> &amp;&nbsp;</td>
    208           <td class="mdname1" valign="top" nowrap>&nbsp; <em>aComponentID</em>          </td>
    209           <td class="md" valign="top">)&nbsp;</td>
    210           <td class="md" nowrap></td>
    211         </tr>
    212 
    213       </table>
    214     </td>
    215   </tr>
    216 </table>
    217 <table cellspacing=5 cellpadding=0 border=0>
    218   <tr>
    219     <td>
    220       &nbsp;
    221     </td>
    222     <td>
    223 
    224 <p>
    225 Unregister a previously registered component. <dl compact><dt><b>Returns: </b></dt><dd>
    226 OsclErrNone on success. </dl>    </td>
    227   </tr>
    228 </table>
    229 <hr>The documentation for this class was generated from the following file:<ul>
    230 <li><a class="el" href="oscl__registry__client_8h-source.html">oscl_registry_client.h</a></ul>
    231 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
    232 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
    233 </small></address>
    234 </body>
    235 </html>
    236