io.aeron.driver.buffer

Interface LogFactory

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FileStoreLogFactory

public interface LogFactory
extends AutoCloseable

Factory interface for creating the log buffers under publications and images.

Method Summary

Modifier and Type	Method and Description
void	close()
RawLog	newImage(long correlationId, int termBufferLength, boolean useSparseFiles) Create a new RawLog for an image of a publication.
RawLog	newPublication(long correlationId, int termBufferLength, boolean useSparseFiles) Create a new RawLog for a publication.

Method Detail

close

void close()

Specified by:

close in interface AutoCloseable

newPublication

RawLog newPublication(long correlationId,
                      int termBufferLength,
                      boolean useSparseFiles)

Create a new RawLog for a publication.

Parameters:

correlationId - which is the original registration id for a publication.

termBufferLength - length of the buffer for each term.

useSparseFiles - should the file be sparse so the pages are only allocated as required.

Returns:

the newly created RawLog

newImage

RawLog newImage(long correlationId,
                int termBufferLength,
                boolean useSparseFiles)

Create a new RawLog for an image of a publication.

Parameters:

correlationId - assigned to uniquely identify an image on a driver.

termBufferLength - length of the buffer for each term.

useSparseFiles - should the file be sparse so the pages are only allocated as required.

Returns:

the newly created RawLog