Changeset 62 in flair-dev for trunk/doc/Flair/classflair_1_1core_1_1_shared_mem.html

Timestamp:

01/09/18 11:44:14 (6 years ago)

Author:

Sanahuja Guillaume

Message:

m

File:

• trunk/doc/Flair/classflair_1_1core_1_1_shared_mem.html (modified) (6 diffs)

trunk/doc/Flair/classflair_1_1core_1_1_shared_mem.html

@@ -158 +158 @@
 <tr class="memdesc:a7609d68ab9155055bea84cafaf741392"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write.  <a href="#a7609d68ab9155055bea84cafaf741392">More...</a><br /></td></tr>
 <tr class="separator:a7609d68ab9155055bea84cafaf741392"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a9b3efaf91b3a62a58d4466bcaa03b590"><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#a9b3efaf91b3a62a58d4466bcaa03b590">Read</a> (char *buf, size_t size) const </td></tr>
-<tr class="memdesc:a9b3efaf91b3a62a58d4466bcaa03b590"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read.  <a href="#a9b3efaf91b3a62a58d4466bcaa03b590">More...</a><br /></td></tr>
-<tr class="separator:a9b3efaf91b3a62a58d4466bcaa03b590"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a834ba5f2d06345b0125f7ba8b66391b6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_shared_mem.html#a834ba5f2d06345b0125f7ba8b66391b6">Read</a> (char *buf, size_t size, <a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> nsTimeout=TIME_INFINITE) const </td></tr>
+<tr class="memdesc:a834ba5f2d06345b0125f7ba8b66391b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read.  <a href="#a834ba5f2d06345b0125f7ba8b66391b6">More...</a><br /></td></tr>
+<tr class="separator:a834ba5f2d06345b0125f7ba8b66391b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
-<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>
+<tr class="memdesc:aead806d7b3e48aecefcbb3dcd724ef49"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function should be called when reader is ready (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>
 <tr class="separator:aead806d7b3e48aecefcbb3dcd724ef49"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
@@ -201 +201 @@
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Class defining a shared memory. </p>
-<p>Shared memory is identified by its name so it can be accessed by another processus using its name. </p>
+<p>Shared memory is identified by its name so it can be accessed by another process using its name. </p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" id="a003b9e48b88ac57bb7255b80f7768d9f"></a>
@@ -306 +306 @@
 </div>
 </div>
-<a class="anchor" id="a9b3efaf91b3a62a58d4466bcaa03b590"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void flair::core::SharedMem::Read </td>
+<a class="anchor" id="a834ba5f2d06345b0125f7ba8b66391b6"></a>
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool flair::core::SharedMem::Read </td>
           <td>(</td>
           <td class="paramtype">char *&#160;</td>
@@ -320 +320 @@
           <td></td>
           <td class="paramtype">size_t&#160;</td>
-          <td class="paramname"><em>size</em>&#160;</td>
+          <td class="paramname"><em>size</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
+          <td class="paramname"><em>nsTimeout</em> = <code>TIME_INFINITE</code>&#160;</td>
         </tr>
         <tr>
@@ -354 +360 @@
 </div><div class="memdoc">
 
-<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>
+<p>This function should be called when reader is ready (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>
 
 </div>
@@ -364 +370 @@
   <ul>
     <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>
-    <li class="footer">Generated on Tue Jul 4 2017 07:52:55 for Flair by
+    <li class="footer">Generated on Mon Dec 4 2017 11:13:44 for Flair by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>