[ZOOKEEPER-782] Incorrect C API documentation for Watches

• Type: Bug
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 3.3.1
• Fix Version/s: 3.4.0
• Component/s: c client, documentation
• Hadoop Flags: Reviewed
• Release Note: Corrected documentation on watch behavior in C API
• Assignee: Mahadev Konar
• Reporter: Dave Wright
• Created: 31/May/10 20:47
• Updated: 23/Nov/11 19:22
• Resolved: 14/Jul/11 17:54

Description

The C API Doxygen documentation states:

" .... If the client is ever disconnected from the service, even if the
disconnection is temporary, the watches of the client will be removed from
the service, so a client must treat a disconnect notification as an implicit
trigger of all outstanding watches."

This is incorrect as of v.3. Watches are only lost and need to be re-registered when a session times out. When a normal disconnection occurs watches are reset automatically on reconnection.

The documentation in zookeeper.h needs to be updated to correct this explanation.