summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOr Gerlitz <ogerlitz@voltaire.com>2006-09-12 09:03:33 -0700
committerRoland Dreier <rolandd@cisco.com>2006-09-22 15:22:54 -0700
commit07eeec0627e93a1a753c4df004a97a4d0a7b9ceb (patch)
treea64ef6da30f93a2443c8a3131e1cfc0d04c721d0
parenta70d059009f4a207e2a9c794f40fc8c870096d54 (diff)
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>
-rw-r--r--include/rdma/rdma_cm.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/include/rdma/rdma_cm.h b/include/rdma/rdma_cm.h
index 402c63d7226b..1566be568ab6 100644
--- a/include/rdma/rdma_cm.h
+++ b/include/rdma/rdma_cm.h
@@ -117,6 +117,14 @@ struct rdma_cm_id {
struct rdma_cm_id *rdma_create_id(rdma_cm_event_handler event_handler,
void *context, enum rdma_port_space ps);
+/**
+ * rdma_destroy_id - Destroys an RDMA identifier.
+ *
+ * @id: RDMA identifier.
+ *
+ * Note: calling this function has the effect of canceling in-flight
+ * asynchronous operations associated with the id.
+ */
void rdma_destroy_id(struct rdma_cm_id *id);
/**