Ignore:
Timestamp:
May 31, 2017, 3:54:26 PM (4 years ago)
Author:
Sanahuja Guillaume
Message:

doc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/Flair/classflair_1_1core_1_1_shared_mem.html

    r47 r50  
    109109<div class="header">
    110110  <div class="summary">
     111<a href="#pub-types">Public Types</a> &#124;
    111112<a href="#pub-methods">Public Member Functions</a> &#124;
    112113<a href="classflair_1_1core_1_1_shared_mem-members.html">List of all members</a>  </div>
     
    132133 </div></div>
    133134<table class="memberdecls">
     135<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
     136Public Types</h2></td></tr>
     137<tr class="memitem:ac51e68f77d5ab8dc62e41b90a0a8bff3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac51e68f77d5ab8dc62e41b90a0a8bff3"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>Type</b> { <b>mutex</b>,
     138<b>producerConsumer</b>
     139 }</td></tr>
     140<tr class="separator:ac51e68f77d5ab8dc62e41b90a0a8bff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
     141<tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
     142<tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
     143<b>Red</b> = 31,
     144<b>Green</b> = 32,
     145<b>Orange</b> = 33
     146 }</td></tr>
     147<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
     148</table><table class="memberdecls">
    134149<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
    135150Public Member Functions</h2></td></tr>
    136 <tr class="memitem:aebdd64cb4a190b25d710a3d069fee033"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_shared_mem.html#aebdd64cb4a190b25d710a3d069fee033">SharedMem</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name, size_t size)</td></tr>
    137 <tr class="memdesc:aebdd64cb4a190b25d710a3d069fee033"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aebdd64cb4a190b25d710a3d069fee033">More...</a><br /></td></tr>
    138 <tr class="separator:aebdd64cb4a190b25d710a3d069fee033"><td class="memSeparator" colspan="2">&#160;</td></tr>
     151<tr class="memitem:a003b9e48b88ac57bb7255b80f7768d9f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_shared_mem.html#a003b9e48b88ac57bb7255b80f7768d9f">SharedMem</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name, size_t size, Type type=Type::mutex)</td></tr>
     152<tr class="memdesc:a003b9e48b88ac57bb7255b80f7768d9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a003b9e48b88ac57bb7255b80f7768d9f">More...</a><br /></td></tr>
     153<tr class="separator:a003b9e48b88ac57bb7255b80f7768d9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    139154<tr class="memitem:af3f51c01e679a8dd1f6f7c64cee55ed7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_shared_mem.html#af3f51c01e679a8dd1f6f7c64cee55ed7">~SharedMem</a> ()</td></tr>
    140155<tr class="memdesc:af3f51c01e679a8dd1f6f7c64cee55ed7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#af3f51c01e679a8dd1f6f7c64cee55ed7">More...</a><br /></td></tr>
     
    146161<tr class="memdesc:a9b3efaf91b3a62a58d4466bcaa03b590"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read.  <a href="#a9b3efaf91b3a62a58d4466bcaa03b590">More...</a><br /></td></tr>
    147162<tr class="separator:a9b3efaf91b3a62a58d4466bcaa03b590"><td class="memSeparator" colspan="2">&#160;</td></tr>
     163<tr class="memitem:aead806d7b3e48aecefcbb3dcd724ef49"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_shared_mem.html#aead806d7b3e48aecefcbb3dcd724ef49">ReaderReady</a> ()</td></tr>
     164<tr class="memdesc:aead806d7b3e48aecefcbb3dcd724ef49"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function should be called when reader starts (in case of a <a class="el" href="classflair_1_1core_1_1_shared_mem.html" title="Class defining a shared memory. ">SharedMem</a> of type producerConsumer)  <a href="#aead806d7b3e48aecefcbb3dcd724ef49">More...</a><br /></td></tr>
     165<tr class="separator:aead806d7b3e48aecefcbb3dcd724ef49"><td class="memSeparator" colspan="2">&#160;</td></tr>
    148166<tr class="inherit_header pub_methods_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
    149167<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
     
    180198<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured?  <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
    181199<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
    182 </table><table class="memberdecls">
    183 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
    184 Additional Inherited Members</h2></td></tr>
    185 <tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
    186 <tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
    187 <b>Red</b> = 31,
    188 <b>Green</b> = 32,
    189 <b>Orange</b> = 33
    190  }</td></tr>
    191 <tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
    192200</table>
    193201<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
     
    195203<p>Shared memory is identified by its name so it can be accessed by another processus using its name. </p>
    196204</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    197 <a class="anchor" id="aebdd64cb4a190b25d710a3d069fee033"></a>
     205<a class="anchor" id="a003b9e48b88ac57bb7255b80f7768d9f"></a>
    198206<div class="memitem">
    199207<div class="memproto">
     
    215223          <td></td>
    216224          <td class="paramtype">size_t&#160;</td>
    217           <td class="paramname"><em>size</em>&#160;</td>
     225          <td class="paramname"><em>size</em>, </td>
     226        </tr>
     227        <tr>
     228          <td class="paramkey"></td>
     229          <td></td>
     230          <td class="paramtype">Type&#160;</td>
     231          <td class="paramname"><em>type</em> = <code>Type::mutex</code>&#160;</td>
    218232        </tr>
    219233        <tr>
     
    232246    <tr><td class="paramname">name</td><td>name </td></tr>
    233247    <tr><td class="paramname">size</td><td>size of the shared memory </td></tr>
     248    <tr><td class="paramname">blockOnRead</td><td>if true reading will block if nothing written </td></tr>
    234249  </table>
    235250  </dd>
     
    326341</div>
    327342</div>
     343<a class="anchor" id="aead806d7b3e48aecefcbb3dcd724ef49"></a>
     344<div class="memitem">
     345<div class="memproto">
     346      <table class="memname">
     347        <tr>
     348          <td class="memname">void flair::core::SharedMem::ReaderReady </td>
     349          <td>(</td>
     350          <td class="paramname"></td><td>)</td>
     351          <td></td>
     352        </tr>
     353      </table>
     354</div><div class="memdoc">
     355
     356<p>This function should be called when reader starts (in case of a <a class="el" href="classflair_1_1core_1_1_shared_mem.html" title="Class defining a shared memory. ">SharedMem</a> of type producerConsumer) </p>
     357
     358</div>
     359</div>
    328360</div><!-- contents -->
    329361</div><!-- doc-content -->
     
    332364  <ul>
    333365    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1core.html">core</a></li><li class="navelem"><a class="el" href="classflair_1_1core_1_1_shared_mem.html">SharedMem</a></li>
    334     <li class="footer">Generated on Tue Jan 17 2017 09:52:31 for Flair by
     366    <li class="footer">Generated on Wed May 31 2017 13:50:37 for Flair by
    335367    <a href="http://www.doxygen.org/index.html">
    336368    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note: See TracChangeset for help on using the changeset viewer.