MPI_Buffer_attach(3)

NAME
MPI_Buffer_attach - Attaches a buffer to be used for buffered sends

SYNOPSIS
#include <mpi.h>
int MPI_Buffer_attach(void *buffer, int size);

#include <pmpi.h>
int PMPI_Buffer_attach(void *buffer, int size);

#include <mpi.h>
void MPI::Attach_buffer(void *buffer, int size);

INCLUDE 'mpif.h'
MPI_BUFFER_ATTACH(buffer, size, ierr)
<type> buffer(*)
INTEGER size, ierr

INPUT PARAMETERS
buffer
    - buffer to attach (array)
size
    - size of the buffer (integer)

DESCRIPTION
The MPI_Buffer_attach() function is used to specify a buffer of size bytes that will be used for buffered sends. Buffered sends will use this buffer with a simple ring-buffer algorithm. Each send has an overhead of MPI_BSEND_OVERHEAD. The buffer can be removed by the MPI_Buffer_detach() function, or by MPI_Finalize(). It is up to the user to free the buffer when it is no longer used, if necessary.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception;
MPI_ERR_BUFFER
    - Invalid buffer, or a buffer is already attached;

SEE ALSO
MPI_Bsend(3), MPI_Ibsend(3), MPI_Bsend_init(3), MPI_Buffer_detach(3), MPI_Finalize(3)