Commit d63a4145 authored May 23, 2025 by Jacek Kalwas Committed by Tomasz Zawadzki Jun 04, 2025

sock: return 0 on success in spdk_sock_flush



Return number of bytes was deprecated and marked for removal
in v25.09 release.

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


Reviewed-by: Jim Harris <jim.harris@nvidia.com>
Reviewed-by: Tomasz Zawadzki <tomasz@tzawadzki.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Tested-by: SPDK Automated Test System <spdkbot@gmail.com>

parent 4bb9f44e

CHANGELOG.md

+5 −0

Original line number	Diff line number	Diff line
		@@ -2,6 +2,11 @@

		## v25.09: (Upcoming Release)

		### sock

		Changed the return behavior of `spdk_sock_flush`. The function now returns 0 on success, as relying
		on the number of bytes returned was not recommended.

		## v25.05

		### accel_mlx5

deprecation.md

+0 −5

Original line number	Diff line number	Diff line
		@@ -40,11 +40,6 @@ release. This function will return negative errno values instead.
		Returning -1 and setting errno on these functions is deprecated and will be changed in the 26.01
		release. These functions will return negative errno values instead.

		#### `spdk_sock_flush`

		This function returnes number of bytes sent on success, whereas this behavior is deprecated and
		will be changed in 25.09 release in the way it will return 0 on success.

		### gpt

		#### `old_gpt_guid`

include/spdk/sock.h

+1 −4

Original line number	Diff line number	Diff line
		@@ -415,15 +415,12 @@ int spdk_sock_close(struct spdk_sock **sock);
		*
		* On failure check errno matching EAGAIN to determine failure is retryable.
		*
		* It is not recommended to rely on the number of bytes returned on success.
		* This behavior is deprecated and will be removed in 25.09 release, function
		* will return 0 on success instead.
		* Returning -1 and setting errno is deprecated and will be changed in the 26.01 release.
		* This function will return negative errno values instead.
		*
		* \param sock Socket to flush.
		*
		* \return number of bytes sent on success, -1 on failure with errno set.
		* \return 0 on success, -1 on failure with errno set.
		*/
		int spdk_sock_flush(struct spdk_sock *sock);