pnowojski commented on a change in pull request #10029: [FLINK-14553][runtime]
Respect non-blocking output in StreamTask#processInput
URL: https://github.com/apache/flink/pull/10029#discussion_r340022507
##########
File path:
flink-runtime/src/main/java/org/apache/flink/runtime/io/AvailabilityProvider.java
##########
@@ -29,10 +29,30 @@
public interface AvailabilityProvider {
/**
* Constant that allows to avoid volatile checks {@link
CompletableFuture#isDone()}. Check
- * {@link #getAvailableFuture()} for more explanation.
+ * {@link #isAvailable()} and {@link #isVolatileAvailable()}for more
explanation.
*/
CompletableFuture<?> AVAILABLE =
CompletableFuture.completedFuture(null);
+ /**
+ * Checks whether this instance is available via constant {@link
#AVAILABLE} to avoid volatile access.
+ *
+ * @return true if this instance is available for further processing.
+ */
Review comment:
Maybe add a bit more explanation when to use and when to not use this one?
That it's safe to use if `isVolatileAvailable()` was called or
`getAvailableFuture()` was touched (`.get()`, `.wait()`, `.isDone()`, ...)
before? More precisely, it's safe to use if either `isVolatileAvailable()` or
touching `getAvailableFuture()` has a "happen-before" relationship with
`isAvailable()` call.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
