com.xilinx.rapidwright.util

Class ParallelDCPOutput

Object

OutputStream

com.xilinx.rapidwright.util.ParallelDCPOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class ParallelDCPOutput
extends OutputStream

Class for Parallel DCP output operations: a stream of a file being added to a DCP (see DcpArchiveOutputStream.newParallelDCPOutput(org.python.apache.commons.compress.archivers.zip.ZipArchiveEntry)) that is written as pieces, each written and compressed in parallel (see ParallelDCPOutput.newStream(java.util.function.Consumer<java.io.OutputStream>)), rather than as bytes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFERRED_FILE_THRESHOLD Most bytes of compressed output that a stream from ParallelDCPOutput.newStream(java.util.function.Consumer<java.io.OutputStream>) keeps in memory: once more is written, all of it is moved to, and the rest written to, a temporary file instead (deleted once read into the DCP).

Method Summary

Modifier and Type	Method and Description
ParallelDCPInput	newStream(Consumer<OutputStream> f) A piece of this file: the data written by f, compressed.
void	write(int b) Unsupported: the file is only written as pieces, with ParallelDCPOutput.writePieces(List).
void	writePieces(List<? extends Future<ParallelDCPInput>> pieces) Add the file to the DCP from the given pieces, in order, each as soon as it is done (see DcpArchiveOutputStream.addRawArchiveEntryFromPieces(org.python.apache.commons.compress.archivers.zip.ZipArchiveEntry, java.util.List<? extends java.util.concurrent.Future<com.xilinx.rapidwright.util.ParallelDCPInput>>)).

Methods inherited from class OutputStream

close, flush, write, write

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFERRED_FILE_THRESHOLD

public static final int DEFERRED_FILE_THRESHOLD

Most bytes of compressed output that a stream from ParallelDCPOutput.newStream(java.util.function.Consumer<java.io.OutputStream>) keeps in memory: once more is written, all of it is moved to, and the rest written to, a temporary file instead (deleted once read into the DCP).

See Also:

Constant Field Values

Method Detail

newStream

public ParallelDCPInput newStream(Consumer<OutputStream> f)

A piece of this file: the data written by f, compressed. Its temporary file, if any, is deleted if writing the DCP fails, and, once writing the DCP has failed, this throws a CancellationException rather than call f, so that a piece whose task only starts then is not written only to be discarded.

Parameters:

f - Writes the piece's data.

Returns:

The piece.

writePieces

public void writePieces(List<? extends Future<ParallelDCPInput>> pieces)
                 throws IOException

Add the file to the DCP from the given pieces, in order, each as soon as it is done (see DcpArchiveOutputStream.addRawArchiveEntryFromPieces(org.python.apache.commons.compress.archivers.zip.ZipArchiveEntry, java.util.List<? extends java.util.concurrent.Future<com.xilinx.rapidwright.util.ParallelDCPInput>>)).

Parameters:

pieces - The pieces, in order, from ParallelDCPOutput.newStream(java.util.function.Consumer<java.io.OutputStream>) (each submitted, or already done), which must not be used otherwise from now on: a modifiable, random-access list (such as an ArrayList), as each element is set to null once waited for.

Throws:

IOException

write

public void write(int b)

Unsupported: the file is only written as pieces, with ParallelDCPOutput.writePieces(List).

Specified by:

write in class OutputStream