zello-channel-api icon indicating copy to clipboard operation
zello-channel-api copied to clipboard

API documentation: error codes, message sequencing

Open PhilRW opened this issue 5 months ago • 2 comments

Hello:

Would it be possible to please document some error codes on the API, such as: empty message woodpecker prohibited ...and others?

Also a brief explanation of what they mean would be appreciated and a potential remedy so the error handler code doesn't blindly retry without taking corrective action. Some I have been able to reverse engineer as they are fairly obvious (not authorized, for example), but others not so much.

Also an explanation of (a)synchronicity and sequencing of messages, for example, on_stream_start and on_stream_stop. I can understand multiple simultaneous streams but the consumer API only supports one channel which is logically treated as a half duplex connection, so I would expect on_stream_stop to follow after each on_stream_start, but occasionally messages are not received or are received out of order. Without further explanation and/or sequence diagrams, I am coding against the API in the dark.

Thanks!

PhilRW avatar Sep 09 '24 22:09 PhilRW