RDMA/cma: Document rdma_accept() error handling

Document the reject sending and modifying QP to error done in rdma_accept(). 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>

RDMA/cma: Document rdma_accept() error handling
Document the reject sending and modifying QP to error done in rdma_accept(). 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>
Or Gerlitz · Roland Dreier
1 parent b3b30f5e8a
Showing 1 changed file with 4 additions and 0 deletions Side-by-side Diff
include/rdma/rdma_cm.h
@@ -245,6 +245,10 @@
  * Typically, this routine is only called by the listener to accept a connection
  * request.  It must also be called on the active side of a connection if the
  * user is performing their own QP transitions.
+ *
+ * In the case of error, a reject message is sent to the remote side and the
+ * state of the qp associated with the id is modified to error, such that any
+ * previously posted receive buffers would be flushed.
  */
 int rdma_accept(struct rdma_cm_id *id, struct rdma_conn_param *conn_param);
...	...	@@ -245,6 +245,10 @@
245	245	* Typically, this routine is only called by the listener to accept a connection
246	246	* request. It must also be called on the active side of a connection if the
247	247	* user is performing their own QP transitions.
	248	+ *
	249	+ * In the case of error, a reject message is sent to the remote side and the
	250	+ * state of the qp associated with the id is modified to error, such that any
	251	+ * previously posted receive buffers would be flushed.
248	252	*/
249	253	int rdma_accept(struct rdma_cm_id id, struct rdma_conn_param conn_param);
250	254