Show / Hide Table of Contents

Interface IDeviceFactory

Abstraction for enumerating and constructing IDeviceFactorys

Namespace: Device.Net
Assembly: Device.Net.dll
Syntax
public interface IDeviceFactory

Methods

GetConnectedDeviceDefinitionsAsync(CancellationToken)

Gets the definition of connected devices

Declaration
Task<IEnumerable<ConnectedDeviceDefinition>> GetConnectedDeviceDefinitionsAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<ConnectedDeviceDefinition>>

GetDeviceAsync(ConnectedDeviceDefinition, CancellationToken)

Given a ConnectedDeviceDefinition returns a IDevice

Declaration
Task<IDevice> GetDeviceAsync(ConnectedDeviceDefinition connectedDeviceDefinition, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
ConnectedDeviceDefinition connectedDeviceDefinition
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<IDevice>

SupportsDeviceAsync(ConnectedDeviceDefinition, CancellationToken)

Whether or not the factory supports the given device definition

Declaration
Task<bool> SupportsDeviceAsync(ConnectedDeviceDefinition connectedDeviceDefinition, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
ConnectedDeviceDefinition connectedDeviceDefinition
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Extension Methods

DeviceExtensions.Aggregate(IDeviceFactory, IDeviceFactory, ILoggerFactory)
DeviceExtensions.GetFirstDeviceAsync(IDeviceFactory)
DeviceExtensions.ConnectFirstAsync(IDeviceFactory, ILogger)
In This Article
Back to top Generated by DocFX