Skip to content

[hotfix][docs] Make timeout param of async i/o more clearer#26774

Merged
lincoln-lil merged 2 commits intoapache:masterfrom
lincoln-lil:hotfix-async-doc
Jul 10, 2025
Merged

[hotfix][docs] Make timeout param of async i/o more clearer#26774
lincoln-lil merged 2 commits intoapache:masterfrom
lincoln-lil:hotfix-async-doc

Conversation

@lincoln-lil
Copy link
Contributor

What is the purpose of the change

The current timeout param might be not clear enough for users when enabling retries, as the code comment explains:

* @param timeout from first invoke to final completion of asynchronous operation, may include
*     multiple retries, and will be reset in case of restart

Update this in the documentation.

Brief change log

  • Make timeout param of async i/o more clearer

Verifying this change

  • doc changes only

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API, i.e., is any changed class annotated with @public(Evolving): (no)
  • The serializers: (no )
  • The runtime per-record code paths (performance sensitive): (no)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (no)
  • The S3 file system connector: (no)

Documentation

  • Does this pull request introduce a new feature? (no)
  • If yes, how is the feature documented? (docs)

@flinkbot
Copy link
Collaborator

flinkbot commented Jul 9, 2025

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Copy link
Contributor

@xuyangzhong xuyangzhong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

- **Timeout**: The timeout defines how long an asynchronous operation take before it is finally considered failed,
may include multiple retry requests if retry enabled. This parameter guards against dead/failed requests.
- **Timeout**: The timeout defines the maximum duration from the first invocation to the final completion of an asynchronous operation,
This duration may include multiple retry attempts (if retries are enabled) and determines when the operation is ultimately considered failed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we change:
is ultimately considered failed. -> is ultimately considered complete.

as the ### Timeout Handling section says we can call ResultFuture.complete() - implying a non failure completion after timeout.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sense, updated

@lincoln-lil lincoln-lil merged commit 8585d0f into apache:master Jul 10, 2025
@lincoln-lil lincoln-lil deleted the hotfix-async-doc branch July 10, 2025 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants