All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.hadoop.hbase.io.asyncfs.AsyncFSOutput Maven / Gradle / Ivy

There is a newer version: 3.0.0-beta-1
Show newest version
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.io.asyncfs;

import java.io.Closeable;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.util.concurrent.CompletableFuture;

import org.apache.yetus.audience.InterfaceAudience;
import org.apache.hadoop.hbase.util.CancelableProgressable;
import org.apache.hadoop.hdfs.protocol.DatanodeInfo;

/**
 * Interface for asynchronous filesystem output stream.
 * 

* The implementation is not required to be thread safe. */ @InterfaceAudience.Private public interface AsyncFSOutput extends Closeable { /** * Just call write(b, 0, b.length). * @see #write(byte[], int, int) */ void write(byte[] b); /** * Copy the data into the buffer. Note that you need to call {@link #flush(boolean)} to flush the * buffer manually. */ void write(byte[] b, int off, int len); /** * Write an int to the buffer. */ void writeInt(int i); /** * Copy the data in the given {@code bb} into the buffer. */ void write(ByteBuffer bb); /** * Return the current size of buffered data. */ int buffered(); /** * Whether the stream is broken. */ boolean isBroken(); /** * Return current pipeline. Empty array if no pipeline. */ DatanodeInfo[] getPipeline(); /** * Flush the buffer out. * @param sync persistent the data to device * @return A CompletableFuture that hold the acked length after flushing. */ CompletableFuture flush(boolean sync); /** * The close method when error occurred. */ void recoverAndClose(CancelableProgressable reporter) throws IOException; /** * Close the file. You should call {@link #recoverAndClose(CancelableProgressable)} if this method * throws an exception. */ @Override void close() throws IOException; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy