Uploaded image for project: 'ZooKeeper'
  1. ZooKeeper
  2. ZOOKEEPER-782

Incorrect C API documentation for Watches

VotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Trivial
    • Resolution: Fixed
    • 3.3.1
    • 3.4.0
    • c client, documentation
    • None
    • Reviewed
    • Corrected documentation on watch behavior in C API

    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.

      Attachments

        1. ZOOKEEPER-782.patch
          1 kB
          Mahadev Konar

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            mahadev Mahadev Konar
            wrightd Dave Wright
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Issue deployment