Commit 22fb74e7 authored May 15, 2025 by Jacek Kalwas Committed by Tomasz Zawadzki May 22, 2025

sock: clarify spdk_sock_group_close behavior



Change-Id: I881ce3c5c7833fa1d48afa5450a6a4b342985035
Signed-off-by: Jacek Kalwas <jacek.kalwas@nutanix.com>
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/25988


Reviewed-by: Ben Walker <ben@nvidia.com>
Tested-by: SPDK Automated Test System <spdkbot@gmail.com>
Community-CI: Mellanox Build Bot
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Jim Harris <jim.harris@nvidia.com>

parent 0fcf50e8

include/spdk/sock.h

+3 −0

Original line number	Diff line number	Diff line
		@@ -627,6 +627,9 @@ int spdk_sock_group_poll_count(struct spdk_sock_group *group, int max_events);
		/**
		* Close all registered sockets of the group and then remove the group.
		*
		* If any sockets were added to the group by \ref spdk_sock_group_add_sock
		* these must be removed first by using \ref spdk_sock_group_remove_sock.
		*
		* \param group Group to close.
		*
		* \return 0 on success, -1 on failure.