michael.heier/jellyfin
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Update INetworkManager.cs

Browse Source 
Editting comments - adding periods
This commit is contained in:
BaronGreenback 2020-06-11 22:58:29 +01:00 committed by GitHub
parent 4d9171f691
commit 2cecde658b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
MediaBrowser.Common/Net/INetworkManager.cs
View File

@ -12,7 +12,7 @@ namespace MediaBrowser.Common.Net
event EventHandler NetworkChanged;
/// <summary>
/// Contains a function to return the list of user defined LAN addresses
/// Gets or sets a function to return the list of user defined LAN addresses.
/// </summary>
Func<string[]> LocalSubnetsFn { get; set; }
@ -54,44 +54,44 @@ namespace MediaBrowser.Common.Net
/// <param name="endpoint">The endpoint.</param>
/// <returns><c>true</c> if [is in local network] [the specified endpoint]; otherwise, <c>false</c>.</returns>
bool IsInLocalNetwork(string endpoint);
/// <summary>
/// Investigates an caches a list of interface addresses, excluding local link and LAN excluded addresses
/// Investigates an caches a list of interface addresses, excluding local link and LAN excluded addresses.
/// </summary>
/// <returns>The list of ipaddresses</returns>
/// <returns>The list of ipaddresses.</returns>
IPAddress[] GetLocalIpAddresses();
/// <summary>
/// <summary>
/// Checks if the given address falls within the ranges given in [subnets]. The addresses in subnets can be hosts or subnets in the CIDR format.
/// </summary>
/// <param name="addressString">The address to check</param>
/// <param name="subnets">If true, check against addresses in the LAN settings surrounded by brackets ([])</param>
/// <param name="addressString">The address to check.</param>
/// <param name="subnets">If true, check against addresses in the LAN settings surrounded by brackets ([]).</param>
/// <returns><c>true</c>if the address is in at least one of the given subnets, <c>false</c> otherwise.</returns>
bool IsAddressInSubnets(string addressString, string[] subnets);
/// <summary>
/// Returns true if address is in the LAN list in the config file
/// Returns true if address is in the LAN list in the config file.
/// </summary>
/// <param name="address">The address to check</param>
/// <param name="excludeInterfaces">If true, check against addresses in the LAN settings which have [] arroud and return true if it matches the address give in address</param>
/// <param name="excludeRFC">If true, returns false if address is in the 127.x.x.x or 169.128.x.x range</param>
/// <returns><c>false</c>if the address isn't in the LAN list, <c>true</c> if the address has been defined as a LAN address</returns>
/// <param name="address">The address to check.</param>
/// <param name="excludeInterfaces">If true, check against addresses in the LAN settings which have [] arroud and return true if it matches the address give in address.</param>
/// <param name="excludeRFC">If true, returns false if address is in the 127.x.x.x or 169.128.x.x range.</param>
/// <returns><c>false</c>if the address isn't in the LAN list, <c>true</c> if the address has been defined as a LAN address.</returns>
bool IsAddressInSubnets(IPAddress address, bool excludeInterfaces, bool excludeRFC);
/// <summary>
/// Checks if address is in the LAN list in the config file
/// Checks if address is in the LAN list in the config file.
/// </summary>
/// <param name="address1">Source address to check</param>
/// <param name="address2">Destination address to check against</param>
/// <param name="subnetMask">Destination subnet to check against</param>
/// <returns><c>true/false</c>depending on whether address1 is in the same subnet as IPAddress2 with subnetMas</returns>
/// <param name="address1">Source address to check.</param>
/// <param name="address2">Destination address to check against.</param>
/// <param name="subnetMask">Destination subnet to check against.</param>
/// <returns><c>true/false</c>depending on whether address1 is in the same subnet as IPAddress2 with subnetMask.</returns>
bool IsInSameSubnet(IPAddress address1, IPAddress address2, IPAddress subnetMask);
/// <summary>
/// Returns the subnet mask of an interface with the given address
/// Returns the subnet mask of an interface with the given address.
/// </summary>
/// <param name="address">The address to check</param>
/// <returns>Returns the subnet mask of an interface with the given address, or null if an interface match cannot be found</returns>
/// <param name="address">The address to check.</param>
/// <returns>Returns the subnet mask of an interface with the given address, or null if an interface match cannot be found.</returns>
IPAddress GetLocalIpSubnetMask(IPAddress address);
}
}