contrib/ofed/librdmacm/man/rdma_post_read.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_POST_READ" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_post_read \- post an RDMA read work request.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_verbs.h>"
   7 .P
   8 .B "int" rdma_post_read
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "void *" context ","
  11 .BI "void *" addr ","
  12 .BI "size_t " length ","
  13 .BI "struct ibv_mr *" mr ","
  14 .BI "int " flags ","
  15 .BI "uint64_t " remote_addr ","
  16 .BI "uint32_t " rkey ");"
  17 .SH ARGUMENTS
  18 .IP "id" 12
  19 A reference to a communication identifier where the request
  20 will be posted.
  21 .IP "context" 12
  22 User-defined context associated with the request.
  23 .IP "addr" 12
  24 The address of the local destination of the read request.
  25 .IP "length" 12
  26 The length of the read operation.
  27 .IP "mr" 12
  28 Registered memory region associated with the local buffer.
  29 .IP "flags" 12
  30 Optional flags used to control the read operation.
  31 .IP "remote_addr" 12
  32 The address of the remote registered memory to read from.
  33 .IP "rkey" 12
  34 The registered memory key associated with the remote address.
  35 .SH "DESCRIPTION"
  36 Posts a work request to the send queue of the queue pair associated
  37 with the rdma_cm_id.  The contents of the remote memory region will be
  38 read into the local data buffer.
  39 .SH "RETURN VALUE"
  40 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  41 set to indicate the failure reason.
  42 .SH "NOTES"
  43 For a list of supported flags, see ibv_post_send.
  44 Both the remote and local data buffers must have been registered
  45 before the read is issued, and the buffers must remain registered
  46 until the read completes.
  47 .P
  48 Read operations may not be posted to an rdma_cm_id or the corresponding
  49 queue pair until it has been connected.
  50 .P
  51 The user-defined context associated with the read request will be
  52 returned to the user through the work completion wr_id, work request
  53 identifier, field.
  54 .SH "SEE ALSO"
  55 rdma_cm(7), rdma_connect(3), rdma_accept(3),
  56 ibv_post_send(3), rdma_post_readv(3), rdma_reg_read(3), rdma_reg_msgs(3)