MPI_Rget function

Request-based RMA get operation.

Syntax

int MPIAPI MPI_Rget(
  _Out_ void         *origin_addr,
        int          origin_count,
        MPI_Datatype origin_datatype,
        int          target_rank,
        MPI_Aint     target_disp,
        int          target_count,
        MPI_Datatype datatype,
        MPI_Win      win,
  _Out_ MPI_Request  *request
);

Parameters

• origin_addr [out]
  Address of the buffer in which to receive the data.

• origin_count
  Number of entries in origin buffer.

• origin_datatype
  Datatype of each entry in origin buffer.

• target_rank
  Rank of target.

• target_disp
  Displacement from window start to the beginning of the target buffer.

• target_count
  Number of entries in target buffer.

• datatype
  Datatype of each entry in target buffer.

• win
  Window object used for communication.

• request [out]
  RMA request.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_RGET(ORIGIN_ADDR, ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK,
                TARGET_DISP, TARGET_COUNT, TARGET_DATATYPE, WIN, REQUEST, IERROR)
        <type> ORIGIN_ADDR(*)
        INTEGER(KIND=MPI_ADDRESS_KIND) TARGET_DISP
        INTEGER ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK, TARGET_COUNT, TARGET_DATATYPE, WIN, REQUEST, IERROR

Remarks

MPI_Rget is similar to MPI_Get, except that it allocates a communication request object and associates it with the request handle (the argument request) that can be used to wait or test for completion. The completion of an MPI_Rget operation indicates that the data is available in the origin buffer. If origin_addr points to memory attached to a window, then the data becomes available in the private copy of this window.

Requirements

See also

MPI One-Sided Communications Functions