Commit e1ad3584 authored by Jim Harris's avatar Jim Harris Committed by Tomasz Zawadzki
Browse files

sock: clarify that spdk_sock_group_add/remove_sock() set errno 



Discovered while reviewing patch series from Krzysztof Goreczny.

Signed-off-by: default avatarJim Harris <jim.harris@samsung.com>
Change-Id: If50a63531a24fe24c56a1857993f579165dfef78
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/23612


Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: default avatarKrzysztof Goreczny <krzysztof.goreczny@dell.com>
parent 361bef31

include/spdk/sock.h

+2 −2
Original line number Diff line number Diff line
@@ -529,7 +529,7 @@ void *spdk_sock_group_get_ctx(struct spdk_sock_group *sock_group); 
 * \param cb_fn Called when the operation completes.

 * \param cb_arg Argument passed to the callback function.

 *

 * \return 0 on success, -1 on failure.

 * \return 0 on success, -1 on failure with errno set.

 */

int spdk_sock_group_add_sock(struct spdk_sock_group *group, struct spdk_sock *sock,

			     spdk_sock_cb cb_fn, void *cb_arg);
@@ -540,7 +540,7 @@ int spdk_sock_group_add_sock(struct spdk_sock_group *group, struct spdk_sock *so 
 * \param group Socket group.

 * \param sock Socket to remove.

 *

 * \return 0 on success, -1 on failure.

 * \return 0 on success, -1 on failure with errno set.

 */

int spdk_sock_group_remove_sock(struct spdk_sock_group *group, struct spdk_sock *sock);