table of contents
other versions
- experimental 0.9.0-1
rpma_flush(3) | RPMA Programmer's Manual | rpma_flush(3) |
NAME¶
rpma_flush - initiate the flush operationSYNOPSIS¶
#include <librpma.h> struct rpma_conn; struct rpma_mr_remote; enum rpma_flush_type {
RPMA_FLUSH_TYPE_PERSISTENT,¶
RPMA_FLUSH_TYPE_VISIBILITY,¶
};¶
int rpma_flush(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);DESCRIPTION¶
rpma_flush() initiates the flush operation (finalizing a transfer of data to the remote memory). Possible types of rpma_flush() operation:- RPMA_FLUSH_TYPE_PERSISTENT - flush data down to the persistent domain
- RPMA_FLUSH_TYPE_VISIBILITY - flush data deep enough to make it visible on the remote node
The attribute flags set the completion notification indicator:
- RPMA_F_COMPLETION_ON_ERROR - generate the completion on error
- RPMA_F_COMPLETION_ALWAYS - generate the completion regardless of result of the operation
RETURN VALUE¶
The rpma_flush() function returns 0 on success or a negative error code on failure.ERRORS¶
rpma_flush() can fail with the following errors:- RPMA_E_INVAL - conn or dst is NULL
- RPMA_E_INVAL - unknown type value
- RPMA_E_INVAL - flags are not set
- RPMA_E_PROVIDER - ibv_post_send(3) failed
- RPMA_E_NOSUPP - type is RPMA_FLUSH_TYPE_PERSISTENT and the direct write to pmem is not supported
SEE ALSO¶
rpma_conn_req_connect(3), rpma_mr_remote_from_descriptor(3), librpma(7) and https://pmem.io/rpma/21 October 2020 | RPMA |