FsLogSegment (Zeebe Logstreams 0.12.1 API)

java.lang.Object
- io.zeebe.logstreams.impl.log.fs.FsLogSegment

Direct Known Subclasses:

FsReadableLogSegment
```
public class FsLogSegment
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`END_OF_SEGMENT`
`protected FileChannel`	`fileChannel`
`protected String`	`fileName`
`static short`	`INSUFFICIENT_CAPACITY`
`static short`	`INVALID_ADDR`
`static org.slf4j.Logger`	`LOG`
`protected MappedByteBuffer`	`mappedBuffer`
`protected org.agrona.concurrent.UnsafeBuffer`	`metadataSection`
`static short`	`NO_DATA`
`protected Rater`	`rater`
`protected short`	`state`
`static short`	`STATE_ACTIVE`
`static short`	`STATE_FILLED`

Constructor Summary

Constructors
Constructor and Description

FsLogSegment(String fileName)

Constructors
Constructor and Description
`FsLogSegment(String fileName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`allocate(int segmentId, int segmentSize)`
`int`	`append(ByteBuffer block)`
`void`	`closeSegment()`
`void`	`delete()`
`void`	`flush()`
`int`	`getCapacity()`
`String`	`getFileName()`
`int`	`getSegmentId()`
`int`	`getSize()`
`int`	`getSizeVolatile()`
`boolean`	`isActive()`
`boolean`	`isConsistent()`
`boolean`	`isFilled()`
`boolean`	`openSegment(boolean create)`
`int`	`readBytes(ByteBuffer readBuffer, int fileOffset)` Reads a sequence of bytes into the provided read buffer.
`protected void`	`setCapacity(int capacity)`
`void`	`setFilled()`
`protected void`	`setSegmentId(int segmentId)`
`protected void`	`setSizeOrdered(int tail)`
`protected void`	`setSizeVolatile(int tail)`
`void`	`truncateUncommittedData()`

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

INVALID_ADDR
```
public static final short INVALID_ADDR
```
See Also:

Constant Field Values

NO_DATA
```
public static final short NO_DATA
```
See Also:

Constant Field Values

END_OF_SEGMENT
```
public static final short END_OF_SEGMENT
```
See Also:

Constant Field Values

INSUFFICIENT_CAPACITY
```
public static final short INSUFFICIENT_CAPACITY
```
See Also:

Constant Field Values

STATE_ACTIVE
```
public static final short STATE_ACTIVE
```
See Also:

Constant Field Values

STATE_FILLED
```
public static final short STATE_FILLED
```
See Also:

Constant Field Values

state
```
protected volatile short state
```

fileName
```
protected final String fileName
```

fileChannel
```
protected FileChannel fileChannel
```

metadataSection

protected org.agrona.concurrent.UnsafeBuffer metadataSection

mappedBuffer

protected MappedByteBuffer mappedBuffer

rater
```
protected final Rater rater
```

Constructor Detail
- FsLogSegment
```
public FsLogSegment(String fileName)
```

Method Detail

openSegment

public boolean openSegment(boolean create)

closeSegment
```
public void closeSegment()
```

delete
```
public void delete()
```

getFileName
```
public String getFileName()
```

getSegmentId
```
public int getSegmentId()
```

setSegmentId

protected void setSegmentId(int segmentId)

getSize
```
public int getSize()
```

getSizeVolatile
```
public int getSizeVolatile()
```

setSizeOrdered

protected void setSizeOrdered(int tail)

setSizeVolatile

protected void setSizeVolatile(int tail)

getCapacity
```
public int getCapacity()
```

setCapacity

protected void setCapacity(int capacity)

isFilled
```
public boolean isFilled()
```

isActive
```
public boolean isActive()
```

allocate

public boolean allocate(int segmentId,
                        int segmentSize)

append
```
public int append(ByteBuffer block)
```
Parameters:

block -

Returns:

the offset at which the block was appended

flush

public void flush()
           throws IOException

Throws:: IOException

readBytes
```
public int readBytes(ByteBuffer readBuffer,
                     int fileOffset)
```
Reads a sequence of bytes into the provided read buffer. Returns the result of the read operation which is either
- Number of bytes read in case of a successful read operation
- NO_DATA in case no data is available
- END_OF_SEGMENT in case the end of the segment is reached
Parameters:

readBuffer - the buffer to read data into

fileOffset - the offset in the file to read from

Returns:

operation result

setFilled
```
public void setFilled()
```

isConsistent

public boolean isConsistent()
                     throws IOException

Throws:: IOException

truncateUncommittedData

public void truncateUncommittedData()
                             throws IOException

Throws:: IOException

Class FsLogSegment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

INVALID_ADDR

NO_DATA

END_OF_SEGMENT

INSUFFICIENT_CAPACITY

STATE_ACTIVE

STATE_FILLED

state

fileName

fileChannel

metadataSection

mappedBuffer

rater

Constructor Detail

FsLogSegment

Method Detail

openSegment

closeSegment

delete

getFileName

getSegmentId

setSegmentId

getSize

getSizeVolatile

setSizeOrdered

setSizeVolatile

getCapacity

setCapacity

isFilled

isActive

allocate

append

flush

readBytes

setFilled

isConsistent

truncateUncommittedData