< Summary

Class:Azure.Messaging.EventHubs.Consumer.EventHubConsumerClientOptions
Assembly:Azure.Messaging.EventHubs
File(s):C:\Git\azure-sdk-for-net\sdk\eventhub\Azure.Messaging.EventHubs\src\Consumer\EventHubConsumerClientOptions.cs
Covered lines:15
Uncovered lines:3
Coverable lines:18
Total lines:95
Line coverage:83.3% (15 of 18)
Covered branches:0
Total branches:0

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor()-100%100%
get_ConnectionOptions()-100%100%
set_ConnectionOptions(...)-100%100%
get_RetryOptions()-100%100%
set_RetryOptions(...)-100%100%
Equals(...)-0%100%
GetHashCode()-0%100%
ToString()-0%100%
Clone()-100%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\eventhub\Azure.Messaging.EventHubs\src\Consumer\EventHubConsumerClientOptions.cs

#LineLine coverage
 1// Copyright (c) Microsoft Corporation. All rights reserved.
 2// Licensed under the MIT License.
 3
 4using System.ComponentModel;
 5using Azure.Core;
 6using Azure.Messaging.EventHubs.Core;
 7
 8namespace Azure.Messaging.EventHubs.Consumer
 9{
 10    /// <summary>
 11    ///   The set of options that can be specified when creating an <see cref="EventHubConsumerClient" />
 12    ///   to configure its behavior.
 13    /// </summary>
 14    ///
 15    public class EventHubConsumerClientOptions
 16    {
 17        /// <summary>The set of options to use for configuring the connection to the Event Hubs service.</summary>
 20818        private EventHubConnectionOptions _connectionOptions = new EventHubConnectionOptions();
 19
 20        /// <summary>The set of options to govern retry behavior and try timeouts.</summary>
 20821        private EventHubsRetryOptions _retryOptions = new EventHubsRetryOptions();
 22
 23        /// <summary>
 24        ///   The options used for configuring the connection to the Event Hubs service.
 25        /// </summary>
 26        ///
 27        public EventHubConnectionOptions ConnectionOptions
 28        {
 6029            get => _connectionOptions;
 30            set
 31            {
 432                Argument.AssertNotNull(value, nameof(ConnectionOptions));
 233                _connectionOptions = value;
 234            }
 35        }
 36
 37        /// <summary>
 38        ///   The set of options to use for determining whether a failed operation should be retried and,
 39        ///   if so, the amount of time to wait between retry attempts.  These options also control the
 40        ///   amount of time allowed for reading events and other interactions with the Event Hubs service.
 41        /// </summary>
 42        ///
 43        public EventHubsRetryOptions RetryOptions
 44        {
 17845            get => _retryOptions;
 46            set
 47            {
 2848                Argument.AssertNotNull(value, nameof(RetryOptions));
 2649                _retryOptions = value;
 2650            }
 51        }
 52
 53        /// <summary>
 54        ///   Determines whether the specified <see cref="System.Object" /> is equal to this instance.
 55        /// </summary>
 56        ///
 57        /// <param name="obj">The <see cref="System.Object" /> to compare with this instance.</param>
 58        ///
 59        /// <returns><c>true</c> if the specified <see cref="System.Object" /> is equal to this instance; otherwise, <c>
 60        ///
 61        [EditorBrowsable(EditorBrowsableState.Never)]
 062        public override bool Equals(object obj) => base.Equals(obj);
 63
 64        /// <summary>
 65        ///   Returns a hash code for this instance.
 66        /// </summary>
 67        ///
 68        /// <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a ha
 69        ///
 70        [EditorBrowsable(EditorBrowsableState.Never)]
 071        public override int GetHashCode() => base.GetHashCode();
 72
 73        /// <summary>
 74        ///   Converts the instance to string representation.
 75        /// </summary>
 76        ///
 77        /// <returns>A <see cref="System.String" /> that represents this instance.</returns>
 78        ///
 79        [EditorBrowsable(EditorBrowsableState.Never)]
 080        public override string ToString() => base.ToString();
 81
 82        /// <summary>
 83        ///   Creates a new copy of the current <see cref="EventHubConsumerClientOptions" />, cloning its attributes int
 84        /// </summary>
 85        ///
 86        /// <returns>A new copy of <see cref="EventHubConsumerClientOptions" />.</returns>
 87        ///
 88        internal EventHubConsumerClientOptions Clone() =>
 2289            new EventHubConsumerClientOptions
 2290            {
 2291                _connectionOptions = ConnectionOptions.Clone(),
 2292                _retryOptions = RetryOptions.Clone()
 2293            };
 94    }
 95}