From 747bc8863acb4fab65cb832c163f222e9ad8ce10 Mon Sep 17 00:00:00 2001 From: Evgeny Leksikov Date: Mon, 16 Dec 2019 17:17:39 +0200 Subject: [PATCH 1/3] UCT/DOC: document uct_ep_disconnect return codes --- src/uct/api/uct.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/uct/api/uct.h b/src/uct/api/uct.h index 6f13699b6cd..031f746225e 100644 --- a/src/uct/api/uct.h +++ b/src/uct/api/uct.h @@ -1867,6 +1867,17 @@ ucs_status_t uct_ep_create(const uct_ep_params_t *params, uct_ep_h *ep_p); * * @param [in] ep Endpoint to disconnect. * @param [in] flags Reserved for future use. + * + * @return UCS_OK Operation is completed successfully. + * UCS_ERR_BUSY The @a ep is not connected yet + * (@ref uct_ep_client_connect_cb_t or + * @ref uct_ep_server_connect_cb_t correspondingly + * was not invoked). + * UCS_INPROGRESS The @a ep is disconnected locally but still + * connected remotely (@ref uct_ep_disconnect_cb_t + * was not invoked). + * UCS_ERR_NOT_CONNECTED The @a ep is disconnected locally and remotely. + * Other error codes as defined by @ref ucs_status_t . */ ucs_status_t uct_ep_disconnect(uct_ep_h ep, unsigned flags); From 8ba8988bd83f912c2d1d1e33eb0c200c5434206b Mon Sep 17 00:00:00 2001 From: Evgeny Leksikov Date: Mon, 16 Dec 2019 17:38:33 +0200 Subject: [PATCH 2/3] UCT/DOC: document uct_ep_disconnect return codes, CR(1) --- src/uct/api/uct.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/uct/api/uct.h b/src/uct/api/uct.h index 031f746225e..a47d7026711 100644 --- a/src/uct/api/uct.h +++ b/src/uct/api/uct.h @@ -1868,11 +1868,11 @@ ucs_status_t uct_ep_create(const uct_ep_params_t *params, uct_ep_h *ep_p); * @param [in] ep Endpoint to disconnect. * @param [in] flags Reserved for future use. * - * @return UCS_OK Operation is completed successfully. - * UCS_ERR_BUSY The @a ep is not connected yet - * (@ref uct_ep_client_connect_cb_t or - * @ref uct_ep_server_connect_cb_t correspondingly - * was not invoked). + * @return UCS_OK Operation has completed successfully. + * UCS_ERR_BUSY The @a ep is not connected yet (either + * @ref uct_ep_client_connect_cb_t or + * @ref uct_ep_server_connect_cb_t was not + * invoked). * UCS_INPROGRESS The @a ep is disconnected locally but still * connected remotely (@ref uct_ep_disconnect_cb_t * was not invoked). From 61d4479fa39d2f9e2506deaead1f3bccb59c8c22 Mon Sep 17 00:00:00 2001 From: Evgeny Leksikov Date: Thu, 19 Dec 2019 15:00:48 +0200 Subject: [PATCH 3/3] UCT/DOC: document uct_ep_disconnect return codes, CR(2) --- src/uct/api/uct.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/uct/api/uct.h b/src/uct/api/uct.h index a47d7026711..986ee9b1fe0 100644 --- a/src/uct/api/uct.h +++ b/src/uct/api/uct.h @@ -1873,9 +1873,11 @@ ucs_status_t uct_ep_create(const uct_ep_params_t *params, uct_ep_h *ep_p); * @ref uct_ep_client_connect_cb_t or * @ref uct_ep_server_connect_cb_t was not * invoked). - * UCS_INPROGRESS The @a ep is disconnected locally but still - * connected remotely (@ref uct_ep_disconnect_cb_t - * was not invoked). + * UCS_INPROGRESS The disconnect request has been initiated, but + * the remote peer has not yet responded to this + * request, and consequently the registered + * callback @ref uct_ep_disconnect_cb_t has not + * been invoked to handle the request. * UCS_ERR_NOT_CONNECTED The @a ep is disconnected locally and remotely. * Other error codes as defined by @ref ucs_status_t . */