net.openhft.chronicle.queue

Interface ExcerptCommon<E extends ExcerptCommon<E>>

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.SingleThreadedChecked

All Known Subinterfaces:

ExcerptAppender, ExcerptTailer, InternalAppender

public interface ExcerptCommon<E extends ExcerptCommon<E>>
extends net.openhft.chronicle.core.io.Closeable, net.openhft.chronicle.core.io.SingleThreadedChecked

The ExcerptCommon is common to both ExcerptAppender and ExcerptTailer.

Field Summary

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Method Summary

Modifier and Type	Method and Description
default @Nullable File	currentFile()
default E	disableThreadSafetyCheck(boolean disableThreadSafetyCheck) Deprecated.
@NotNull ChronicleQueue	queue() Returns the backing ChronicleQueue to which this ExcerptCommon is attached to.
int	sourceId() Returns the source id of the backing ChronicleQueue to which this ExcerptCommon is attached to.
default void	sync() Performa sync up to the point the Appender has written or Tailer has read, if supported.

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing

Methods inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

singleThreadedCheckDisabled, singleThreadedCheckReset

Method Detail

sourceId

int sourceId()

Returns the source id of the backing ChronicleQueue to which this ExcerptCommon is attached to.

Returns:

the source id of the backing ChronicleQueue

See Also:

ChronicleQueue.sourceId()

queue

@NotNull
@NotNull ChronicleQueue queue()

Returns the backing ChronicleQueue to which this ExcerptCommon is attached to.

Returns:

the backing ChronicleQueue to which this ExcerptCommon is attached to

disableThreadSafetyCheck

@Deprecated
 @NotNull
default E disableThreadSafetyCheck(boolean disableThreadSafetyCheck)

Deprecated.

When set to true this Appender or Tailer can be shared between thread provided you ensure they used in a thread safe manner.

Parameters:

disableThreadSafetyCheck - true to turn off the thread safety check

Returns:

this.

currentFile

@Nullable
default @Nullable File currentFile()

Returns:

the current file being worked on or null if not known.

sync

default void sync()

Performa sync up to the point the Appender has written or Tailer has read, if supported.