/// <summary></summary> /// <param name="consumerGroupName"></param> /// <param name="partitionId"></param> /// <param name="eventPosition"></param> /// <param name="epoch"></param> /// <param name="receiverOptions"></param> /// <returns></returns> protected abstract PartitionReceiver OnCreateReceiver(string consumerGroupName, string partitionId, EventPosition eventPosition, long?epoch, ReceiverOptions receiverOptions);
/// <summary>
/// Create a Epoch based EventHub receiver with given <see cref="EventPosition"/>.
/// The receiver is created for a specific EventHub Partition from the specific consumer group.
/// <para/>It is important to pay attention to the following when creating epoch based receiver:
/// <para/>- Ownership enforcement: Once you created an epoch based receiver, you cannot create a non-epoch receiver to the same consumerGroup-Partition combo until all receivers to the combo are closed.
/// <para/>- Ownership stealing: If a receiver with higher epoch value is created for a consumerGroup-Partition combo, any older epoch receiver to that combo will be force closed.
/// <para/>- Any receiver closed due to lost of ownership to a consumerGroup-Partition combo will get ReceiverDisconnectedException for all operations from that receiver.
/// </summary>
/// <param name="consumerGroupName">the consumer group name that this receiver should be grouped under.</param>
/// <param name="partitionId">the partition Id that the receiver belongs to. All data received will be from this partition only.</param>
/// <param name="eventPosition">The starting <see cref="EventPosition"/> at which to start receiving messages.</param>
/// <param name="epoch">a unique identifier (epoch value) that the service uses, to enforce partition/lease ownership.</param>
/// <param name="receiverOptions">Options for a event hub receiver.</param>
/// <returns>The created PartitionReceiver</returns>
/// <seealso cref="PartitionReceiver"/>
public PartitionReceiver CreateEpochReceiver(string consumerGroupName, string partitionId, EventPosition eventPosition, long epoch, ReceiverOptions receiverOptions = null)
{
Guard.ArgumentNotNull(nameof(eventPosition), eventPosition);
return(this.OnCreateReceiver(consumerGroupName, partitionId, eventPosition, epoch, receiverOptions));
}
/// <summary>
/// Returns the position for the end of a stream. Provide this position in receiver creation
/// to start receiving from the next available event in the partition after the receiver is created.
/// </summary>
public static EventPosition FromEnd()
{
return(EventPosition.FromOffset(EndOfStream));
}
/// <summary>
/// Create a Epoch based EventHub receiver with given <see cref="EventPosition"/>.
/// The receiver is created for a specific EventHub Partition from the specific consumer group.
/// <para/>It is important to pay attention to the following when creating epoch based receiver:
/// <para/>- Ownership enforcement: Once you created an epoch based receiver, you cannot create a non-epoch receiver to the same consumerGroup-Partition combo until all receivers to the combo are closed.
/// <para/>- Ownership stealing: If a receiver with higher epoch value is created for a consumerGroup-Partition combo, any older epoch receiver to that combo will be force closed.
/// <para/>- Any receiver closed due to lost of ownership to a consumerGroup-Partition combo will get ReceiverDisconnectedException for all operations from that receiver.
/// </summary>
/// <param name="consumerGroupName">the consumer group name that this receiver should be grouped under.</param>
/// <param name="partitionId">the partition Id that the receiver belongs to. All data received will be from this partition only.</param>
/// <param name="eventPosition">The starting <see cref="EventPosition"/> at which to start receiving messages.</param>
/// <param name="epoch">a unique identifier (epoch value) that the service uses, to enforce partition/lease ownership.</param>
/// <param name="receiverOptions">Options for a event hub receiver.</param>
/// <returns>The created PartitionReceiver</returns>
/// <seealso cref="PartitionReceiver"/>
public PartitionReceiver CreateEpochReceiver(string consumerGroupName, string partitionId, EventPosition eventPosition, long epoch, ReceiverOptions receiverOptions = null)
{
if (eventPosition == null)
{
throw Fx.Exception.ArgumentNull(nameof(eventPosition));
}
return(this.OnCreateReceiver(consumerGroupName, partitionId, eventPosition, epoch, receiverOptions));
}
/// <summary>
/// Returns the position for the start of a stream. Provide this position in receiver creation
/// to starting receiving from the first available event in the partition.
/// </summary>
public static EventPosition FromStart()
{
return(EventPosition.FromOffset(StartOfStream));
}