com.neeve.ods

Interface IStoreReader

All Known Subinterfaces:

IStorePersister

All Known Implementing Classes:

RogLog

public interface IStoreReader

Represents a store reader.

This interface defines a store reader. Store readers read store objects and/or transactions from an abstract source.

Threading:

A reader is not safe for concurrent access by multiple threads.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IStoreReader.IterativeReader Iterative reader (returned by #iterativeReader())
static interface	IStoreReader.ReadCallback Callback interface used by a reader to dispatch store objects or transaction entries to the user.

Method Summary

Modifier and Type	Method and Description
IStoreReader.IterativeReader	iterativeReader(int flags) Get an iterative reader This method returns a reader that can be used to iteratively read the contents of a persisted store.
boolean	read(IStoreReader.ReadCallback callback) Read the contents of the persisted store.
boolean	read(IStoreReader.ReadCallback callback, int flags) Read the contents of the persisted store.
void	readMetadata(PktBuffer buffer) Read serialized form of a store's metadata into a provided buffer

Method Detail

readMetadata

void readMetadata(PktBuffer buffer)

Read serialized form of a store's metadata into a provided buffer

Parameters:

buffer - The buffer to read the (serialized form of) metadata into

iterativeReader

IStoreReader.IterativeReader iterativeReader(int flags)
                                      throws Exception

Get an iterative reader

This method returns a reader that can be used to iteratively read the contents of a persisted store.

Parameters:

flags - Flags that qualify read operations.

Throws:

Exception

read

boolean read(IStoreReader.ReadCallback callback)
      throws Exception

Read the contents of the persisted store.

This method is equivalent to calling read(callback, 0)

Parameters:

callback - The callback used to return the read entries to the caller.

Returns:

Returns true if the full log has been read and false if the read was suspended by the callback

Throws:

Exception

Threading:

This method can be called concurrently with record and sync operations i.e. a reader is required to support concurrent reads and writes.

read

boolean read(IStoreReader.ReadCallback callback,
             int flags)
      throws Exception

Read the contents of the persisted store.

Parameters:

callback - The callback used to return the read entries to the caller.

flags - Flags that qualify read operations.

Returns:

Returns true if the full log has been read and false if the read was suspended by the callback

Throws:

Exception

Threading:

This method can be called concurrently with record and sync operations i.e. a reader is required to support concurrent reads and writes.