Error Codes for Timeout, Overflow, Underflow

[ReinhardKeil]

I would expect error codes for

timeout (for Open/Close functions) - when Server does not respond in a given time. I guess this could also occur if the connection breaks down.

overflow (for RecWrite function) - when Recorder does not have space in SDS buffer

underflow (for PlayRead function) - when Player has not provided data in SDS buffer

Relates to #85 + #81

[DavidLesnjak]

1. #define SDS_REC_PLAY_ERROR_TIMEOUT (-2) has been added to sds_rec_play.h to handle timeout scenarios (e.g., when the server does not respond during Open/Close). The actual timeout detection and handling logic still needs to be implemented.

2. Overflow handling: The sdsRecWrite function does not cause buffer overflows. If the size of the record (including the header) does not fit into the circular buffer, the function returns 0 and the record is not written.

3. Underflow handling: Similarly, in sdsPlayRead, if the record size is larger than the size of the provided read buffer, the function returns 0, indicating that it cannot provide the data.

Given this behavior, overflow and underflow conditions are inherently handled by returning 0 when the operation cannot be completed, so no explicit error codes are required for these cases.

Let me know if you have other suggestions or prefer handling these cases differently.

[ReinhardKeil]

Decision is to add events, not error codes to RecPlay module. The callback events should indicate: Overflow, Underflow, Timeout, EndOfStream.

[ReinhardKeil]

Instead of Overflow use RecOutError
Instead of Underflow use PlayInError

[DavidLesnjak]

We've reconsidered the situation and updated the API accordingly.
New return codes and event definitions have been introduced in the following commit: Commit d76f7ab

// Function return codes
#define SDS_REC_PLAY_OK                 (0)     // Operation completed successfully
#define SDS_REC_PLAY_ERROR              (-1)    // Operation failed
#define SDS_REC_PLAY_ERROR_PARAMETER    (-2)    // Operation failed: parameter error
#define SDS_REC_PLAY_ERROR_TIMEOUT      (-3)    // Operation failed: timeout error
#define SDS_REC_PLAY_ERROR_IO           (-4)    // Operation failed: SDS I/O interface error
#define SDS_REC_ERROR_NO_SPACE          (-5)    // Operation failed: insufficient space in stream buffer
#define SDS_PLAY_ERROR_NO_DATA          (-6)    // Operation failed: insufficient data in stream buffer
#define SDS_PLAY_EOS                    (-7)    // End of stream reached

// Event codes
#define SDS_REC_PLAY_EVENT_ERROR_IO     (1UL)   // SDS I/O interface error
#define SDS_REC_EVENT_ERROR_NO_SPACE    (2UL)   // sdsRecWrite() failed: insufficient space in stream buffer
#define SDS_PLAY_EVENT_ERROR_NO_DATA    (4UL)   // sdsPlayRead() failed: insufficient data in stream buffer