com.google.cloud.dataflow.sdk.runners.worker.ShuffleWriter Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (C) 2015 Google Inc.
 *
 * Licensed 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 com.google.cloud.dataflow.sdk.runners.worker;

import java.io.IOException;

/**
 * ShuffleWriter writes chunks of records to a shuffle dataset.
 */
interface ShuffleWriter extends AutoCloseable {
  /**
   * Writes a chunk of records. The chunk is a sequence of pairs encoded as:
   * 
   * where the sizes are 4-byte big-endian integers.
   */
  public void write(byte[] chunk) throws IOException;

  /**
   * Flushes written records and closes this writer.
   */
  @Override
  public void close() throws IOException;
}