io.aeron.archive

Class ArchiveMarkFile

java.lang.Object

io.aeron.archive.ArchiveMarkFile

All Implemented Interfaces:

AutoCloseable

public class ArchiveMarkFile
extends Object
implements AutoCloseable

Used to mark the presence of a running Archive in a directory to guard it.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILENAME Name for the archive MarkFile stored in the Archive.Configuration.ARCHIVE_DIR_PROP_NAME.
static int	HEADER_LENGTH Header length for the MarkFile containing the metadata.
static int	MAJOR_VERSION Major version for the archive files stored on disk.
static int	MINOR_VERSION Minor version for the archive files stored on disk.
static int	PATCH_VERSION Patch version for the archive files stored on disk.
static int	SEMANTIC_VERSION Combined semantic version for the stored files.

Constructor Summary

Constructors

Constructor and Description
ArchiveMarkFile(File directory, String filename, EpochClock epochClock, long timeoutMs, Consumer<String> logger) Construct the MarkFile based on an existing directory containing a mark file of a running archive.
ArchiveMarkFile(File directory, String filename, EpochClock epochClock, long timeoutMs, IntConsumer versionCheck, Consumer<String> logger) Open an existing MarkFile or create a new one to be used in migration.

Method Summary

Modifier and Type	Method and Description
long	activityTimestampVolatile() Read the activity timestamp of the archive with volatile semantics.
void	close()
MarkFileHeaderDecoder	decoder() The decoder for reading the MarkFile header.
MarkFileHeaderEncoder	encoder() The encoder for writing the MarkFile header.
AtomicBuffer	errorBuffer() The direct buffer which wraps the region of the MarkFile which contains the error log.
static void	saveExistingErrors(File markFile, AtomicBuffer errorBuffer, PrintStream logger) Save the existing errors from a MarkFile to a PrintStream for logging.
void	signalReady() Signal the archive has concluded successfully and ready to start.
void	updateActivityTimestamp(long nowMs) Update the activity timestamp as a proof of life.

Methods inherited from class java.lang.Object

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

Field Detail

MAJOR_VERSION

public static final int MAJOR_VERSION

Major version for the archive files stored on disk. A change to this requires migration.

See Also:

Constant Field Values

MINOR_VERSION

public static final int MINOR_VERSION

Minor version for the archive files stored on disk. A change to this indicates new features.

See Also:

Constant Field Values

PATCH_VERSION

public static final int PATCH_VERSION

Patch version for the archive files stored on disk. A change to this indicates feature parity bug fixes.

See Also:

Constant Field Values

SEMANTIC_VERSION

public static final int SEMANTIC_VERSION

Combined semantic version for the stored files.

See Also:

SemanticVersion

HEADER_LENGTH

public static final int HEADER_LENGTH

Header length for the MarkFile containing the metadata.

See Also:

Constant Field Values

FILENAME

public static final String FILENAME

Name for the archive MarkFile stored in the Archive.Configuration.ARCHIVE_DIR_PROP_NAME.

See Also:

Constant Field Values

Constructor Detail

ArchiveMarkFile

public ArchiveMarkFile(File directory,
                       String filename,
                       EpochClock epochClock,
                       long timeoutMs,
                       Consumer<String> logger)

Construct the MarkFile based on an existing directory containing a mark file of a running archive.

Parameters:

directory - containing the archive files.

filename - for the mark file.

epochClock - to be used for checking liveness.

timeoutMs - after which the opening will be aborted if no archive starts.

logger - to detail any discoveries.

ArchiveMarkFile

public ArchiveMarkFile(File directory,
                       String filename,
                       EpochClock epochClock,
                       long timeoutMs,
                       IntConsumer versionCheck,
                       Consumer<String> logger)

Open an existing MarkFile or create a new one to be used in migration.

Parameters:

directory - containing the archive files.

filename - for the mark file.

epochClock - to be used for checking liveness.

timeoutMs - after which the opening will be aborted if no archive starts.

versionCheck - for confirming the correct version.

logger - to detail any discoveries.

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

signalReady

public void signalReady()

Signal the archive has concluded successfully and ready to start.

updateActivityTimestamp

public void updateActivityTimestamp(long nowMs)

Update the activity timestamp as a proof of life.

Parameters:

nowMs - activity timestamp as a proof of life.

activityTimestampVolatile

public long activityTimestampVolatile()

Read the activity timestamp of the archive with volatile semantics.

Returns:

the activity timestamp of the archive with volatile semantics.

encoder

public MarkFileHeaderEncoder encoder()

The encoder for writing the MarkFile header.

Returns:

the encoder for writing the MarkFile header.

decoder

public MarkFileHeaderDecoder decoder()

The decoder for reading the MarkFile header.

Returns:

the decoder for reading the MarkFile header.

errorBuffer

public AtomicBuffer errorBuffer()

The direct buffer which wraps the region of the MarkFile which contains the error log.

Returns:

the direct buffer which wraps the region of the MarkFile which contains the error log.

saveExistingErrors

public static void saveExistingErrors(File markFile,
                                      AtomicBuffer errorBuffer,
                                      PrintStream logger)

Save the existing errors from a MarkFile to a PrintStream for logging.

Parameters:

markFile - which contains the error buffer.

errorBuffer - which wraps the error log.

logger - to which the existing errors will be printed.