.\" Extracted by src2man from /build/rpma-11eW7Q/rpma-1.3.0/src/include/librpma.h
.\" Text automatically generated by txt2man
.TH rpma_flush 3 "29 May 2023" "RPMA" "RPMA Programmer's Manual"
.SH NAME
\fBrpma_flush \fP- initiate the flush operation
.SH SYNOPSIS
.nf
.fam C
      #include <librpma.h>

      struct rpma_conn;
      struct rpma_mr_remote;
      enum rpma_flush_type {
              RPMA_FLUSH_TYPE_PERSISTENT,
              RPMA_FLUSH_TYPE_VISIBILITY,
      };

      int \fBrpma_flush\fP(struct rpma_conn *conn,
                      struct rpma_mr_remote *dst, size_t dst_offset,
                      size_t len, enum rpma_flush_type type, int flags,
                      const void *op_context);

.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
\fBrpma_flush\fP() initiates the flush operation (finalizing a transfer of data to the remote memory).
Possible types of \fBrpma_flush\fP() operation:
.IP \(bu 3
RPMA_FLUSH_TYPE_PERSISTENT - flush data down to the persistent domain
.IP \(bu 3
RPMA_FLUSH_TYPE_VISIBILITY - flush data deep enough to make it visible on the remote node
.PP
The attribute flags set the completion notification indicator:
.IP \(bu 3
RPMA_F_COMPLETION_ON_ERROR - generate the completion on error
.IP \(bu 3
RPMA_F_COMPLETION_ALWAYS - generate the completion regardless of result of the operation.
.PP
op_context is returned in the wr_id field of the completion (struct ibv_wc).
.SH RETURN VALUE
The \fBrpma_flush\fP() function returns 0 on success or a negative error code on failure.
.SH ERRORS
\fBrpma_flush\fP() can fail with the following errors:
.IP \(bu 3
RPMA_E_INVAL - conn or dst is NULL
.IP \(bu 3
RPMA_E_INVAL - unknown type value
.IP \(bu 3
RPMA_E_INVAL - flags are not set
.IP \(bu 3
RPMA_E_PROVIDER - \fBibv_post_send\fP(3) failed
.IP \(bu 3
RPMA_E_NOSUPP - type is RPMA_FLUSH_TYPE_PERSISTENT and the direct write to pmem is not
supported
.SH SEE ALSO
\fBrpma_conn_req_connect\fP(3), \fBrpma_mr_remote_from_descriptor\fP(3), \fBlibrpma\fP(7) and
https://pmem.io/rpma/