Commit 5be09093 authored May 20, 2025 by Jacek Kalwas Committed by Tomasz Zawadzki May 22, 2025

lib/sock: add deprecation for spdk_sock_flush return



The idea of changing behavior is to prevent users to rely on the number
of bytes sent which is error prone (see #3664 issue). Currently there is
no such SPDK in-tree usage.

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


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

parent b3b3f7f9

deprecation.md

+7 −0

Original line number	Diff line number	Diff line
		@@ -19,6 +19,13 @@ The tags can be matched with the level 4 headers below.

		## Deprecation Notices

		### sock

		#### `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

+4 −0

Original line number	Diff line number	Diff line
		@@ -409,6 +409,10 @@ 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.
		*
		* \param sock Socket to flush.
		*
		* \return number of bytes sent on success, -1 on failure with errno set.