浏览代码

HDFS-12251. Add document for StreamCapabilities. (Lei (Eddy) Xu)

(cherry picked from commit fe3341786a0d61f404127bf21d1afc85b2f21d38)

Conflicts:
	hadoop-hdfs-project/hadoop-hdfs/src/site/markdown/HDFSErasureCoding.md
Lei Xu 8 年之前
父节点
当前提交
d87a92bf55
共有 1 个文件被更改,包括 24 次插入0 次删除
  1. 24 0
      hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md

+ 24 - 0
hadoop-common-project/hadoop-common/src/site/markdown/filesystem/filesystem.md

@@ -1199,3 +1199,27 @@ try {
 It is notable that this is *not* done in the Hadoop codebase. This does not imply
 It is notable that this is *not* done in the Hadoop codebase. This does not imply
 that robust loops are not recommended —more that the concurrency
 that robust loops are not recommended —more that the concurrency
 problems were not considered during the implementation of these loops.
 problems were not considered during the implementation of these loops.
+
+
+## <a name="StreamCapability"></a> interface `StreamCapabilities`
+
+The `StreamCapabilities` provides a way to programmatically query the
+capabilities that an `OutputStream` supports.
+
+```java
+public interface StreamCapabilities {
+  boolean hasCapability(String capability);
+}
+```
+
+### `boolean hasCapability(capability)`
+
+Return true if the `OutputStream` has the desired capability.
+
+The caller can query the capabilities of a stream using a string value.
+It currently supports to query:
+
+ * `StreamCapabilties.HFLUSH` ("*hflush*"): the capability to flush out the data
+ in client's buffer.
+ * `StreamCapabilities.HSYNC` ("*hsync*"): capability to flush out the data in
+ client's buffer and the disk device.