async_client.h is confusing

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Unresolved
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • Networking & Observability
    • N&O 2026-08-03, N&O 2026-08-17, N&O 2026-08-31
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      The library is confusing for the following reasons:

      • It's expected that only one operation is ongoing at a time, but this is not documented
      • Some of the public methods are really just helpers, so should be private (e.g. runCommand and runExhaustCommand
      • Exhaust commands are are a multi-step process, but nothing describes this.
      • There are almost no comments, so it's likely there are other behaviors that should be documented but aren't.

            Assignee:
            Michael Nugent
            Reporter:
            Michael Nugent
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: