contrib/ofed/librdmacm/man/rdma_post_sendv.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_POST_SENDV" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_post_sendv \- post a work request to send a message.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_verbs.h>"
   7 .P
   8 .B "int" rdma_post_sendv
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "void *" context ","
  11 .BI "struct ibv_sge *" slg ","
  12 .BI "int " nsge ","
  13 .BI "int " flags ");"
  14 .SH ARGUMENTS
  15 .IP "id" 12
  16 A reference to a communication identifier where the message buffer
  17 will be posted.
  18 .IP "context" 12
  19 User-defined context associated with the request.
  20 .IP "slg" 12
  21 A scatter-gather list of memory buffers posted as a single request.
  22 .IP "nsge" 12
  23 The number of scatter-gather entries in the slg array.
  24 .IP "flags" 12
  25 Optional flags used to control the send operation.
  26 .SH "DESCRIPTION"
  27 Posts a work request to the send queue of the queue pair associated
  28 with the rdma_cm_id.  The contents of the posted buffers will be sent
  29 to the remote peer of a connection.
  30 .SH "RETURN VALUE"
  31 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  32 set to indicate the failure reason.
  33 .SH "NOTES"
  34 The user is responsible for ensuring that the remote peer has queued a
  35 receive request before issuing the send operations.  For a list of
  36 supported flags, see ibv_post_send.  Unless the send request is using
  37 inline data, the message buffers must have been registered
  38 before being posted, and the buffers must remain registered
  39 until the send completes.
  40 .P
  41 Send operations may not be posted to an rdma_cm_id or the corresponding
  42 queue pair until it has been connected.
  43 .P
  44 The user-defined context associated with the send request will be
  45 returned to the user through the work completion wr_id, work request
  46 identifier, field.
  47 .SH "SEE ALSO"
  48 rdma_cm(7), rdma_connect(3), rdma_accept(3),
  49 ibv_post_send(3), rdma_post_send(3), rdma_post_recv(3)