io.zeebe.logstreams.spi

Interface SnapshotSupport

All Known Subinterfaces:

ComposableSnapshotSupport

All Known Implementing Classes:

BaseValueSnapshotSupport, ComposedSnapshot, LogBlockIndex, SerializableWrapper, UnpackedObjectSnapshotSupport, ZbMapSnapshotSupport

public interface SnapshotSupport

Interface to be implemented by resources which are used by stream processors and support snapshots.

Method Summary

Modifier and Type	Method and Description
void	recoverFromSnapshot(InputStream inputStream) read a snapshot from the provided input stream.
void	reset() Set the snapshot in the initial state.
long	writeSnapshot(OutputStream outputStream) write a snapshot to the provided output stream

Method Detail

writeSnapshot

long writeSnapshot(OutputStream outputStream)
            throws Exception

write a snapshot to the provided output stream

Parameters:

outputStream - the stream to write to

Returns:

the size of the snapshot in bytes

Throws:

Exception

recoverFromSnapshot

void recoverFromSnapshot(InputStream inputStream)
                  throws Exception

read a snapshot from the provided input stream.

Parameters:

inputStream - the stream to read from

Throws:

Exception

reset

void reset()

Set the snapshot in the initial state.