OCASDiskWriteAheadLog (OrientDB 3.0.44 API)

java.lang.Object
- com.orientechnologies.orient.core.storage.impl.local.paginated.wal.cas.OCASDiskWriteAheadLog

All Implemented Interfaces:: OWriteAheadLog

public final class OCASDiskWriteAheadLog
extends Object
implements OWriteAheadLog

Field Summary

Fields
Modifier and Type Field and Description

protected static int DEFAULT_MAX_CACHE_SIZE
- Fields inherited from interface com.orientechnologies.orient.core.storage.impl.local.paginated.wal.OWriteAheadLog
  MASTER_RECORD_EXTENSION, WAL_SEGMENT_EXTENSION

Fields
Modifier and Type	Field and Description
`protected static int`	`DEFAULT_MAX_CACHE_SIZE`

Constructor Summary

Constructors
Constructor and Description
`OCASDiskWriteAheadLog(String storageName, Path storagePath, Path walPath, int maxPagesCacheSize, int bufferSize, long segmentsInterval, long maxSegmentSize, int commitDelay, boolean filterWALFiles, Locale locale, long walSizeHardLimit, long freeSpaceLimit, int fsyncInterval, boolean keepSingleWALSegment, boolean callFsync, boolean printPerformanceStatistic, int statisticPrintInterval)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`activeSegment()`
`void`	`addCutTillLimit(OLogSequenceNumber lsn)` Adds LSN after which WAL log should be preserved.
`void`	`addEventAt(OLogSequenceNumber lsn, Runnable event)` Adds the event to fire when this write ahead log instances reaches the given LSN.
`void`	`addFullCheckpointListener(OCheckpointRequestListener listener)`
`void`	`addLowDiskSpaceListener(OLowDiskSpaceListener listener)`
`void`	`addSegmentOverflowListener(OSegmentOverflowListener listener)`
`boolean`	`appendNewSegment()` Adds new segment so all subsequent log entries will be added to this new segment.
`void`	`appendSegment(long segmentIndex)`
`OLogSequenceNumber`	`begin()`
`OLogSequenceNumber`	`begin(long segmentId)`
`void`	`close()`
`void`	`close(boolean flush)`
`boolean`	`cutAllSegmentsSmallerThan(long segmentId)`
`boolean`	`cutTill(OLogSequenceNumber lsn)` Cut WAL content till passed in value of LSN at maximum in many cases smaller portion of WAL may be cut.
`void`	`delete()`
`OLogSequenceNumber`	`end()`
`void`	`flush()`
`OLogSequenceNumber`	`getFlushedLsn()`
`OLogSequenceNumber`	`getLastCheckpoint()`
`List<String>`	`getWalFiles()`
`Path`	`getWMRFile()`
`OLogSequenceNumber`	`log(OWriteableWALRecord writeableRecord)`
`OLogSequenceNumber`	`logAtomicOperationEndRecord(long operationUnitId, boolean rollback, OLogSequenceNumber startLsn, Map<String,OAtomicOperationMetadata<?>> atomicOperationMetadata)`
`OLogSequenceNumber`	`logAtomicOperationStartRecord(boolean isRollbackSupported, long unitId)`
`OLogSequenceNumber`	`logFullCheckpointEnd()`
`OLogSequenceNumber`	`logFullCheckpointStart()`
`OLogSequenceNumber`	`logFuzzyCheckPointEnd()`
`OLogSequenceNumber`	`logFuzzyCheckPointStart(OLogSequenceNumber flushedLsn)`
`protected int`	`maxCacheSize()`
`void`	`moveLsnAfter(OLogSequenceNumber lsn)` Next LSN generated by WAL will be bigger than passed in value.
`List<OWriteableWALRecord>`	`next(OLogSequenceNumber lsn, int limit)`
`long[]`	`nonActiveSegments()`
`File[]`	`nonActiveSegments(long fromSegment)`
`int`	`pageSize()`
`List<OWriteableWALRecord>`	`read(OLogSequenceNumber lsn, int limit)`
`void`	`removeCutTillLimit(OLogSequenceNumber lsn)` Removes LSN after which WAL log should be preserved.
`void`	`removeFullCheckpointListener(OCheckpointRequestListener listener)`
`void`	`removeLowDiskSpaceListener(OLowDiskSpaceListener listener)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_CACHE_SIZE
```
protected static final int DEFAULT_MAX_CACHE_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OCASDiskWriteAheadLog
```
public OCASDiskWriteAheadLog(String storageName,
                             Path storagePath,
                             Path walPath,
                             int maxPagesCacheSize,
                             int bufferSize,
                             long segmentsInterval,
                             long maxSegmentSize,
                             int commitDelay,
                             boolean filterWALFiles,
                             Locale locale,
                             long walSizeHardLimit,
                             long freeSpaceLimit,
                             int fsyncInterval,
                             boolean keepSingleWALSegment,
                             boolean callFsync,
                             boolean printPerformanceStatistic,
                             int statisticPrintInterval)
                      throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - pageSize
```
public int pageSize()
```
  - maxCacheSize
