com.gigaspaces.internal.server.space.redolog.storage

Interface IRedoLogFileStorage<T extends IReplicationOrderedPacket>

All Superinterfaces:

IRedoLogFileStorageStatistics

All Known Subinterfaces:

INonBatchRedoLogFileStorage<T>

All Known Implementing Classes:

BufferedRedoLogFileStorageDecorator, ByteBufferRedoLogFileStorage, CacheLastRedoLogFileStorageDecorator, SqliteRedoLogFileStorage

public interface IRedoLogFileStorage<T extends IReplicationOrderedPacket>
extends IRedoLogFileStorageStatistics

Provide an external storage for a redo log file, Packets are stored as a single list, adding packets are always appended at the end of the list, and removal of packets are always from the start of the list Implementor should support concurrent readers or a single writer, in other words, the implementor can assume access to this structure are guarded with a reader writer lock according to the operation type An exception is size() method which should not assume a reader lock is held.

Since:

7.1

Author:

eitany

Method Summary

Modifier and Type	Method and Description
void	appendBatch(List<T> replicationPackets) Adds a batch of packets that will be stored at the end of the list
void	close() Close the storage and clears its resources, the storage can no longer be used.
void	deleteOldestPackets(long packetsCount) Delete a batch from the start of the list
long	getCacheWeight()
long	getDiscardedPacketsCount()
default T	getOldest()
long	getWeight()
boolean	isEmpty()
CompactionResult	performCompaction(long from, long to)
StorageReadOnlyIterator<T>	readOnlyIterator(long fromIndex)
WeightedBatch<T>	removeFirstBatch(int batchCapacity, long lastCompactionRangeEndKey) Removes a batch from the start of the list
default T	removeOldest()
long	size() This method should not assume a reader lock is obtained when accessing it
void	validateIntegrity() Validates the integrity of the storage

Methods inherited from interface com.gigaspaces.internal.server.space.redolog.storage.IRedoLogFileStorageStatistics

getExternalPacketsCount, getExternalStoragePacketsWeight, getMemoryPacketsCount, getMemoryPacketsWeight, getSpaceUsed

Method Detail

appendBatch

void appendBatch(List<T> replicationPackets)
          throws StorageException,
                 StorageFullException

Adds a batch of packets that will be stored at the end of the list

Parameters:

replicationPackets - packets to store

Throws:

StorageException

StorageFullException

size

long size()
   throws StorageException

This method should not assume a reader lock is obtained when accessing it

Returns:

number of packets in the storage

Throws:

StorageException

removeFirstBatch

WeightedBatch<T> removeFirstBatch(int batchCapacity,
                                  long lastCompactionRangeEndKey)
                           throws StorageException

Removes a batch from the start of the list

Parameters:

batchCapacity - WeightToRemove to remove

lastCompactionRangeEndKey - packets with keys larger than this cannot be discarded

Returns:

removed batch

Throws:

StorageException

deleteOldestPackets

void deleteOldestPackets(long packetsCount)
                  throws StorageException

Delete a batch from the start of the list

Parameters:

packetsCount - number of packets to delete

Throws:

StorageException

readOnlyIterator

StorageReadOnlyIterator<T> readOnlyIterator(long fromIndex)
                                     throws StorageException

Parameters:

fromIndex - index to start iterating from

Returns:

read only iterator that starts from the specified index

Throws:

StorageException

isEmpty

boolean isEmpty()
         throws StorageException

Returns:

true if the storage has no packets

Throws:

StorageException

validateIntegrity

void validateIntegrity()
                throws RedoLogFileCompromisedException

Validates the integrity of the storage

Throws:

RedoLogFileCompromisedException

close

void close()

Close the storage and clears its resources, the storage can no longer be used.

getWeight

long getWeight()

getDiscardedPacketsCount

long getDiscardedPacketsCount()

performCompaction

CompactionResult performCompaction(long from,
                                   long to)

getCacheWeight

long getCacheWeight()

getOldest

default T getOldest()
             throws StorageException

Throws:

StorageException

removeOldest

default T removeOldest()
                throws StorageException

Throws:

StorageException