jellyfin/RSSDP/DeviceAvailableEventArgs.cs

51 lines
2.0 KiB
C#
Raw Normal View History

using System;
using System.Net;
2016-10-29 15:22:20 -07:00
namespace Rssdp
{
2019-01-07 16:24:34 -07:00
/// <summary>
2022-02-06 14:21:17 -07:00
/// Event arguments for the <see cref="Infrastructure.SsdpDeviceLocator.DeviceAvailable"/> event.
2019-01-07 16:24:34 -07:00
/// </summary>
public sealed class DeviceAvailableEventArgs : EventArgs
{
public IPAddress RemoteIpAddress { get; set; }
2016-10-29 15:22:20 -07:00
2017-01-24 12:54:18 -07:00
private readonly DiscoveredSsdpDevice _DiscoveredDevice;
2016-10-29 15:22:20 -07:00
2020-06-19 23:20:33 -07:00
private readonly bool _IsNewlyDiscovered;
2016-10-29 15:22:20 -07:00
2019-01-13 13:37:13 -07:00
/// <summary>
/// Full constructor.
/// </summary>
/// <param name="discoveredDevice">A <see cref="DiscoveredSsdpDevice"/> instance representing the available device.</param>
/// <param name="isNewlyDiscovered">A boolean value indicating whether or not this device came from the cache. See <see cref="IsNewlyDiscovered"/> for more detail.</param>
/// <exception cref="ArgumentNullException">Thrown if the <paramref name="discoveredDevice"/> parameter is null.</exception>
public DeviceAvailableEventArgs(DiscoveredSsdpDevice discoveredDevice, bool isNewlyDiscovered)
{
2020-06-20 01:35:29 -07:00
if (discoveredDevice == null)
{
throw new ArgumentNullException(nameof(discoveredDevice));
}
2016-10-29 15:22:20 -07:00
_DiscoveredDevice = discoveredDevice;
_IsNewlyDiscovered = isNewlyDiscovered;
}
2016-10-29 15:22:20 -07:00
/// <summary>
/// Returns true if the device was discovered due to an alive notification, or a search and was not already in the cache. Returns false if the item came from the cache but matched the current search request.
/// </summary>
public bool IsNewlyDiscovered
{
get { return _IsNewlyDiscovered; }
}
2016-10-29 15:22:20 -07:00
2019-01-13 13:37:13 -07:00
/// <summary>
/// A reference to a <see cref="DiscoveredSsdpDevice"/> instance containing the discovered details and allowing access to the full device description.
/// </summary>
public DiscoveredSsdpDevice DiscoveredDevice
{
get { return _DiscoveredDevice; }
}
}
}