```
protected int maxCacheSize()
```
  - read
```
public List<OWriteableWALRecord> read(OLogSequenceNumber lsn,
                                      int limit)
                               throws IOException
```
    Specified by:
    
    read in interface OWriteAheadLog
    
    Throws:
    
    IOException
  - next
```
public List<OWriteableWALRecord> next(OLogSequenceNumber lsn,
                                      int limit)
                               throws IOException
```
    Specified by:
    
    next in interface OWriteAheadLog
    
    Throws:
    
    IOException
  - addEventAt
```
public void addEventAt(OLogSequenceNumber lsn,
                       Runnable event)
```
    Description copied from interface: OWriteAheadLog
    
    Adds the event to fire when this write ahead log instances reaches the given LSN. The thread on which the event will be fired is unspecified, the event may be even fired synchronously before this method returns. Avoid running long tasks in the event handler since this may degrade the performance of this write ahead log and/or its event managing component. The exact LSN, up to which this write ahead log is actually grown, may differ from the event's LSN at the moment of invocation. But it's guarantied that the write ahead log's LSN will be larger than or equal to the event's LSN. In other words, the event invocation may be postponed, exact timings depend on implementation details of this write ahead log.
    
    Specified by:
    
    addEventAt in interface OWriteAheadLog
    
    Parameters:
    
    lsn - the LSN to fire at.
    
    event - the event to fire.
  - delete
```
public void delete()
            throws IOException
```
    Specified by:
    
    delete in interface OWriteAheadLog
    
    Throws:
    
    IOException
  - addCutTillLimit
```
public void addCutTillLimit(OLogSequenceNumber lsn)
```
    Description copied from interface: OWriteAheadLog
    
    Adds LSN after which WAL log should be preserved. It is possible to add many such LSNs smallest value among them will be used to limit value of LSN after which WAL may be cut.
    
    Specified by:
    
    addCutTillLimit in interface OWriteAheadLog
    
    Parameters:
    
    lsn - LSN after which cut of the WAL is not allowed.
    
    See Also:
    
    OWriteAheadLog.removeCutTillLimit(OLogSequenceNumber), OWriteAheadLog.cutTill(OLogSequenceNumber)
  - removeCutTillLimit
```
public void removeCutTillLimit(OLogSequenceNumber lsn)
```
    Description copied from interface: OWriteAheadLog
    
    Removes LSN after which WAL log should be preserved. It is possible to add many such LSNs smallest value among them will be used to limit value of LSN after which WAL may be cut.
    
    Specified by:
    
    removeCutTillLimit in interface OWriteAheadLog
    
    Parameters:
    
    lsn - LSN after which cut of the WAL is not allowed.
    
    See Also:
    
    OWriteAheadLog.removeCutTillLimit(OLogSequenceNumber), OWriteAheadLog.cutTill(OLogSequenceNumber)
  - logAtomicOperationStartRecord
```
public OLogSequenceNumber logAtomicOperationStartRecord(boolean isRollbackSupported,
                                                        long unitId)
```
    Specified by:
    
    logAtomicOperationStartRecord in interface OWriteAheadLog
  - logAtomicOperationEndRecord
```
public OLogSequenceNumber logAtomicOperationEndRecord(long operationUnitId,
                                                      boolean rollback,
                                                      OLogSequenceNumber startLsn,
                                                      Map<String,OAtomicOperationMetadata<?>> atomicOperationMetadata)
```
    Specified by:
    
    logAtomicOperationEndRecord in interface OWriteAheadLog
  - logFuzzyCheckPointStart
```
public OLogSequenceNumber logFuzzyCheckPointStart(OLogSequenceNumber flushedLsn)
```
    Specified by:
    
    logFuzzyCheckPointStart in interface OWriteAheadLog
  - logFuzzyCheckPointEnd
```
public OLogSequenceNumber logFuzzyCheckPointEnd()
```
    Specified by:
    
    logFuzzyCheckPointEnd in interface OWriteAheadLog
  - logFullCheckpointStart
```
public OLogSequenceNumber logFullCheckpointStart()
```
    Specified by:
    
    logFullCheckpointStart in interface OWriteAheadLog
  - logFullCheckpointEnd
```
public OLogSequenceNumber logFullCheckpointEnd()
```
    Specified by:
    
    logFullCheckpointEnd in interface OWriteAheadLog
  - getLastCheckpoint
```
public OLogSequenceNumber getLastCheckpoint()
```
    Specified by:
    
    getLastCheckpoint in interface OWriteAheadLog
  - log
```
public OLogSequenceNumber log(OWriteableWALRecord writeableRecord)
```
    Specified by:
    
    log in interface OWriteAheadLog
  - begin
```
public OLogSequenceNumber begin()
```
    Specified by:
    
    begin in interface OWriteAheadLog
  - begin
```
public OLogSequenceNumber begin(long segmentId)
```
    Specified by:
    
    begin in interface OWriteAheadLog
  - cutAllSegmentsSmallerThan
