Skip to content

Commit

Permalink
Merge pull request #7 from Borisov-Sergey/documentation-improvement
Browse files Browse the repository at this point in the history
Passive event storage abstraction documentation should clearly defineexpectations on the way data is loaded.
  • Loading branch information
dennisdoomen authored Jan 30, 2018
2 parents 68b0f43 + 72af893 commit 4df239b
Showing 1 changed file with 13 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,18 @@ public void Dispose()
/// </summary>
public interface IPassiveEventStore
{
IEnumerable<Transaction> GetFrom(long? checkpoint);
/// <summary>
/// Loads <see cref="Transaction"/>s from the storage in the order that they should be projected (should be the same order that they were persisted).
/// </summary>
/// <remarks>
/// The implementation is allowed to return just a limited subset of items at a time.
/// It is up to the implementation to decide how many items should be returned at a time.
/// The only requirement is that the implementation should return at least one <see cref="Transaction"/>,
/// if there are any transactions having checkpoint (<see cref="Transaction.Checkpoint"/>) bigger than given one.
/// </remarks>
/// <param name="previousCheckpoint">
/// Determines the value of the <see cref="Transaction.Checkpoint"/>, next to which <see cref="Transaction"/>s should be loaded from the storage.
/// </param>
IEnumerable<Transaction> GetFrom(long? previousCheckpoint);
}
}

0 comments on commit 4df239b

Please sign in to comment.