contrib/ofed/librdmacm/man/rdma_post_send.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_POST_SEND" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_post_send \- 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_send
   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 .SH ARGUMENTS
  16 .IP "id" 12
  17 A reference to a communication identifier where the message buffer
  18 will be posted.
  19 .IP "context" 12
  20 User-defined context associated with the request.
  21 .IP "addr" 12
  22 The address of the memory buffer to post.
  23 .IP "length" 12
  24 The length of the memory buffer.
  25 .IP "mr" 12
  26 Optional registered memory region associated with the posted buffer.
  27 .IP "flags" 12
  28 Optional flags used to control the send operation.
  29 .SH "DESCRIPTION"
  30 Posts a work request to the send queue of the queue pair associated
  31 with the rdma_cm_id.  The contents of the posted buffer will be sent
  32 to the remote peer of a connection.
  33 .SH "RETURN VALUE"
  34 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  35 set to indicate the failure reason.
  36 .SH "NOTES"
  37 The user is responsible for ensuring that the remote peer has queued a
  38 receive request before issuing the send operations.  For a list of
  39 supported flags, see ibv_post_send.  Unless the send request is using
  40 inline data, the message buffer must have been registered
  41 before being posted, with the mr parameter referencing the registration.
  42 The buffer must remain registered until the send completes.
  43 .P
  44 Send operations may not be posted to an rdma_cm_id or the corresponding
  45 queue pair until it has been connected.
  46 .P
  47 The user-defined context associated with the send request will be
  48 returned to the user through the work completion wr_id, work request
  49 identifier, field.
  50 .SH "SEE ALSO"
  51 rdma_cm(7), rdma_connect(3), rdma_accept(3),
  52 ibv_post_send(3), rdma_post_sendv(3), rdma_post_recv(3)