Chunk (Hazelcast Enterprise Hot Restart 3.12.12 API)

java.lang.Object
- com.hazelcast.spi.hotrestart.impl.gc.chunk.Chunk

All Implemented Interfaces:

com.hazelcast.nio.Disposable

Direct Known Subclasses:

GrowingChunk, StableChunk
```
public abstract class Chunk
extends Object
implements com.hazelcast.nio.Disposable
```
Represents a chunk file.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTIVE_FNAME_SUFFIX` Suffix added to the chunk file while it is active.
`static String`	`FNAME_SUFFIX` Chunk filename suffix.
`long`	`garbage` The amount of garbage in this chunk in bytes.
`int`	`liveRecordCount`
`RecordMap`	`records`
`long`	`seq` Unique sequence number of this chunk.
`static String`	`SURVIVOR_FNAME_SUFFIX` Suffix added to a chunk file while it is being written to during a GC cycle.
`static String`	`SYSPROP_TOMB_CHUNK_SIZE_LIMIT` System property that specifies the limit on the tombstone chunk file size
`static String`	`SYSPROP_VAL_CHUNK_SIZE_LIMIT` System property that specifies the limit on the value chunk file size
`static String`	`TOMB_BASEDIR` Name of the base directory for tombstone records.
`static int`	`TOMB_SIZE_LIMIT_DEFAULT` Default tombstone chunk file size limit in bytes.
`static String`	`VAL_BASEDIR` Name of the base directory for value records.
`static int`	`VAL_SIZE_LIMIT_DEFAULT` Default value chunk file size limit in bytes.

Constructor Summary

Constructors
Constructor and Description
`Chunk(GrowingChunk from)`
`Chunk(long chunkSeq, RecordMap records)`
`Chunk(long chunkSeq, RecordMap records, int liveRecordCount, long garbage)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`base()`
`void`	`dispose()`
`String`	`fnameSuffix()`
`boolean`	`needsDismissing()`
`void`	`needsDismissing(boolean needsDismissing)` Sets whether the "dismiss prefix garbage" operation is needed for this chunk.
`void`	`retire(KeyHandle kh, Record r)`
`void`	`retire(KeyHandle kh, Record r, boolean mayIncrementGarbageCount)` Retires a record in this chunk (makes it dead).
`abstract long`	`size()`
`static int`	`tombChunkSizeLimit()` Fetches the configured size limit in bytes for the tombstone chunk from the system property "hazelcast.hotrestart.tomb.chunk.size.limit".
`String`	`toString()`
`static int`	`valChunkSizeLimit()` Fetches the configured size limit in bytes for the value chunk from the system property "hazelcast.hotrestart.val.chunk.size.limit".

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

- Field Detail
  - SYSPROP_VAL_CHUNK_SIZE_LIMIT
```
public static final String SYSPROP_VAL_CHUNK_SIZE_LIMIT
```
    System property that specifies the limit on the value chunk file size
    
    See Also:
    
    Constant Field Values
  - SYSPROP_TOMB_CHUNK_SIZE_LIMIT
```
public static final String SYSPROP_TOMB_CHUNK_SIZE_LIMIT
```
    System property that specifies the limit on the tombstone chunk file size
    
    See Also:
    
    Constant Field Values
  - VAL_SIZE_LIMIT_DEFAULT
```
public static final int VAL_SIZE_LIMIT_DEFAULT
```
    Default value chunk file size limit in bytes.
    
    See Also:
    
    Constant Field Values
  - TOMB_SIZE_LIMIT_DEFAULT
```
public static final int TOMB_SIZE_LIMIT_DEFAULT
```
    Default tombstone chunk file size limit in bytes.
    
    See Also:
    
    Constant Field Values
  - FNAME_SUFFIX
```
public static final String FNAME_SUFFIX
```
    Chunk filename suffix.
    
    See Also:
    
    Constant Field Values
  - ACTIVE_FNAME_SUFFIX
