contrib/ofed/librdmacm/man/rdma_post_ud_send.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_POST_UD_SEND" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_post_ud_send \- post a work request to send a datagram.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_verbs.h>"
   7 .P
   8 .B "int" rdma_post_ud_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 .BI "struct ibv_ah *" ah ","
  16 .BI "uint32_t " remote_qpn ");"
  17 .SH ARGUMENTS
  18 .IP "id" 12
  19 A reference to a communication identifier where the message buffer
  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 memory buffer to post.
  25 .IP "length" 12
  26 The length of the memory buffer.
  27 .IP "mr" 12
  28 Optional registered memory region associated with the posted buffer.
  29 .IP "flags" 12
  30 Optional flags used to control the send operation.
  31 .IP "ah" 12
  32 An address handle describing the address of the remote node.
  33 .IP "remote_qpn" 12
  34 The number of the destination queue pair.
  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 posted buffer will be sent
  38 to the specified destination queue pair.
  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 The user is responsible for ensuring that the destination queue pair
  44 has queued a receive request before issuing the send operations.  For a list of
  45 supported flags, see ibv_post_send.  Unless the send request is using
  46 inline data, the message buffer must have been registered
  47 before being posted, with the mr parameter referencing the registration.
  48 The buffer must remain registered until the send completes.
  49 .P
  50 The user-defined context associated with the send request will be
  51 returned to the user through the work completion wr_id, work request
  52 identifier, field.
  53 .SH "SEE ALSO"
  54 rdma_cm(7), rdma_connect(3), rdma_accept(3), rdma_reg_msgs(3)
  55 ibv_post_send(3), rdma_post_recv(3)