diff options
Diffstat (limited to 'contrib/ofed/librdmacm/man/rdma_post_read.3')
-rw-r--r-- | contrib/ofed/librdmacm/man/rdma_post_read.3 | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/contrib/ofed/librdmacm/man/rdma_post_read.3 b/contrib/ofed/librdmacm/man/rdma_post_read.3 new file mode 100644 index 000000000000..11b3e09e16ac --- /dev/null +++ b/contrib/ofed/librdmacm/man/rdma_post_read.3 @@ -0,0 +1,56 @@ +.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md +.TH "RDMA_POST_READ" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm +.SH NAME +rdma_post_read \- post an RDMA read work request. +.SH SYNOPSIS +.B "#include <rdma/rdma_verbs.h>" +.P +.B "int" rdma_post_read +.BI "(struct rdma_cm_id *" id "," +.BI "void *" context "," +.BI "void *" addr "," +.BI "size_t " length "," +.BI "struct ibv_mr *" mr "," +.BI "int " flags "," +.BI "uint64_t " remote_addr "," +.BI "uint32_t " rkey ");" +.SH ARGUMENTS +.IP "id" 12 +A reference to a communication identifier where the request +will be posted. +.IP "context" 12 +User-defined context associated with the request. +.IP "addr" 12 +The address of the local destination of the read request. +.IP "length" 12 +The length of the read operation. +.IP "mr" 12 +Registered memory region associated with the local buffer. +.IP "flags" 12 +Optional flags used to control the read operation. +.IP "remote_addr" 12 +The address of the remote registered memory to read from. +.IP "rkey" 12 +The registered memory key associated with the remote address. +.SH "DESCRIPTION" +Posts a work request to the send queue of the queue pair associated +with the rdma_cm_id. The contents of the remote memory region will be +read into the local data buffer. +.SH "RETURN VALUE" +Returns 0 on success, or -1 on error. If an error occurs, errno will be +set to indicate the failure reason. +.SH "NOTES" +For a list of supported flags, see ibv_post_send. +Both the remote and local data buffers must have been registered +before the read is issued, and the buffers must remain registered +until the read completes. +.P +Read operations may not be posted to an rdma_cm_id or the corresponding +queue pair until it has been connected. +.P +The user-defined context associated with the read request will be +returned to the user through the work completion wr_id, work request +identifier, field. +.SH "SEE ALSO" +rdma_cm(7), rdma_connect(3), rdma_accept(3), +ibv_post_send(3), rdma_post_readv(3), rdma_reg_read(3), rdma_reg_msgs(3) |