Interface IStateReader

Provides capabilities to read an engine's state from a store.

Namespace: Reaqtor.QueryEngine

Assembly: Reaqtor.QueryEngine.Interfaces.dll

Syntax

public interface IStateReader : IDisposable

Methods

GetCategories()

Gets the list of categories which are part of the state of the engine that was saved in the store.

Declaration

IEnumerable<string> GetCategories()

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>	The list of categories.

TryGetItemKeys(String, out IEnumerable<String>)

Gets the list of item keys belonging to the provided category.

Declaration

bool TryGetItemKeys(string category, out IEnumerable<string> keys)

Parameters

Type	Name	Description
System.String	category	Category to retrieve keys for.
System.Collections.Generic.IEnumerable<System.String>	keys	Retrieved keys for the specified category.

Returns

Type	Description
System.Boolean	true if the category exists; otherwise, false.

TryGetItemReader(String, String, out Stream)

Gets a stream to read the state of the item specified by the provided category and key.

Declaration

bool TryGetItemReader(string category, string key, out Stream stream)

Parameters

Type	Name	Description
System.String	category	Category of the item to read state for.
System.String	key	Key of the item to read state for.
System.IO.Stream	stream	Stream to read that state of the item from.

Returns

Type	Description
System.Boolean	true if the category and item key exists; otherwise, false.