```
public static final String ACTIVE_FNAME_SUFFIX
```
    Suffix added to the chunk file while it is active. On restart this file is the only one whose last entry may be incomplete. If the system failed while it was being written out, the caller did not receive a successful response, therefore that entry doesn't actually exist.
    
    See Also:
    
    Constant Field Values
  - SURVIVOR_FNAME_SUFFIX
```
public static final String SURVIVOR_FNAME_SUFFIX
```
    Suffix added to a chunk file while it is being written to during a GC cycle. If system fails during GC, such file should not be considered during restart.
    
    See Also:
    
    Constant Field Values
  - VAL_BASEDIR
```
public static final String VAL_BASEDIR
```
    Name of the base directory for value records.
    
    See Also:
    
    Constant Field Values
  - TOMB_BASEDIR
```
public static final String TOMB_BASEDIR
```
    Name of the base directory for tombstone records.
    
    See Also:
    
    Constant Field Values
  - seq
```
public final long seq
```
    Unique sequence number of this chunk.
  - records
```
public final RecordMap records
```
  - garbage
```
public long garbage
```
    The amount of garbage in this chunk in bytes. It is incremented when the record is retired or in the Rebuilder if we encounter a stale record (encounter a record interred by a prefix tombstone or a record which has a lower seq than the one we already encountered). The value is used while calculating the benefit of GC-ing the chunk.
  - liveRecordCount
```
public int liveRecordCount
```
- Constructor Detail
  - Chunk
```
public Chunk(long chunkSeq,
             RecordMap records)
```
  - Chunk
```
public Chunk(GrowingChunk from)
```
  - Chunk
```
public Chunk(long chunkSeq,
             RecordMap records,
             int liveRecordCount,
             long garbage)
```
- Method Detail
  - needsDismissing
```
public final boolean needsDismissing()
```
    Returns:
    
    whether the "dismiss prefix garbage" operation is pending for this chunk.
  - needsDismissing
```
public void needsDismissing(boolean needsDismissing)
```
    Sets whether the "dismiss prefix garbage" operation is needed for this chunk.
  - size
```
public abstract long size()
```
    Returns:
    
    size in bytes of the chunk file
  - retire
```
public void retire(KeyHandle kh,
                   Record r,
                   boolean mayIncrementGarbageCount)
```
    Retires a record in this chunk (makes it dead).
    
    Parameters:
    
    kh - key handle of the record
    
    r - the record to retire
    
    mayIncrementGarbageCount - whether it is appropriate to increment the garbage count for this key handle
  - retire
```
public void retire(KeyHandle kh,
                   Record r)
```
  - fnameSuffix
```
public String fnameSuffix()
```
    Returns:
    
    the filename suffix for this chunk
  - base
```
public String base()
```
    Returns:
    
    name of the base directory of this chunk (within the owning Hot Restart store's home dir)
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface com.hazelcast.nio.Disposable
  - valChunkSizeLimit
```
public static int valChunkSizeLimit()
```
    Fetches the configured size limit in bytes for the value chunk from the system property "hazelcast.hotrestart.val.chunk.size.limit".
  - tombChunkSizeLimit
```
public static int tombChunkSizeLimit()
```
    Fetches the configured size limit in bytes for the tombstone chunk from the system property "hazelcast.hotrestart.tomb.chunk.size.limit".
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Chunk

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYSPROP_VAL_CHUNK_SIZE_LIMIT

SYSPROP_TOMB_CHUNK_SIZE_LIMIT

VAL_SIZE_LIMIT_DEFAULT

TOMB_SIZE_LIMIT_DEFAULT

FNAME_SUFFIX

ACTIVE_FNAME_SUFFIX

SURVIVOR_FNAME_SUFFIX

VAL_BASEDIR

TOMB_BASEDIR

seq

records

garbage

liveRecordCount

Constructor Detail

Chunk

Chunk

Chunk

Method Detail

needsDismissing

needsDismissing

size

retire

retire

fnameSuffix

base

dispose

valChunkSizeLimit

tombChunkSizeLimit

toString