MPIonCell/documentation/developer/html/dd/df5/structmoc__message__status__struct.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>MPI On Cell (Documentation): moc_message_status_struct Struct Reference</title>
<link href="../../doxygen.css" rel="stylesheet" type="text/css">
<link href="../../tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="../../main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="../../modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="../../annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="../../files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="../../annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="../../functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>moc_message_status_struct Struct Reference<br>
<small>
[<a class="el" href="../../dd/df8/group__internal__core.html">Implementation-Core</a>]</small>
</h1><!-- doxytag: class="moc_message_status_struct" --><code>#include &lt;<a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for moc_message_status_struct:</div>
<div class="dynsection">
<p><center><img src="../../d6/d2f/structmoc__message__status__struct__coll__graph.png" border="0" usemap="#d2/d60/moc__message__status__struct__coll__map" alt="Collaboration graph"></center>
<center><font size="2">[<a target="top" href="../../graph_legend.html">legend</a>]</font></center></div>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Message-status structure. 
<p>
Is used to store information about the message-status and the buffer used in the message-status-array. 
<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00125">125</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/df5/structmoc__message__status__struct.html#e8c63164c741fbe8af05ab10225f910e">buffer_offset</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">allocated buffer-offset from buffer-base  <a href="#e8c63164c741fbe8af05ab10225f910e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/df5/structmoc__message__status__struct.html#e2130ff455b57d82f77116fca11deb33">message_size</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">size of message in byte  <a href="#e2130ff455b57d82f77116fca11deb33"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/df5/structmoc__message__status__struct.html#d6888b570d01a9f1dfc41e621904d72c">error_value</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">optional error-code of message  <a href="#d6888b570d01a9f1dfc41e621904d72c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap>union {</td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;struct {</td></tr>

<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned int&nbsp;&nbsp;&nbsp;<a class="el" href="../../dd/df5/structmoc__message__status__struct.html#f46ac6349e9244afe9841afed2ec9192">valid</a>: 1</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is this entry valid?  <a href="#28db2fe2edd5c3f8ca7b2783389be766"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned int&nbsp;&nbsp;&nbsp;<a class="el" href="../../dd/df5/structmoc__message__status__struct.html#ac36e005c019f7811b14588ccc8b6ae9">outstanding</a>: 1</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Message is not yet received?  <a href="#98b3ce6621a066f653adc5ce84526766"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned int&nbsp;&nbsp;&nbsp;<a class="el" href="../../dd/df5/structmoc__message__status__struct.html#88a312a8474fb4ad31bb79be8e2704e8">buffer_used</a>: 1</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is Bufferspace used?  <a href="#5bc84fca1bac5f659f942d8703552d71"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;unsigned int&nbsp;&nbsp;&nbsp;<a class="el" href="../../dd/df5/structmoc__message__status__struct.html#7b336d0c92a22d73f5e7585dc7b28a49">reserved</a>: 5</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reserved  <a href="#e46f5d8a371fcdb399c7d4fc4755051e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">&nbsp;&nbsp;&nbsp;}&nbsp;&nbsp;&nbsp;<a class="el" href="../../dd/df5/structmoc__message__status__struct.html#c0bdc214525521d58f12c72874de0512">bits</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">flag-struct  <a href="#d6bed2d588d95cfa44a898cf95a9c1d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap>&nbsp;&nbsp;&nbsp;uint8_t&nbsp;&nbsp;&nbsp;<a class="el" href="../../dd/df5/structmoc__message__status__struct.html#d6c989ccbfc4a74a8c3982a1098c3d78">value</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">union-value  <a href="#bff0b28a1afee508ccf0def0d0b534db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">}&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/df5/structmoc__message__status__struct.html#086c0d449d25774d43512b6f7fdab8ed">flags</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">flag-union  <a href="#086c0d449d25774d43512b6f7fdab8ed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/df5/structmoc__message__status__struct.html#5216df4edcee08127bf6e4147b1a0aef">reserved</a> [3]</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reserved  <a href="#5216df4edcee08127bf6e4147b1a0aef"></a><br></td></tr>
</table>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="e8c63164c741fbe8af05ab10225f910e"></a><!-- doxytag: member="moc_message_status_struct::buffer_offset" ref="e8c63164c741fbe8af05ab10225f910e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#e8c63164c741fbe8af05ab10225f910e">moc_message_status_struct::buffer_offset</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
allocated buffer-offset from buffer-base 
<p>

<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00127">127</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>

<p>Referenced by <a class="el" href="../../d7/d1f/imoc__buffer__malloc_8c-source.html#l00085">IMOC_bmalloc()</a>.</p>

</div>
</div><p>
<a class="anchor" name="e2130ff455b57d82f77116fca11deb33"></a><!-- doxytag: member="moc_message_status_struct::message_size" ref="e2130ff455b57d82f77116fca11deb33" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#e2130ff455b57d82f77116fca11deb33">moc_message_status_struct::message_size</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
size of message in byte 
<p>

<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00128">128</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>

<p>Referenced by <a class="el" href="../../d7/d1f/imoc__buffer__malloc_8c-source.html#l00085">IMOC_bmalloc()</a>.</p>

</div>
</div><p>
<a class="anchor" name="d6888b570d01a9f1dfc41e621904d72c"></a><!-- doxytag: member="moc_message_status_struct::error_value" ref="d6888b570d01a9f1dfc41e621904d72c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#d6888b570d01a9f1dfc41e621904d72c">moc_message_status_struct::error_value</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
optional error-code of message 
<p>

<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00129">129</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="f46ac6349e9244afe9841afed2ec9192"></a><!-- doxytag: member="moc_message_status_struct::valid" ref="f46ac6349e9244afe9841afed2ec9192" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#f46ac6349e9244afe9841afed2ec9192">moc_message_status_struct::valid</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Is this entry valid? 
<p>

