contrib/ofed/librdmacm/man/rdma_post_readv.3

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