shuffle/api/WritableByteChannelWrapper.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.shuffle.api;
0019
0020 import java.io.Closeable;
0021 import java.nio.channels.WritableByteChannel;
0022
0023 import org.apache.spark.annotation.Private;
0024
0025 /**
0026  * :: Private ::
0027  *
0028  * A thin wrapper around a {@link WritableByteChannel}.
0029  * <p>
0030  * This is primarily provided for the local disk shuffle implementation to provide a
0031  * {@link java.nio.channels.FileChannel} that keeps the channel open across partition writes.
0032  *
0033  * @since 3.0.0
0034  */
0035 @Private
0036 public interface WritableByteChannelWrapper extends Closeable {
0037
0038   /**
0039    * The underlying channel to write bytes into.
0040    */
0041   WritableByteChannel channel();
0042 }