StreamLog (corfu 0.2.3-11006 API)

All Known Subinterfaces:

StreamLogWithRankedAddressSpace

All Known Implementing Classes:

InMemoryStreamLog, StreamLogFiles
```
public interface StreamLog
```
An interface definition that specifies an api to interact with a StreamLog.
Created by maithem on 7/15/16.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`append(List<LogData> entries)` Append a range of consecutive entries ordered by their addresses.
`void`	`append(long address, LogData entry)` Append an entry to the stream log.
`void`	`close()` Close the stream log.
`void`	`compact()` Remove all trimmed addresses from the StreamLog.
`TailsResponse`	`getAllTails()` Get global and all stream tails.
`long`	`getLogTail()` Get the global log tail.
`default OverwriteCause`	`getOverwriteCauseForAddress(long address, LogData entry)` Get overwrite cause for a given address.
`StreamsAddressResponse`	`getStreamsAddressSpace()` Get the address space for every stream.
`TailsResponse`	`getTails(List<UUID> streams)` Get the global tail and stream tails.
`long`	`getTrimMark()` Get the first untrimmed address in the address space.
`void`	`prefixTrim(long address)` Prefix trim the global log.
`LogData`	`read(long address)` Given an address, read the corresponding stream entry.
`void`	`reset()` Clears all data and resets all segment handlers.
`void`	`sync(boolean force)` Sync the stream log file to secondary storage.

- Method Detail
  - append
```
void append(long address,
            LogData entry)
```
    Append an entry to the stream log.
    
    Parameters:
    
    address - address of append entry
    
    entry - entry to append to the log
  - append
```
void append(List<LogData> entries)
```
    Append a range of consecutive entries ordered by their addresses. Entries that are trimmed, or overwrites other addresses are ignored (i.e. they are not written) and an OverwriteException is not thrown.
    
    Parameters:
    
    entries -
  - read
```
LogData read(long address)
```
    Given an address, read the corresponding stream entry.
    
    Parameters:
    
    address - address to read from the log
    
    Returns:
    
    Stream entry if it exists, otherwise return null
  - prefixTrim
```
void prefixTrim(long address)
```
    Prefix trim the global log.
    
    Parameters:
    
    address - address to trim the log up to
  - compact
```
void compact()
```
    Remove all trimmed addresses from the StreamLog.
  - getTails
```
TailsResponse getTails(List<UUID> streams)
```
    Get the global tail and stream tails.
  - getLogTail
```
long getLogTail()
```
    Get the global log tail.
  - getAllTails
```
TailsResponse getAllTails()
```
    Get global and all stream tails.
  - getStreamsAddressSpace
```
StreamsAddressResponse getStreamsAddressSpace()
```
    Get the address space for every stream.
  - getTrimMark
```
long getTrimMark()
```
    Get the first untrimmed address in the address space.
  - sync
```
void sync(boolean force)
   throws IOException
```
    Sync the stream log file to secondary storage.
    
    Parameters:
    
    force - force data to secondary storage if true
    
    Throws:
    
    IOException
  - close
```
void close()
```
    Close the stream log.
  - reset
```
void reset()
```
    Clears all data and resets all segment handlers.
  - getOverwriteCauseForAddress
```
default OverwriteCause getOverwriteCauseForAddress(long address,
                                                   LogData entry)
```
    Get overwrite cause for a given address.
    
    Parameters:
    
    address - global log address
    
    entry - entry which would cause the overwrite
    
    Returns:
    
    (OverwriteCause) Cause of the overwrite

Interface StreamLog

Method Summary

Method Detail

append

append

read

prefixTrim

compact

getTails

getLogTail

getAllTails

getStreamsAddressSpace

getTrimMark

sync

close

reset

getOverwriteCauseForAddress