| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.io.asyncfs, interface: AsyncFSOutput"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.io.asyncfs;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.Closeable;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.nio.ByteBuffer;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.concurrent.CompletableFuture;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.CancelableProgressable;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hdfs.protocol.DatanodeInfo;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * Interface for asynchronous filesystem output stream.</span> |
| <span class="source-line-no">030</span><span id="line-30"> * <p></span> |
| <span class="source-line-no">031</span><span id="line-31"> * The implementation is not required to be thread safe.</span> |
| <span class="source-line-no">032</span><span id="line-32"> */</span> |
| <span class="source-line-no">033</span><span id="line-33">@InterfaceAudience.Private</span> |
| <span class="source-line-no">034</span><span id="line-34">public interface AsyncFSOutput extends Closeable {</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36"> /**</span> |
| <span class="source-line-no">037</span><span id="line-37"> * Just call write(b, 0, b.length).</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @see #write(byte[], int, int)</span> |
| <span class="source-line-no">039</span><span id="line-39"> */</span> |
| <span class="source-line-no">040</span><span id="line-40"> void write(byte[] b);</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42"> /**</span> |
| <span class="source-line-no">043</span><span id="line-43"> * Copy the data into the buffer. Note that you need to call {@link #flush(boolean)} to flush the</span> |
| <span class="source-line-no">044</span><span id="line-44"> * buffer manually.</span> |
| <span class="source-line-no">045</span><span id="line-45"> */</span> |
| <span class="source-line-no">046</span><span id="line-46"> void write(byte[] b, int off, int len);</span> |
| <span class="source-line-no">047</span><span id="line-47"></span> |
| <span class="source-line-no">048</span><span id="line-48"> /**</span> |
| <span class="source-line-no">049</span><span id="line-49"> * Write an int to the buffer.</span> |
| <span class="source-line-no">050</span><span id="line-50"> */</span> |
| <span class="source-line-no">051</span><span id="line-51"> void writeInt(int i);</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * Copy the data in the given {@code bb} into the buffer.</span> |
| <span class="source-line-no">055</span><span id="line-55"> */</span> |
| <span class="source-line-no">056</span><span id="line-56"> void write(ByteBuffer bb);</span> |
| <span class="source-line-no">057</span><span id="line-57"></span> |
| <span class="source-line-no">058</span><span id="line-58"> /**</span> |
| <span class="source-line-no">059</span><span id="line-59"> * Return the current size of buffered data.</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61"> int buffered();</span> |
| <span class="source-line-no">062</span><span id="line-62"></span> |
| <span class="source-line-no">063</span><span id="line-63"> /**</span> |
| <span class="source-line-no">064</span><span id="line-64"> * Whether the stream is broken.</span> |
| <span class="source-line-no">065</span><span id="line-65"> */</span> |
| <span class="source-line-no">066</span><span id="line-66"> boolean isBroken();</span> |
| <span class="source-line-no">067</span><span id="line-67"></span> |
| <span class="source-line-no">068</span><span id="line-68"> /**</span> |
| <span class="source-line-no">069</span><span id="line-69"> * Return current pipeline. Empty array if no pipeline.</span> |
| <span class="source-line-no">070</span><span id="line-70"> */</span> |
| <span class="source-line-no">071</span><span id="line-71"> DatanodeInfo[] getPipeline();</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> /**</span> |
| <span class="source-line-no">074</span><span id="line-74"> * Flush the buffer out.</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @param sync persistent the data to device</span> |
| <span class="source-line-no">076</span><span id="line-76"> * @return A CompletableFuture that hold the acked length after flushing.</span> |
| <span class="source-line-no">077</span><span id="line-77"> */</span> |
| <span class="source-line-no">078</span><span id="line-78"> CompletableFuture<Long> flush(boolean sync);</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> /**</span> |
| <span class="source-line-no">081</span><span id="line-81"> * The close method when error occurred.</span> |
| <span class="source-line-no">082</span><span id="line-82"> */</span> |
| <span class="source-line-no">083</span><span id="line-83"> void recoverAndClose(CancelableProgressable reporter) throws IOException;</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> /**</span> |
| <span class="source-line-no">086</span><span id="line-86"> * Close the file. You should call {@link #recoverAndClose(CancelableProgressable)} if this method</span> |
| <span class="source-line-no">087</span><span id="line-87"> * throws an exception.</span> |
| <span class="source-line-no">088</span><span id="line-88"> */</span> |
| <span class="source-line-no">089</span><span id="line-89"> @Override</span> |
| <span class="source-line-no">090</span><span id="line-90"> void close() throws IOException;</span> |
| <span class="source-line-no">091</span><span id="line-91"></span> |
| <span class="source-line-no">092</span><span id="line-92"> /** Returns byteSize success synced to underlying filesystem. */</span> |
| <span class="source-line-no">093</span><span id="line-93"> long getSyncedLength();</span> |
| <span class="source-line-no">094</span><span id="line-94">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
