Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

UCT/DOC: document uct_ep_disconnect return codes #4586

Merged
merged 3 commits into from
Jan 8, 2020
Merged

UCT/DOC: document uct_ep_disconnect return codes #4586

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
747bc88
UCT/DOC: document uct_ep_disconnect return codes
evgeny-leksikov Dec 16, 2019
8ba8988
UCT/DOC: document uct_ep_disconnect return codes, CR(1)
evgeny-leksikov Dec 16, 2019
61d4479
UCT/DOC: document uct_ep_disconnect return codes, CR(2)
evgeny-leksikov Dec 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/uct/api/uct.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1867,6 +1867,19 @@ 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 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 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 .
*/
ucs_status_t uct_ep_disconnect(uct_ep_h ep, unsigned flags);

Expand Down