ampi/userIF/st.h

b4daa24319 Shre*0001 /*
                0002 ##########################################################
                0003 # This file is part of the AdjoinableMPI library         #
                0004 # released under the MIT License.                        #
                0005 # The full COPYRIGHT notice can be found in the top      #
                0006 # level directory of the AdjoinableMPI distribution.     #
                0007 ##########################################################
                0008 */
                0009 #ifndef _AMPI_ST_H_
                0010 #define _AMPI_ST_H_
                0011
                0012 /**
                0013  * \file
                0014  * \ingroup UserInterfaceHeaders
                0015  * ST = "source tansformation" specific versions of routines that exist because generic memory mapping is not yet implemented in any source transformation tool
                0016  */
                0017
                0018 #include "ampi/userIF/request.h"
                0019
                0020 /** \ingroup UserInterfaceDeclarations
                0021  * @{
                0022  */
                0023
                0024 /**
                0025  * variant of \ref AMPI_Wait with an extra parameter
                0026  * \param request follows the semantics of  <tt>MPI_Wait</tt>
                0027  * \param buf is the buffer that was passed to the corresponding \ref AMPI_Isend or \ref AMPI_Irecv call;
                0028  * see \ref nonblocking for a discussion of the necessity of the buf parameter.
                0029  * \param status follows the semantics of  <tt>MPI_Wait</tt>
                0030  */
                0031 int AMPI_Wait_ST(AMPI_Request *request,
                0032                  void *buf,
                0033                  MPI_Status *status);
                0034
                0035 /** @} */
                0036
                0037 #endif