Interface IConfiguredDeviceEnumerator

Namespace

Acuit.Pinpoint.IO

Assembly

Acuit.Pinpoint.IO.Abstractions.dll

An enumerator for configured devices.

public interface IConfiguredDeviceEnumerator

Remarks

These standard configured devices enumerator implementations are provided:

• CollectionConfiguredDeviceEnumerator - A configured devices enumerator for a collection of devices configured via a configuration section.
• OptionalSingleConfiguredDeviceEnumerator - A configured devices enumerator for an optional single device configured via a configuration section.
• SingletonConfiguredDeviceEnumerator - A configured devices enumerator for a single device, optionally configured via a configuration section.

Methods

EnumerateConfiguredDevices(Type, IConfigurationSection?)

Enumerates configured devices.

IEnumerable<ConfiguredDeviceDefinition> EnumerateConfiguredDevices(Type baseDeviceType, IConfigurationSection? configurationSection)

Parameters

baseDeviceType Type

The base Type for the registered device type.

configurationSection IConfigurationSection

The configuration section that contains the settings for the device type, which comes from ConfigurationSection in the device type registration options.

Returns

IEnumerable<ConfiguredDeviceDefinition>

An enumerable of ConfiguredDeviceDefinition objects representing the configured devices.

Exceptions

ArgumentNullException

baseDeviceType is null.

ArgumentNullException

configurationSection is null, but this implementation requires a configuration section to operate.