contrib/ofed/librdmacm/man/rdma_get_send_comp.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_GET_SEND_COMP" 3 "2010-07-19" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_get_send_comp \- retrieves a completed send, read, or write request.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_verbs.h>"
   7 .P
   8 .B "int" rdma_get_send_comp
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "struct ibv_wc *" wc ");"
  11 .SH ARGUMENTS
  12 .IP "id" 12
  13 A reference to a communication identifier to check for completions.
  14 .IP "wc" 12
  15 A reference to a work completion structure to fill in.
  16 .SH "DESCRIPTION"
  17 Retrieves a completed work request for a send, RDMA read, or RDMA write
  18 operation.  Information about the completed request is returned through
  19 the wc parameter, with the wr_id set to the context of the request.  For
  20 details on the work completion structure, see ibv_poll_cq.
  21 .SH "RETURN VALUE"
  22 Returns the number of returned completions (0 or 1) on success, or -1 on error.
  23 If an error occurs, errno will be set to indicate the failure reason.
  24 .SH "NOTES"
  25 This calls polls the send completion queue associated with an rdma_cm_id.
  26 If a completion is not found, the call blocks until a request completes.
  27 This call should only be used on rdma_cm_id's that do not share CQs
  28 with other rdma_cm_id's, and maintain separate CQs for sends and receive
  29 completions.
  30 .SH "SEE ALSO"
  31 rdma_cm(7), ibv_poll_cq(3), rdma_get_recv_comp(3),
  32 rdma_post_send(3), rdma_post_read(3), rdma_post_write(3)