Commit 07eeec0627e93a1a753c4df004a97a4d0a7b9ceb

Authored by Or Gerlitz
Committed by Roland Dreier
1 parent a70d059009

RDMA/cma: Document rdma_destroy_id() function

Clarify that rdma_destroy_id cancels outstanding asynchronous operations on the
Associated id.

Signed-off-by: Or Gerlitz <ogerlitz@voltaire.com>
Signed-off-by: Sean Hefty <sean.hefty@intel.com>
Signed-off-by: Roland Dreier <rolandd@cisco.com>

Showing 1 changed file with 8 additions and 0 deletions Side-by-side Diff

include/rdma/rdma_cm.h
... ... @@ -117,6 +117,14 @@
117 117 struct rdma_cm_id *rdma_create_id(rdma_cm_event_handler event_handler,
118 118 void *context, enum rdma_port_space ps);
119 119  
  120 +/**
  121 + * rdma_destroy_id - Destroys an RDMA identifier.
  122 + *
  123 + * @id: RDMA identifier.
  124 + *
  125 + * Note: calling this function has the effect of canceling in-flight
  126 + * asynchronous operations associated with the id.
  127 + */
120 128 void rdma_destroy_id(struct rdma_cm_id *id);
121 129  
122 130 /**