Uploaded image for project: 'Couchbase .NET client library'
  1. Couchbase .NET client library
  2. NCBC-3694

Make sure documentation on CancellationToken vs. Timeout is consistent between API/implementation/docs

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Major
    • None
    • None
    • None
    • 1

    Description

      Related to 

      NCBC-3572

       

      The interactions between Timeout and CancellationToken can be complicated and non-intuitive from a user perspective.  The Timeout includes all retries, not individual attempts.  The CancellationToken may or may not be an actual timeout.

      Using CancellationTokens is a standard practice in .NET, and assuming OperationCancellationExceptions are because of timeouts is a common error.

       

      This needs to be consistent in the SDK and clear to the user, especially what happens when specifying both a Timeout and a CancellationToken.

      Additionally, once the SDK gives priority to one of Timeout or CancellationToken, do we need to let the user un-set Timeout.

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              richard.ponton Richard Ponton
              richard.ponton Richard Ponton
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty