[ZOOKEEPER-761] Remove *synchronous* calls from the *single-threaded* C clieant API, since they are documented not to work - ASF JIRA

Voters

Watch issue

Watchers

Create sub-task

Link

Clone

Update Comment Author

Replace String in Comment

Update Comment Visibility

Delete Comments

XML

Word

Printable

JSON

Details

Type: Improvement
Status: Resolved
Priority: Blocker
Resolution: Fixed
Affects Version/s: 3.1.1, 3.2.2
Fix Version/s: 3.5.3, 3.6.0
Component/s: c client
Labels:
- pull-request-available
Environment:

RHEL 4u8 (Linux). The issue is not OS-specific though.

Release Note:
Removed synchronous calls from the single-threaded API as they are not implemented and documented as such.

Description

Since the synchronous calls are known to be unimplemented in the single threaded version of the client library libzookeeper_st.so, I believe that it would be helpful towards users of the library if that information was also obvious from the header file.

Anecdotally more than one of us here made the mistake of starting by using the synchronous calls with the single-threaded library, and we found ourselves debugging it. An early warning would have been greatly appreciated.

1. Could you please add warnings to the doxygen blocks of all synchronous calls saying that they are not available in the single-threaded API. This cannot be safely done with #ifdef THREADED, obviously, because the same header file is included whichever client library implementation one is compiling for.

2. Could you please bracket the implementation of all synchronous calls in zookeeper.c with #ifdef THREADED and #endif, so that those symbols are not present in libzookeeper_st.so?