```
public boolean cutAllSegmentsSmallerThan(long segmentId)
                                  throws IOException
```
    Specified by:
    
    cutAllSegmentsSmallerThan in interface OWriteAheadLog
    
    Throws:
    
    IOException
  - cutTill
```
public boolean cutTill(OLogSequenceNumber lsn)
                throws IOException
```
    Description copied from interface: OWriteAheadLog
    
    Cut WAL content till passed in value of LSN at maximum in many cases smaller portion of WAL may be cut. If value of LSN is bigger than values provided in OWriteAheadLog.addCutTillLimit(OLogSequenceNumber) then "protected" part of WAL will be preserved for sure.
    
    Specified by:
    
    cutTill in interface OWriteAheadLog
    
    Parameters:
    
    lsn - Maximum value of LSN till WAL will be cut.
    
    Returns:
    
    true if some portion of WAL will be cut and false if WAL left untouched.
    
    Throws:
    
    IOException
  - activeSegment
```
public long activeSegment()
```
    Specified by:
    
    activeSegment in interface OWriteAheadLog
  - appendNewSegment
```
public boolean appendNewSegment()
```
    Description copied from interface: OWriteAheadLog
    Adds new segment so all subsequent log entries will be added to this new segment. New segment can not be appended if:
    1. WAL is empty
    2. There last segment in WAL is empty.
    Despite of the fact that WAL segment will not be appended, method call still will reach its main target, all subsequent log records will have segment number higher than previously logged records. But to inform user that segment is not added result of success of failure of this method will be returned.
    Specified by:
    
    appendNewSegment in interface OWriteAheadLog
    
    Returns:
    
    true if new segment is added, and false otherwise.
  - appendSegment
```
public void appendSegment(long segmentIndex)
```
  - getWalFiles
```
public List<String> getWalFiles()
```
  - getWMRFile
```
public Path getWMRFile()
```
  - moveLsnAfter
```
public void moveLsnAfter(OLogSequenceNumber lsn)
```
    Description copied from interface: OWriteAheadLog
    
    Next LSN generated by WAL will be bigger than passed in value. DO NOT REMOVE IT, USED IN ENTERPRISE STORAGE.
    
    Specified by:
    
    moveLsnAfter in interface OWriteAheadLog
  - nonActiveSegments
```
public long[] nonActiveSegments()
```
    Specified by:
    
    nonActiveSegments in interface OWriteAheadLog
  - nonActiveSegments
```
public File[] nonActiveSegments(long fromSegment)
```
    Specified by:
    
    nonActiveSegments in interface OWriteAheadLog
  - flush
```
public void flush()
```
    Specified by:
    
    flush in interface OWriteAheadLog
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface OWriteAheadLog
    
    Throws:
    
    IOException
  - close
```
public void close(boolean flush)
           throws IOException
```
    Specified by:
    
    close in interface OWriteAheadLog
    
    Throws:
    
    IOException
  - addLowDiskSpaceListener
```
public void addLowDiskSpaceListener(OLowDiskSpaceListener listener)
```
    Specified by:
    
    addLowDiskSpaceListener in interface OWriteAheadLog
  - removeLowDiskSpaceListener
```
public void removeLowDiskSpaceListener(OLowDiskSpaceListener listener)
```
    Specified by:
    
    removeLowDiskSpaceListener in interface OWriteAheadLog
  - addFullCheckpointListener
```
public void addFullCheckpointListener(OCheckpointRequestListener listener)
```
    Specified by:
    
    addFullCheckpointListener in interface OWriteAheadLog
  - removeFullCheckpointListener
```
public void removeFullCheckpointListener(OCheckpointRequestListener listener)
```
    Specified by:
    
    removeFullCheckpointListener in interface OWriteAheadLog
  - addSegmentOverflowListener
```
public void addSegmentOverflowListener(OSegmentOverflowListener listener)
```
  - getFlushedLsn
```
public OLogSequenceNumber getFlushedLsn()
```
    Specified by:
    
    getFlushedLsn in interface OWriteAheadLog
  - end
```
public OLogSequenceNumber end()
```
    Specified by:
    
    end in interface OWriteAheadLog

Class OCASDiskWriteAheadLog

Field Summary

Fields inherited from interface com.orientechnologies.orient.core.storage.impl.local.paginated.wal.OWriteAheadLog

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_CACHE_SIZE

Constructor Detail

OCASDiskWriteAheadLog

Method Detail

pageSize

maxCacheSize

read

next

addEventAt

delete

addCutTillLimit

removeCutTillLimit

logAtomicOperationStartRecord

logAtomicOperationEndRecord

logFuzzyCheckPointStart

logFuzzyCheckPointEnd

logFullCheckpointStart

logFullCheckpointEnd

getLastCheckpoint

log

begin

begin

cutAllSegmentsSmallerThan

cutTill

activeSegment

appendNewSegment

appendSegment

getWalFiles

getWMRFile

moveLsnAfter

nonActiveSegments

nonActiveSegments

flush

close

close

addLowDiskSpaceListener

removeLowDiskSpaceListener

addFullCheckpointListener

removeFullCheckpointListener

addSegmentOverflowListener

getFlushedLsn

end