130 lines
7.2 KiB
HTML
Executable File
130 lines
7.2 KiB
HTML
Executable File
<!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): Return Status</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 Page</span></a></li>
|
|
<li><a href="../../modules.html"><span>Modules</span></a></li>
|
|
<li><a href="../../annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="../../files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>Return Status<br>
|
|
<small>
|
|
[<a class="el" href="../../d0/d64/group__p2p__main.html">Point-to-Point Communication</a>]</small>
|
|
</h1>
|
|
<p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for Return Status:</div>
|
|
<div class="dynsection">
|
|
<center><table><tr><td><img src="../../da/df0/group__p2p__status.png" border="0" alt="" usemap="#d0/d72/da_2df0_2group____p2p____status_map">
|
|
<map name="d0/d72/da_2df0_2group____p2p____status_map">
|
|
<area shape="rect" href="../../d0/d64/group__p2p__main.html" title="Sending and receiving of messages by processes is the basic MPI communication mechanism..." alt="" coords="5,5,200,32"></map></td></tr></table></center>
|
|
</div>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Receiving operations return a status-object holding information about the message.
|
|
<p>
|
|
There are three Fields of the status-Struct which are predefined by the MPI-Standard: MOC_SOURCE gives the message-source, MOC_TAG gives the message-tag and MOC_ERROR gives an error-code (not implemented by MOC at the moment). To get the number of element the function <a class="el" href="../../da/df0/group__p2p__status.html#g0766bc2817b17dcdc8b7e830828fe118">MOC_Get_count</a> should be used.
|
|
<p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d7a/structMOC__Status__struct.html">MOC_Status_struct</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure holding information about a received message. <a href="../../dd/d7a/structMOC__Status__struct.html#_details">More...</a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="../../dd/d7a/structMOC__Status__struct.html">MOC_Status_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/df0/group__p2p__status.html#g5eab4f2552eba523a97d1c1fac826282">MOC_Status</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure holding information about a received message. <a href="#g5eab4f2552eba523a97d1c1fac826282"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/df0/group__p2p__status.html#g0766bc2817b17dcdc8b7e830828fe118">MOC_Get_count</a> (<a class="el" href="../../dd/d7a/structMOC__Status__struct.html">MOC_Status</a> *status, <a class="el" href="../../dc/d6e/group__p2p__datatype.html#gb4e45f15c08578bd3fc97c0cca2a509a">MOC_Datatype</a> datatype, int *count)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of received elements which is encoded in MOC_Status. <a href="#g0766bc2817b17dcdc8b7e830828fe118"></a><br></td></tr>
|
|
</table>
|
|
<hr><h2>Typedef Documentation</h2>
|
|
<a class="anchor" name="g5eab4f2552eba523a97d1c1fac826282"></a><!-- doxytag: member="moc.h::MOC_Status" ref="g5eab4f2552eba523a97d1c1fac826282" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="../../dd/d7a/structMOC__Status__struct.html">MOC_Status_struct</a> <a class="el" href="../../dd/d7a/structMOC__Status__struct.html">MOC_Status</a> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Structure holding information about a received message.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="g0766bc2817b17dcdc8b7e830828fe118"></a><!-- doxytag: member="moc.h::MOC_Get_count" ref="g0766bc2817b17dcdc8b7e830828fe118" args="(MOC_Status *status, MOC_Datatype datatype, int *count)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int MOC_Get_count </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../dd/d7a/structMOC__Status__struct.html">MOC_Status</a> * </td>
|
|
<td class="paramname"> <em>status</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="../../dc/d6e/group__p2p__datatype.html#gb4e45f15c08578bd3fc97c0cca2a509a">MOC_Datatype</a> </td>
|
|
<td class="paramname"> <em>datatype</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"> <em>count</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Gets the number of received elements which is encoded in MOC_Status.
|
|
<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td><b>in</b> status-object </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>datatype</em> </td><td><b>in</b> Type of received elements </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td><b>out</b> Number of received elements </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Return values:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>MOC_SUCCESS</em> </td><td>No error; MPI routine completed successfully. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>error-code </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="../../d1/ddf/moc__get__count_8c-source.html#l00003">3</a> of file <a class="el" href="../../d1/ddf/moc__get__count_8c-source.html">moc_get_count.c</a>.</p>
|
|
|
|
<p>References <a class="el" href="../../d7/de1/moc_8h-source.html#l00230">MOC_Status_struct::message_size</a>, and <a class="el" href="../../d3/d95/moc__error__codes_8h-source.html#l00043">MOC_ERR_ARG</a>.</p>
|
|
|
|
</div>
|
|
</div><p>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 12 13:50:49 2009 for MPI On Cell (Documentation) by
|
|
<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>
|