beliefer opened a new pull request, #26469:
URL: https://github.com/apache/flink/pull/26469
## What is the purpose of the change
This PR aims to improve the comments and variable names for `TaskMailbox`.
There are some improvement points show below.
- `message` -> `mail`. `mail` is a more suitable name in the context of
`TaskMailbox`.
- Adds comments to increasing the readability of `tryTake` and `take`. These
comments show below.
`Note that the priority is given to retrieving email from the head of
batch, and when email cannot be retrieved from the batch, it is retrieved from
the head of queue. This also means that emails in batch are older than emails
in queue.`
- Supplement the missing exception into comments.
- `The default batch is empty.` -> `By default, the batch is empty.`. The
latter is more accurate.
- `(head of queue)` -> `(head of batch)`. We only fetch the head mail from
the `batch` not the `queue` with `tryTakeFromBatch`.
- `head` -> `headEmail`. The latter is a better variable name. Some code
uses `headEmail` and other uses `head` before this PR. We should unify the name.
- Move the size() in `TaskMailboxImpl` so that it follows the order of the
declaration in the interface `TaskMailbox`.
## Brief change log
Improve the comments and variable names for `TaskMailbox`.
## Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
## 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)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