<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00134">134</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ac36e005c019f7811b14588ccc8b6ae9"></a><!-- doxytag: member="moc_message_status_struct::outstanding" ref="ac36e005c019f7811b14588ccc8b6ae9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#ac36e005c019f7811b14588ccc8b6ae9">moc_message_status_struct::outstanding</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Message is not yet received? 
<p>

<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00135">135</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="88a312a8474fb4ad31bb79be8e2704e8"></a><!-- doxytag: member="moc_message_status_struct::buffer_used" ref="88a312a8474fb4ad31bb79be8e2704e8" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#88a312a8474fb4ad31bb79be8e2704e8">moc_message_status_struct::buffer_used</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Is Bufferspace used? 
<p>

<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00136">136</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="7b336d0c92a22d73f5e7585dc7b28a49"></a><!-- doxytag: member="moc_message_status_struct::reserved" ref="7b336d0c92a22d73f5e7585dc7b28a49" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#7b336d0c92a22d73f5e7585dc7b28a49">moc_message_status_struct::reserved</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
reserved 
<p>

<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00137">137</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="c0bdc214525521d58f12c72874de0512"></a><!-- doxytag: member="moc_message_status_struct::bits" ref="c0bdc214525521d58f12c72874de0512" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct { ... }   <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#c0bdc214525521d58f12c72874de0512">moc_message_status_struct::bits</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
flag-struct 
<p>

<p>Referenced by <a class="el" href="../../d7/d1f/imoc__buffer__malloc_8c-source.html#l00056">__attribute__()</a>, <a class="el" href="../../d7/d1f/imoc__buffer__malloc_8c-source.html#l00085">IMOC_bmalloc()</a>, <a class="el" href="../../dd/d18/imoc__get__free__mid_8c-source.html#l00009">IMOC_getFreeMID()</a>, <a class="el" href="../../dd/d1f/imoc__test__message_8c-source.html#l00009">IMOC_testForMessageCompletion()</a>, <a class="el" href="../../d2/dd3/imoc__wait__message_8c-source.html#l00009">IMOC_waitForMessageCompletion()</a>, <a class="el" href="../../d2/db6/moc__bsend__ppu_8c-source.html#l00010">MOC_Bsend()</a>, <a class="el" href="../../df/df8/moc__issend__ppu_8c-source.html#l00010">MOC_ISsend()</a>, <a class="el" href="../../d4/db6/moc__ssend__ppu_8c-source.html#l00010">MOC_Ssend()</a>, and <a class="el" href="../../d7/d24/moc__test_8c-source.html#l00013">MOC_Test()</a>.</p>

</div>
</div><p>
<a class="anchor" name="d6c989ccbfc4a74a8c3982a1098c3d78"></a><!-- doxytag: member="moc_message_status_struct::value" ref="d6c989ccbfc4a74a8c3982a1098c3d78" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#d6c989ccbfc4a74a8c3982a1098c3d78">moc_message_status_struct::value</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
union-value 
<p>

<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00139">139</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>

<p>Referenced by <a class="el" href="../../de/d33/moc__wait_8c-source.html#l00011">MOC_Wait()</a>.</p>

</div>
</div><p>
<a class="anchor" name="086c0d449d25774d43512b6f7fdab8ed"></a><!-- doxytag: member="moc_message_status_struct::flags" ref="086c0d449d25774d43512b6f7fdab8ed" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">union { ... }   <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#086c0d449d25774d43512b6f7fdab8ed">moc_message_status_struct::flags</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
flag-union 
<p>

<p>Referenced by <a class="el" href="../../d7/d1f/imoc__buffer__malloc_8c-source.html#l00056">__attribute__()</a>, <a class="el" href="../../d7/d1f/imoc__buffer__malloc_8c-source.html#l00085">IMOC_bmalloc()</a>, <a class="el" href="../../dd/d18/imoc__get__free__mid_8c-source.html#l00009">IMOC_getFreeMID()</a>, <a class="el" href="../../dd/d1f/imoc__test__message_8c-source.html#l00009">IMOC_testForMessageCompletion()</a>, <a class="el" href="../../d2/dd3/imoc__wait__message_8c-source.html#l00009">IMOC_waitForMessageCompletion()</a>, <a class="el" href="../../d2/db6/moc__bsend__ppu_8c-source.html#l00010">MOC_Bsend()</a>, <a class="el" href="../../df/df8/moc__issend__ppu_8c-source.html#l00010">MOC_ISsend()</a>, <a class="el" href="../../d4/db6/moc__ssend__ppu_8c-source.html#l00010">MOC_Ssend()</a>, <a class="el" href="../../d7/d24/moc__test_8c-source.html#l00013">MOC_Test()</a>, and <a class="el" href="../../de/d33/moc__wait_8c-source.html#l00011">MOC_Wait()</a>.</p>

</div>
</div><p>
<a class="anchor" name="5216df4edcee08127bf6e4147b1a0aef"></a><!-- doxytag: member="moc_message_status_struct::reserved" ref="5216df4edcee08127bf6e4147b1a0aef" args="[3]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t <a class="el" href="../../dd/df5/structmoc__message__status__struct.html#7b336d0c92a22d73f5e7585dc7b28a49">moc_message_status_struct::reserved</a>[3]          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
reserved 
<p>

<p>Definition at line <a class="el" href="../../d6/d2c/imoc__core_8h-source.html#l00141">141</a> of file <a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>include/internal/<a class="el" href="../../d6/d2c/imoc__core_8h-source.html">imoc_core.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 12 13:51:20 2009 for MPI On Cell (Documentation) by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="../../doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>