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> TemplateOsclTLS&lt; T, ID, Registry &gt; 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>OsclTLS&lt; T, ID, Registry &gt; Class Template Reference<br>
     10 <small>
     11 [<a class="el" href="group__osclbase.html">OSCL Base</a>]</small>
     12 </h1><code>#include &lt;<a class="el" href="oscl__tls_8h-source.html">oscl_tls.h</a>&gt;</code>
     13 <p>
     14 <table border=0 cellpadding=0 cellspacing=0>
     15 <tr><td></td></tr>
     16 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
     17 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclTLS.html#a0">OsclTLS</a> ()</td></tr>
     18 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOsclTLS.html#a1">~OsclTLS</a> ()</td></tr>
     19 <tr><td nowrap align=right valign=top>T &amp;&nbsp;</td><td valign=bottom><a class="el" href="classOsclTLS.html#a2">operator *</a> () const</td></tr>
     20 <tr><td>&nbsp;</td><td><font size=-1><em>The indirection operator (*) accesses a value indirectly, through a pointer.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
     21 <tr><td nowrap align=right valign=top>T *&nbsp;</td><td valign=bottom><a class="el" href="classOsclTLS.html#a3">operator-&gt;</a> () const</td></tr>
     22 <tr><td>&nbsp;</td><td><font size=-1><em>The indirection operator (-&gt;) accesses a value indirectly, through a pointer.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
     23 <tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classOsclTLS.html#a4">set</a> ()</td></tr>
     24 <tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classOsclTLS.html#a4">set()</a> method sets ownership to the pointer, passed. This method is needed when the class is created with a default constructor. Returns false in case the class is non-empty.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
     25 <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
     26 <tr><td nowrap align=right valign=top>T *&nbsp;</td><td valign=bottom><a class="el" href="classOsclTLS.html#n0">_Ptr</a></td></tr>
     27 </table>
     28 <h3>template&lt;class T, uint32 ID, class Registry = OsclTLSRegistry&gt;<br>
     29  class OsclTLS&lt; T, ID, Registry &gt;</h3>
     30 
     31 <hr><h2>Constructor &amp; Destructor Documentation</h2>
     32 <a name="a0" doxytag="OsclTLS::OsclTLS"></a><p>
     33 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     34   <tr>
     35     <td class="md">
     36       <table cellpadding="0" cellspacing="0" border="0">
     37         <tr>
     38           <td class="md" colspan="4">
     39 template&lt;class T, uint32 ID, class Registry = OsclTLSRegistry&gt; </td>
     40         </tr>
     41         <tr>
     42           <td class="md" nowrap valign="top"> OsclTLS&lt; T, ID, Registry &gt;::OsclTLS </td>
     43           <td class="md" valign="top">(&nbsp;</td>
     44           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     45           <td class="md" valign="top">)&nbsp;</td>
     46           <td class="md" nowrap><code> [inline]</code></td>
     47         </tr>
     48 
     49       </table>
     50     </td>
     51   </tr>
     52 </table>
     53 <table cellspacing=5 cellpadding=0 border=0>
     54   <tr>
     55     <td>
     56       &nbsp;
     57     </td>
     58     <td>
     59 
     60 <p>
     61     </td>
     62   </tr>
     63 </table>
     64 <a name="a1" doxytag="OsclTLS::~OsclTLS"></a><p>
     65 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     66   <tr>
     67     <td class="md">
     68       <table cellpadding="0" cellspacing="0" border="0">
     69         <tr>
     70           <td class="md" colspan="4">
     71 template&lt;class T, uint32 ID, class Registry = OsclTLSRegistry&gt; </td>
     72         </tr>
     73         <tr>
     74           <td class="md" nowrap valign="top"> OsclTLS&lt; T, ID, Registry &gt;::~OsclTLS </td>
     75           <td class="md" valign="top">(&nbsp;</td>
     76           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     77           <td class="md" valign="top">)&nbsp;</td>
     78           <td class="md" nowrap><code> [inline]</code></td>
     79         </tr>
     80 
     81       </table>
     82     </td>
     83   </tr>
     84 </table>
     85 <table cellspacing=5 cellpadding=0 border=0>
     86   <tr>
     87     <td>
     88       &nbsp;
     89     </td>
     90     <td>
     91 
     92 <p>
     93     </td>
     94   </tr>
     95 </table>
     96 <hr><h2>Member Function Documentation</h2>
     97 <a name="a2" doxytag="OsclTLS::operator *"></a><p>
     98 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     99   <tr>
    100     <td class="md">
    101       <table cellpadding="0" cellspacing="0" border="0">
    102         <tr>
    103           <td class="md" colspan="4">
    104 template&lt;class T, uint32 ID, class Registry = OsclTLSRegistry&gt; </td>
    105         </tr>
    106         <tr>
    107           <td class="md" nowrap valign="top"> T&amp; OsclTLS&lt; T, ID, Registry &gt;::operator * </td>
    108           <td class="md" valign="top">(&nbsp;</td>
    109           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    110           <td class="md" valign="top">)&nbsp;</td>
    111           <td class="md" nowrap> const<code> [inline]</code></td>
    112         </tr>
    113 
    114       </table>
    115     </td>
    116   </tr>
    117 </table>
    118 <table cellspacing=5 cellpadding=0 border=0>
    119   <tr>
    120     <td>
    121       &nbsp;
    122     </td>
    123     <td>
    124 
    125 <p>
    126 The indirection operator (*) accesses a value indirectly, through a pointer.
    127 <p>
    128 This operator ensures that the OsclTLS can be used like the regular pointer that it was initialized with.     </td>
    129   </tr>
    130 </table>
    131 <a name="a3" doxytag="OsclTLS::operator->"></a><p>
    132 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    133   <tr>
    134     <td class="md">
    135       <table cellpadding="0" cellspacing="0" border="0">
    136         <tr>
    137           <td class="md" colspan="4">
    138 template&lt;class T, uint32 ID, class Registry = OsclTLSRegistry&gt; </td>
    139         </tr>
    140         <tr>
    141           <td class="md" nowrap valign="top"> T* OsclTLS&lt; T, ID, Registry &gt;::operator-&gt; </td>
    142           <td class="md" valign="top">(&nbsp;</td>
    143           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    144           <td class="md" valign="top">)&nbsp;</td>
    145           <td class="md" nowrap> const<code> [inline]</code></td>
    146         </tr>
    147 
    148       </table>
    149     </td>
    150   </tr>
    151 </table>
    152 <table cellspacing=5 cellpadding=0 border=0>
    153   <tr>
    154     <td>
    155       &nbsp;
    156     </td>
    157     <td>
    158 
    159 <p>
    160 The indirection operator (-&gt;) accesses a value indirectly, through a pointer.
    161 <p>
    162 This operator ensures that the OsclTLS can be used like the regular pointer that it was initialized with.     </td>
    163   </tr>
    164 </table>
    165 <a name="a4" doxytag="OsclTLS::set"></a><p>
    166 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    167   <tr>
    168     <td class="md">
    169       <table cellpadding="0" cellspacing="0" border="0">
    170         <tr>
    171           <td class="md" colspan="4">
    172 template&lt;class T, uint32 ID, class Registry = OsclTLSRegistry&gt; </td>
    173         </tr>
    174         <tr>
    175           <td class="md" nowrap valign="top"> bool OsclTLS&lt; T, ID, Registry &gt;::set </td>
    176           <td class="md" valign="top">(&nbsp;</td>
    177           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    178           <td class="md" valign="top">)&nbsp;</td>
    179           <td class="md" nowrap><code> [inline]</code></td>
    180         </tr>
    181 
    182       </table>
    183     </td>
    184   </tr>
    185 </table>
    186 <table cellspacing=5 cellpadding=0 border=0>
    187   <tr>
    188     <td>
    189       &nbsp;
    190     </td>
    191     <td>
    192 
    193 <p>
    194 <a class="el" href="classOsclTLS.html#a4">set()</a> method sets ownership to the pointer, passed. This method is needed when the class is created with a default constructor. Returns false in case the class is non-empty.
    195 <p>
    196     </td>
    197   </tr>
    198 </table>
    199 <hr><h2>Field Documentation</h2>
    200 <a name="n0" doxytag="OsclTLS::_Ptr"></a><p>
    201 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    202   <tr>
    203     <td class="md">
    204       <table cellpadding="0" cellspacing="0" border="0">
    205         <tr>
    206           <td class="md" colspan="4">
    207 template&lt;class T, uint32 ID, class Registry = OsclTLSRegistry&gt; </td>
    208         </tr>
    209         <tr>
    210           <td class="md" nowrap valign="top"> T* OsclTLS&lt; T, ID, Registry &gt;::_Ptr<code> [protected]</code>
    211       </table>
    212     </td>
    213   </tr>
    214 </table>
    215 <table cellspacing=5 cellpadding=0 border=0>
    216   <tr>
    217     <td>
    218       &nbsp;
    219     </td>
    220     <td>
    221 
    222 <p>
    223     </td>
    224   </tr>
    225 </table>
    226 <hr>The documentation for this class was generated from the following file:<ul>
    227 <li><a class="el" href="oscl__tls_8h-source.html">oscl_tls.h</a></ul>
    228 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
    229 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
    230 </small></address>
    231 </body>
    232 </html>
    233