Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update IDeviceIdentity interface to add doc comments. #2282

Merged
merged 4 commits into from
Jan 13, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
using System.Net;
using Microsoft.Azure.Devices.Client.Extensions;

namespace Microsoft.Azure.Devices.Client.Transport
namespace Microsoft.Azure.Devices.Client.Transport.Amqp
{
/// <summary>
/// Device configurations
Expand Down
46 changes: 46 additions & 0 deletions iothub/device/src/Transport/Amqp/IDeviceIdentity.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

namespace Microsoft.Azure.Devices.Client.Transport.Amqp
{
/// <summary>
/// Interface for device configurations and common attributes.
/// </summary>
internal interface IDeviceIdentity
{
/// <summary>
/// Authentication model for the device.
/// </summary>
AuthenticationModel AuthenticationModel { get; }

/// <summary>
/// AMQP transport layer settings of the device.
/// </summary>
AmqpTransportSettings AmqpTransportSettings { get; }

/// <summary>
/// Device connection string details.
/// </summary>
IotHubConnectionString IotHubConnectionString { get; }

/// <summary>
/// Device details and information.
azabbasi marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
ProductInfo ProductInfo { get; }

/// <summary>
/// Device configuration options at the time of initialization.
/// </summary>
ClientOptions Options { get; }

/// <summary>
/// Device authentication audience.
/// </summary>
string Audience { get; }

/// <summary>
/// Whether or not Device is part of a connection pooling.
azabbasi marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
bool IsPooling();
}
}
1 change: 1 addition & 0 deletions iothub/device/src/Transport/AmqpIot/AmqpIotSession.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
using Microsoft.Azure.Amqp.Framing;
using Microsoft.Azure.Devices.Client.Exceptions;
using Microsoft.Azure.Devices.Client.Extensions;
using Microsoft.Azure.Devices.Client.Transport.Amqp;
using Microsoft.Azure.Devices.Shared;

namespace Microsoft.Azure.Devices.Client.Transport.AmqpIot
Expand Down
17 changes: 0 additions & 17 deletions iothub/device/src/Transport/IDeviceIdentity.cs

This file was deleted.