Skip to content

Commit

Permalink
Fixing deceptive description of InitialOffsetProvider (#224)
Browse files Browse the repository at this point in the history
  • Loading branch information
serkantkaraca committed Feb 14, 2018
1 parent 6bb3612 commit 5c525d7
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,10 @@ public bool EnableReceiverRuntimeMetric
public int PrefetchCount { get; set; }

/// <summary>
/// Get or sets the current function used to determine the initial offset at which to start receiving
/// events for a partition.
/// <para>A null return indicates that it is using the internal provider, which uses the last checkpointed
/// offset value (if present) or StartOfSTream (if not).</para>
/// Gets or sets a delegate which is used to get the initial offset for a given partition to create <see cref="PartitionReceiver"/>.
/// Delegate is invoked by passing in PartitionId and then user can return either the starting offset as string or starting UTC time
/// for receiving messages.
/// This is only used when <see cref="Lease.Offset"/> is not provided and receiver is being created for the very first time.
/// </summary>
public Func<string, object> InitialOffsetProvider { get; set; }

Expand Down

0 comments on commit 5c525d7

Please sign in to comment.