/// <summary>
/// Initializes a new instance of the <see cref="PartitionReceiver"/> class.
/// </summary>
///
/// <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param>
/// <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param>
/// <param name="eventPosition">The position within the partition where the client should begin reading events.</param>
/// <param name="fullyQualifiedNamespace">The fully qualified Event Hubs namespace to connect to. This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>.</param>
/// <param name="eventHubName">The name of the specific Event Hub to associate the client with.</param>
/// <param name="credential">The Azure managed identity credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.</param>
/// <param name="options">A set of options to apply when configuring the client.</param>
///
public PartitionReceiver(string consumerGroup,
string partitionId,
EventPosition eventPosition,
string fullyQualifiedNamespace,
string eventHubName,
TokenCredential credential,
PartitionReceiverOptions options = default)
{
Argument.AssertNotNullOrEmpty(consumerGroup, nameof(consumerGroup));
Argument.AssertNotNullOrEmpty(partitionId, nameof(partitionId));
Argument.AssertWellFormedEventHubsNamespace(fullyQualifiedNamespace, nameof(fullyQualifiedNamespace));
Argument.AssertNotNullOrEmpty(eventHubName, nameof(eventHubName));
Argument.AssertNotNull(credential, nameof(credential));
options = options?.Clone() ?? new PartitionReceiverOptions();
Connection = new EventHubConnection(fullyQualifiedNamespace, eventHubName, credential, options.ConnectionOptions);
ConsumerGroup = consumerGroup;
PartitionId = partitionId;
InitialPosition = eventPosition;
DefaultMaximumWaitTime = options.DefaultMaximumReceiveWaitTime;
RetryPolicy = options.RetryOptions.ToRetryPolicy();
#pragma warning disable CA2214 // Do not call overridable methods in constructors. This internal method is virtual for testing purposes.
InnerConsumer = CreateTransportConsumer(consumerGroup, partitionId, eventPosition, RetryPolicy, options);
#pragma warning restore CA2214 // Do not call overridable methods in constructors.
}
/// <summary>
/// Initializes a new instance of the <see cref="PartitionReceiver"/> class.
/// </summary>
///
/// <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param>
/// <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param>
/// <param name="eventPosition">The position within the partition where the client should begin reading events.</param>
/// <param name="connectionString">The connection string to use for connecting to the Event Hubs namespace; it is expected that the Event Hub name and the shared key properties are contained in this connection string.</param>
/// <param name="options">A set of options to apply when configuring the client.</param>
///
/// <remarks>
/// If the connection string is copied from the Event Hubs namespace, it will likely not contain the name of the desired Event Hub,
/// which is needed. In this case, the name can be added manually by adding ";EntityPath=[[ EVENT HUB NAME ]]" to the end of the
/// connection string. For example, ";EntityPath=telemetry-hub".
///
/// If you have defined a shared access policy directly on the Event Hub itself, then copying the connection string from that
/// Event Hub will result in a connection string that contains the name.
/// </remarks>
///
/// <seealso href="https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string"/>
///
public PartitionReceiver(string consumerGroup,
string partitionId,
EventPosition eventPosition,
string connectionString,
PartitionReceiverOptions options = default) : this(consumerGroup, partitionId, eventPosition, connectionString, null, options)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="PartitionReceiver"/> class.
/// </summary>
///
/// <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param>
/// <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param>
/// <param name="eventPosition">The position within the partition where the client should begin reading events.</param>
/// <param name="connection">The <see cref="EventHubConnection" /> connection to use for communication with the Event Hubs service.</param>
/// <param name="options">A set of options to apply when configuring the client.</param>
///
public PartitionReceiver(string consumerGroup,
string partitionId,
EventPosition eventPosition,
EventHubConnection connection,
PartitionReceiverOptions options = default)
{
Argument.AssertNotNullOrEmpty(consumerGroup, nameof(consumerGroup));
Argument.AssertNotNullOrEmpty(partitionId, nameof(partitionId));
Argument.AssertNotNull(connection, nameof(connection));
options = options?.Clone() ?? new PartitionReceiverOptions();
OwnsConnection = false;
Connection = connection;
ConsumerGroup = consumerGroup;
PartitionId = partitionId;
InitialPosition = eventPosition;
RetryPolicy = options.RetryOptions.ToRetryPolicy();
InnerConsumer = CreateTransportConsumer(consumerGroup, partitionId, eventPosition, RetryPolicy, options);
}
/// <summary>
/// Initializes a new instance of the <see cref="PartitionReceiver"/> class.
/// </summary>
///
/// <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param>
/// <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param>
/// <param name="eventPosition">The position within the partition where the client should begin reading events.</param>
/// <param name="connectionString">The connection string to use for connecting to the Event Hubs namespace; it is expected that the shared key properties are contained in this connection string, but not the Event Hub name.</param>
/// <param name="eventHubName">The name of the specific Event Hub to associate the client with.</param>
/// <param name="options">A set of options to apply when configuring the client.</param>
///
/// <remarks>
/// If the connection string is copied from the Event Hub itself, it will contain the name of the desired Event Hub,
/// and can be used directly without passing the <paramref name="eventHubName" />. The name of the Event Hub should be
/// passed only once, either as part of the connection string or separately.
/// </remarks>
///
/// <seealso href="https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-get-connection-string"/>
///
public PartitionReceiver(string consumerGroup,
string partitionId,
EventPosition eventPosition,
string connectionString,
string eventHubName,
PartitionReceiverOptions options = default)
{
Argument.AssertNotNullOrEmpty(consumerGroup, nameof(consumerGroup));
Argument.AssertNotNullOrEmpty(partitionId, nameof(partitionId));
Argument.AssertNotNullOrEmpty(connectionString, nameof(connectionString));
options = options?.Clone() ?? new PartitionReceiverOptions();
Connection = new EventHubConnection(connectionString, eventHubName, options.ConnectionOptions);
ConsumerGroup = consumerGroup;
PartitionId = partitionId;
InitialPosition = eventPosition;
DefaultMaximumWaitTime = options.DefaultMaximumReceiveWaitTime;
RetryPolicy = options.RetryOptions.ToRetryPolicy();
InnerConsumer = CreateTransportConsumer(consumerGroup, partitionId, eventPosition, RetryPolicy, options);
}
/// <summary>
/// Initializes a new instance of the <see cref="PartitionReceiver"/> class.
/// </summary>
///
/// <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param>
/// <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param>
/// <param name="eventPosition">The position within the partition where the client should begin reading events.</param>
/// <param name="fullyQualifiedNamespace">The fully qualified Event Hubs namespace to connect to. This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>.</param>
/// <param name="eventHubName">The name of the specific Event Hub to associate the client with.</param>
/// <param name="credential">The Azure managed identity credential to use for authorization. Access controls may be specified by the Event Hubs namespace or the requested Event Hub, depending on Azure configuration.</param>
/// <param name="options">A set of options to apply when configuring the client.</param>
///
public PartitionReceiver(string consumerGroup,
string partitionId,
EventPosition eventPosition,
string fullyQualifiedNamespace,
string eventHubName,
TokenCredential credential,
PartitionReceiverOptions options = default)
{
Argument.AssertNotNullOrEmpty(consumerGroup, nameof(consumerGroup));
Argument.AssertNotNullOrEmpty(partitionId, nameof(partitionId));
Argument.AssertWellFormedEventHubsNamespace(fullyQualifiedNamespace, nameof(fullyQualifiedNamespace));
Argument.AssertNotNullOrEmpty(eventHubName, nameof(eventHubName));
Argument.AssertNotNull(credential, nameof(credential));
options = options?.Clone() ?? new PartitionReceiverOptions();
Connection = new EventHubConnection(fullyQualifiedNamespace, eventHubName, credential, options.ConnectionOptions);
ConsumerGroup = consumerGroup;
PartitionId = partitionId;
InitialPosition = eventPosition;
RetryPolicy = options.RetryOptions.ToRetryPolicy();
InnerConsumer = CreateTransportConsumer(consumerGroup, partitionId, eventPosition, RetryPolicy, options);
}
/// <summary>
/// Initializes a new instance of the <see cref="PartitionReceiver"/> class.
/// </summary>
///
/// <param name="consumerGroup">The name of the consumer group this client is associated with. Events are read in the context of this group.</param>
/// <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param>
/// <param name="eventPosition">The position within the partition where the client should begin reading events.</param>
/// <param name="connection">The <see cref="EventHubConnection" /> connection to use for communication with the Event Hubs service.</param>
/// <param name="options">A set of options to apply when configuring the client.</param>
///
public PartitionReceiver(string consumerGroup,
string partitionId,
EventPosition eventPosition,
EventHubConnection connection,
PartitionReceiverOptions options = default)
{
Argument.AssertNotNullOrEmpty(consumerGroup, nameof(consumerGroup));
Argument.AssertNotNullOrEmpty(partitionId, nameof(partitionId));
Argument.AssertNotNull(connection, nameof(connection));
options = options?.Clone() ?? new PartitionReceiverOptions();
OwnsConnection = false;
Connection = connection;
ConsumerGroup = consumerGroup;
PartitionId = partitionId;
InitialPosition = eventPosition;
DefaultMaximumWaitTime = options.DefaultMaximumReceiveWaitTime;
RetryPolicy = options.RetryOptions.ToRetryPolicy();
#pragma warning disable CA2214 // Do not call overridable methods in constructors. This internal method is virtual for testing purposes.
InnerConsumer = CreateTransportConsumer(consumerGroup, partitionId, eventPosition, RetryPolicy, options);
#pragma warning restore CA2214 // Do not call overridable methods in constructors.
}
/// <summary>
/// Creates an <see cref="TransportConsumer" /> to use for reading events.
/// </summary>
///
/// <param name="consumerGroup">The name of the consumer group the consumer will be associated with. Events will be read in the context of this group.</param>
/// <param name="partitionId">The identifier of the Event Hub partition from which events will be received.</param>
/// <param name="eventPosition">The position within the partition where the consumer should begin reading events.</param>
/// <param name="retryPolicy">The policy which governs retry behavior and try timeouts.</param>
/// <param name="options">A set of options to apply when configuring the consumer.</param>
///
/// <returns>A <see cref="TransportConsumer" /> configured in the requested manner.</returns>
///
internal virtual TransportConsumer CreateTransportConsumer(string consumerGroup,
string partitionId,
EventPosition eventPosition,
EventHubsRetryPolicy retryPolicy,
PartitionReceiverOptions options) =>
Connection.CreateTransportConsumer(consumerGroup, partitionId, eventPosition, retryPolicy, options.TrackLastEnqueuedEventProperties, options.OwnerLevel, (uint?)options.PrefetchCount);
