Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ALL - Enum constant in enum class io.atomix.storage.journal.JournalReader.Mode
-
Reads all entries from the log.
- append(T) - Method in interface io.atomix.storage.journal.JournalWriter
-
Appends an entry to the journal.
B
- build() - Method in class io.atomix.storage.journal.JournalSegmentDescriptor.Builder
-
Builds the segment descriptor.
- build() - Method in interface io.atomix.storage.journal.JournalSerdes.Builder
-
Deprecated.Builds a
JournalSerdesinstance. - build() - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Build the
SegmentedByteBufJournal. - build() - Method in class io.atomix.utils.serializer.KryoJournalSerdesBuilder
-
Deprecated.
- build(String) - Method in interface io.atomix.storage.journal.JournalSerdes.Builder
-
Deprecated.Builds a
JournalSerdesinstance. - build(String) - Method in class io.atomix.utils.serializer.KryoJournalSerdesBuilder
-
Deprecated.
- builder() - Static method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns a descriptor builder.
- builder() - Static method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Creates a new
JournalSerdesbuilder. - builder() - Static method in class io.atomix.storage.journal.SegmentedByteBufJournal
- builder(int) - Static method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns a descriptor builder for the given descriptor buffer.
- BYTES - Static variable in record class io.atomix.storage.journal.JournalSegmentDescriptor
C
- close() - Method in interface io.atomix.storage.journal.Journal
- close() - Method in interface io.atomix.storage.journal.JournalReader
- close() - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
- close() - Method in class io.atomix.storage.journal.SegmentedJournal
- commit(long) - Method in interface io.atomix.storage.journal.JournalWriter
-
Commits entries up to the given index.
- COMMITS - Enum constant in enum class io.atomix.storage.journal.JournalReader.Mode
-
Reads committed entries from the log.
- compact(long) - Method in interface io.atomix.storage.journal.Journal
-
Compacts the journal up to the given index.
- compact(long) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
- compact(long) - Method in class io.atomix.storage.journal.SegmentedJournal
D
- deserialize(byte[]) - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Deserializes given byte array to Object.
- deserialize(InputStream) - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Deserializes given InputStream to an Object.
- deserialize(InputStream, int) - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Deserializes given InputStream to an Object.
- deserialize(ByteBuffer) - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Deserializes given byte buffer to Object.
- DISK - Enum constant in enum class io.atomix.storage.journal.StorageLevel
-
Stores data on disk.
E
- entry() - Method in record class io.atomix.storage.journal.Indexed
-
Returns the value of the
entryrecord component. - equals(Object) - Method in record class io.atomix.storage.journal.index.Position
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.atomix.storage.journal.Indexed
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Indicates whether some other object is "equal to" this one.
F
- firstIndex() - Method in interface io.atomix.storage.journal.Journal
-
Return the index of the first entry in the journal.
- firstIndex() - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
- firstIndex() - Method in class io.atomix.storage.journal.SegmentedJournal
- flush() - Method in interface io.atomix.storage.journal.JournalWriter
-
Flushes written entries to disk.
G
- getCompactableIndex(long) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
-
Returns the index of the last segment in the log.
- getNextIndex() - Method in interface io.atomix.storage.journal.JournalReader
-
Returns the next reader index.
- getNextIndex() - Method in interface io.atomix.storage.journal.JournalWriter
-
Returns the next index to be written.
H
- hashCode() - Method in record class io.atomix.storage.journal.index.Position
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.atomix.storage.journal.Indexed
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns a hash code value for this object.
I
- id() - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns the segment identifier.
- index() - Method in record class io.atomix.storage.journal.index.Position
-
Returns the value of the
indexrecord component. - index() - Method in record class io.atomix.storage.journal.Indexed
-
Returns the value of the
indexrecord component. - index() - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns the segment index.
- index(long, int) - Method in interface io.atomix.storage.journal.index.JournalIndex
-
Adds an entry for the given index at the given position.
- index(long, int) - Method in class io.atomix.storage.journal.index.SparseJournalIndex
- Indexed<E> - Record Class in io.atomix.storage.journal
-
Indexed journal entry.
- Indexed(long, E, int) - Constructor for record class io.atomix.storage.journal.Indexed
-
Creates an instance of a
Indexedrecord class. - io.atomix.storage.journal - package io.atomix.storage.journal
-
Provides a low-level journal abstraction for appending to logs and managing segmented logs.
- io.atomix.storage.journal.index - package io.atomix.storage.journal.index
-
Provides classes and interfaces for efficiently managing journal indexes.
- io.atomix.utils.serializer - package io.atomix.utils.serializer
-
Provides classes and interfaces for binary serialization.
- isCompactable(long) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
-
Returns a boolean indicating whether a segment can be removed from the journal prior to the given index.
J
- Journal<E> - Interface in io.atomix.storage.journal
-
Journal.
- JournalIndex - Interface in io.atomix.storage.journal.index
-
Index of a particular JournalSegment.
- JournalReader<E> - Interface in io.atomix.storage.journal
-
Log reader.
- JournalReader.EntryMapper<E,
T> - Interface in io.atomix.storage.journal -
A journal entry processor.
- JournalReader.Mode - Enum Class in io.atomix.storage.journal
-
Raft log reader mode.
- JournalSegmentDescriptor - Record Class in io.atomix.storage.journal
-
Stores information about a
JournalSegmentof the log. - JournalSegmentDescriptor(int, long, long, int, int, long, boolean) - Constructor for record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Creates an instance of a
JournalSegmentDescriptorrecord class. - JournalSegmentDescriptor.Builder - Class in io.atomix.storage.journal
-
Segment descriptor builder.
- JournalSerdes - Interface in io.atomix.storage.journal
-
Deprecated, for removal: This API element is subject to removal in a future version.
- JournalSerdes.Builder - Interface in io.atomix.storage.journal
-
Deprecated.Builder for
JournalSerdes. - JournalSerdes.EntryInput - Interface in io.atomix.storage.journal
-
Deprecated.Input data stream exposed to
JournalSerdes.EntrySerdes.read(EntryInput). - JournalSerdes.EntryOutput - Interface in io.atomix.storage.journal
-
Deprecated.Output data stream exposed to
JournalSerdes.EntrySerdes.write(EntryOutput, Object). - JournalSerdes.EntrySerdes<T> - Interface in io.atomix.storage.journal
-
Deprecated.A serializer/deserializer for an entry.
- JournalWriter<E> - Interface in io.atomix.storage.journal
-
Log writer.
K
- Kryo505ByteBufferInput - Class in io.atomix.utils.serializer
-
A Kryo-4.0.3 ByteBufferInput adapted to deal with issue 505.
- KryoJournalSerdesBuilder - Class in io.atomix.utils.serializer
-
Deprecated, for removal: This API element is subject to removal in a future version.
- KryoJournalSerdesBuilder() - Constructor for class io.atomix.utils.serializer.KryoJournalSerdesBuilder
-
Deprecated.
L
- last() - Method in interface io.atomix.storage.journal.index.JournalIndex
-
Return the last position known to this index.
- last() - Method in class io.atomix.storage.journal.index.SparseJournalIndex
- lastIndex() - Method in interface io.atomix.storage.journal.Journal
-
Return the index of the last entry in the journal.
- lastIndex() - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
- lastIndex() - Method in class io.atomix.storage.journal.SegmentedJournal
- locked() - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns the value of the
lockedrecord component. - lookup(long) - Method in interface io.atomix.storage.journal.index.JournalIndex
-
Looks up the position of the given index.
- lookup(long) - Method in class io.atomix.storage.journal.index.SparseJournalIndex
M
- mapEntry(long, E, int) - Method in interface io.atomix.storage.journal.JournalReader.EntryMapper
-
Process an entry.
- MAPPED - Enum constant in enum class io.atomix.storage.journal.StorageLevel
-
Stores data in a memory-mapped file.
- maxEntries() - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns the maximum number of entries allowed in the segment.
- maxSegmentSize() - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns the maximum count of the segment.
O
- ofNullable(Map.Entry<Long, Integer>) - Static method in record class io.atomix.storage.journal.index.Position
- openCommitsReader(long) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
- openReader(long) - Method in interface io.atomix.storage.journal.Journal
-
Opens a new journal reader with
JournalReader.Mode.ALL. - openReader(long) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
- openReader(long) - Method in class io.atomix.storage.journal.SegmentedJournal
- openReader(long, JournalReader.Mode) - Method in interface io.atomix.storage.journal.Journal
-
Opens a new journal reader with specified mode.
- openReader(long, JournalReader.Mode) - Method in class io.atomix.storage.journal.SegmentedJournal
-
Opens a new journal reader with the given reader mode.
- OutOfDiskSpace(String) - Constructor for exception io.atomix.storage.journal.StorageException.OutOfDiskSpace
P
- position() - Method in record class io.atomix.storage.journal.index.Position
-
Returns the value of the
positionrecord component. - Position - Record Class in io.atomix.storage.journal.index
-
Journal index position.
- Position(long, int) - Constructor for record class io.atomix.storage.journal.index.Position
-
Creates an instance of a
Positionrecord class. - Position(Map.Entry<Long, Integer>) - Constructor for record class io.atomix.storage.journal.index.Position
R
- read(JournalSerdes.EntryInput) - Method in interface io.atomix.storage.journal.JournalSerdes.EntrySerdes
-
Deprecated.
- readBytes(int) - Method in interface io.atomix.storage.journal.JournalSerdes.EntryInput
-
Deprecated.
- readFrom(ReadableByteChannel) - Static method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Read a JournalSegmentDescriptor from a
ReadableByteChannel. - readLong() - Method in interface io.atomix.storage.journal.JournalSerdes.EntryInput
-
Deprecated.
- readObject() - Method in interface io.atomix.storage.journal.JournalSerdes.EntryInput
-
Deprecated.
- readString() - Method in interface io.atomix.storage.journal.JournalSerdes.EntryInput
-
Deprecated.
- readString() - Method in class io.atomix.utils.serializer.Kryo505ByteBufferInput
- readStringBuilder() - Method in class io.atomix.utils.serializer.Kryo505ByteBufferInput
- readVarInt() - Method in interface io.atomix.storage.journal.JournalSerdes.EntryInput
-
Deprecated.
- register(JournalSerdes.EntrySerdes<?>, Class<?>...) - Method in interface io.atomix.storage.journal.JournalSerdes.Builder
-
Deprecated.Registers serializer for the given set of classes.
- register(JournalSerdes.EntrySerdes<?>, Class<?>...) - Method in class io.atomix.utils.serializer.KryoJournalSerdesBuilder
-
Deprecated.
- reset() - Method in interface io.atomix.storage.journal.JournalReader
-
Resets the reader to the start.
- reset(long) - Method in interface io.atomix.storage.journal.JournalReader
-
Resets the reader to the given index.
- reset(long) - Method in interface io.atomix.storage.journal.JournalWriter
-
Resets the head of the journal to the given index.
S
- SegmentedByteBufJournal - Class in io.atomix.storage.journal
-
A
RaftJournalImplementation. - SegmentedByteBufJournal.Builder - Class in io.atomix.storage.journal
-
Segmented byte journal builder.
- SegmentedJournal<E> - Class in io.atomix.storage.journal
-
A
Journalimplementation based on aRaftJournal. - SegmentedJournal(RaftJournal, FromByteBufMapper<E>, ToByteBufMapper<E>) - Constructor for class io.atomix.storage.journal.SegmentedJournal
- serialize(Object) - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Serializes given object to byte array.
- serialize(Object, int) - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Serializes given object to byte array.
- serialize(Object, OutputStream) - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Serializes given object to OutputStream.
- serialize(Object, OutputStream, int) - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Serializes given object to OutputStream.
- serialize(Object, ByteBuffer) - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Serializes given object to byte buffer.
- setClassLoader(ClassLoader) - Method in interface io.atomix.storage.journal.JournalSerdes.Builder
-
Deprecated.Sets the namespace class loader.
- setClassLoader(ClassLoader) - Method in class io.atomix.utils.serializer.KryoJournalSerdesBuilder
-
Deprecated.
- size() - Method in record class io.atomix.storage.journal.Indexed
-
Returns the value of the
sizerecord component. - size() - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
-
Returns the total size of the journal.
- SparseJournalIndex - Class in io.atomix.storage.journal.index
-
A
JournalIndexmaintaining target density. - SparseJournalIndex() - Constructor for class io.atomix.storage.journal.index.SparseJournalIndex
- SparseJournalIndex(double) - Constructor for class io.atomix.storage.journal.index.SparseJournalIndex
- StorageException - Exception in io.atomix.storage.journal
-
Log exception.
- StorageException() - Constructor for exception io.atomix.storage.journal.StorageException
- StorageException(String) - Constructor for exception io.atomix.storage.journal.StorageException
- StorageException(String, Throwable) - Constructor for exception io.atomix.storage.journal.StorageException
- StorageException(Throwable) - Constructor for exception io.atomix.storage.journal.StorageException
- StorageException.OutOfDiskSpace - Exception in io.atomix.storage.journal
-
Exception thrown when storage runs out of disk space.
- StorageException.TooLarge - Exception in io.atomix.storage.journal
-
Exception thrown when an entry being stored is too large.
- StorageLevel - Enum Class in io.atomix.storage.journal
-
Storage level configuration values which control how logs are stored on disk or in memory.
T
- TooLarge(String) - Constructor for exception io.atomix.storage.journal.StorageException.TooLarge
- TooLarge(String, Throwable) - Constructor for exception io.atomix.storage.journal.StorageException.TooLarge
- toReadMapper() - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Returns a
FromByteBufMapperbacked by this object. - toString() - Method in record class io.atomix.storage.journal.index.Position
-
Returns a string representation of this record class.
- toString() - Method in class io.atomix.storage.journal.index.SparseJournalIndex
- toString() - Method in record class io.atomix.storage.journal.Indexed
-
Returns a string representation of this record class.
- toString() - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns a string representation of this record class.
- toString() - Method in class io.atomix.storage.journal.SegmentedJournal
- toWriteMapper() - Method in interface io.atomix.storage.journal.JournalSerdes
-
Deprecated.Returns a
ToByteBufMapperbacked by this object. - truncate(long) - Method in interface io.atomix.storage.journal.index.JournalIndex
-
Truncates the index to the given index and returns its position, if available.
- truncate(long) - Method in class io.atomix.storage.journal.index.SparseJournalIndex
- tryNext(JournalReader.EntryMapper<E, T>) - Method in interface io.atomix.storage.journal.JournalReader
-
Try to move to the next entry.
U
- updated() - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns last time the segment was updated.
V
- valueOf(String) - Static method in enum class io.atomix.storage.journal.JournalReader.Mode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.atomix.storage.journal.StorageLevel
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.atomix.storage.journal.JournalReader.Mode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.atomix.storage.journal.StorageLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version() - Method in record class io.atomix.storage.journal.JournalSegmentDescriptor
-
Returns the segment version.
W
- withByteBufAllocator(ByteBufAllocator) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Sets the
ByteBufAllocatorto use for allocating various buffers. - withDirectory(File) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Sets the journal directory.
- withDirectory(String) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Sets the journal directory.
- withFlushOnCommit() - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Enables flushing buffers to disk when entries are committed to a segment.
- withFlushOnCommit(boolean) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Sets whether to flush buffers to disk when entries are committed to a segment.
- withId(long) - Method in class io.atomix.storage.journal.JournalSegmentDescriptor.Builder
-
Sets the segment identifier.
- withIndex(long) - Method in class io.atomix.storage.journal.JournalSegmentDescriptor.Builder
-
Sets the segment index.
- withIndexDensity(double) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Sets the journal index density.
- withMaxEntries(int) - Method in class io.atomix.storage.journal.JournalSegmentDescriptor.Builder
-
Deprecated.since 3.0.2
- withMaxEntriesPerSegment(int) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Deprecated, for removal: This API element is subject to removal in a future version.This option has no effect and is scheduled for removal.
- withMaxEntrySize(int) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Sets the maximum entry size in bytes.
- withMaxSegmentSize(int) - Method in class io.atomix.storage.journal.JournalSegmentDescriptor.Builder
-
Sets maximum count of the segment.
- withMaxSegmentSize(int) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Sets the maximum segment size in bytes.
- withName(String) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Sets the journal name.
- withStorageLevel(StorageLevel) - Method in class io.atomix.storage.journal.SegmentedByteBufJournal.Builder
-
Sets the storage level.
- withUpdated(long) - Method in class io.atomix.storage.journal.JournalSegmentDescriptor.Builder
-
Sets updated timestamp.
- write(JournalSerdes.EntryOutput, T) - Method in interface io.atomix.storage.journal.JournalSerdes.EntrySerdes
-
Deprecated.
- writeBytes(byte[]) - Method in interface io.atomix.storage.journal.JournalSerdes.EntryOutput
-
Deprecated.
- writeLong(long) - Method in interface io.atomix.storage.journal.JournalSerdes.EntryOutput
-
Deprecated.
- writeObject(Object) - Method in interface io.atomix.storage.journal.JournalSerdes.EntryOutput
-
Deprecated.
- writer() - Method in interface io.atomix.storage.journal.Journal
-
Returns the journal writer.
- writer() - Method in class io.atomix.storage.journal.SegmentedByteBufJournal
- writer() - Method in class io.atomix.storage.journal.SegmentedJournal
- writeString(String) - Method in interface io.atomix.storage.journal.JournalSerdes.EntryOutput
-
Deprecated.
- writeVarInt(int) - Method in interface io.atomix.storage.journal.JournalSerdes.EntryOutput
-
Deprecated.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
FromByteBufMapperto be used instead.