ZooKeeper
  1. ZooKeeper
  2. ZOOKEEPER-782

Incorrect C API documentation for Watches

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 3.3.1
    • Fix Version/s: 3.4.0
    • Component/s: c client, documentation
    • Labels:
      None
    • Hadoop Flags:
      Reviewed
    • Release Note:
      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.

        Activity

        Dave Wright created issue -
        Patrick Hunt made changes -
        Field Original Value New Value
        Fix Version/s 3.4.0 [ 12314469 ]
        Component/s documentation [ 12312422 ]
        Mahadev konar made changes -
        Attachment ZOOKEEPER-782.patch [ 12486375 ]
        Mahadev konar made changes -
        Status Open [ 1 ] Patch Available [ 10002 ]
        Benjamin Reed made changes -
        Status Patch Available [ 10002 ] Resolved [ 5 ]
        Hadoop Flags [Reviewed]
        Resolution Fixed [ 1 ]
        Patrick Hunt made changes -
        Assignee Mahadev konar [ mahadev ]
        Mahadev konar made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Mahadev konar
            Reporter:
            Dave Wright
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development