From a5f16136eb171b17b1e1ed661e9aeb017522ce89 Mon Sep 17 00:00:00 2001 From: Shadowghost Date: Mon, 20 Feb 2023 16:58:22 +0100 Subject: Apply review suggestions --- MediaBrowser.Model/Net/IPData.cs | 109 +++++++++++++++---------------- MediaBrowser.Model/Net/ISocketFactory.cs | 53 ++++++++------- 2 files changed, 80 insertions(+), 82 deletions(-) (limited to 'MediaBrowser.Model/Net') diff --git a/MediaBrowser.Model/Net/IPData.cs b/MediaBrowser.Model/Net/IPData.cs index 16d74dcddd..985b16c6e4 100644 --- a/MediaBrowser.Model/Net/IPData.cs +++ b/MediaBrowser.Model/Net/IPData.cs @@ -2,73 +2,72 @@ using System.Net; using System.Net.Sockets; using Microsoft.AspNetCore.HttpOverrides; -namespace MediaBrowser.Model.Net +namespace MediaBrowser.Model.Net; + +/// +/// Base network object class. +/// +public class IPData { /// - /// Base network object class. + /// Initializes a new instance of the class. /// - public class IPData + /// The . + /// The . + /// The interface name. + public IPData(IPAddress address, IPNetwork? subnet, string name) { - /// - /// Initializes a new instance of the class. - /// - /// The . - /// The . - /// The interface name. - public IPData(IPAddress address, IPNetwork? subnet, string name) - { - Address = address; - Subnet = subnet ?? (address.AddressFamily == AddressFamily.InterNetwork ? new IPNetwork(address, 32) : new IPNetwork(address, 128)); - Name = name; - } + Address = address; + Subnet = subnet ?? (address.AddressFamily == AddressFamily.InterNetwork ? new IPNetwork(address, 32) : new IPNetwork(address, 128)); + Name = name; + } - /// - /// Initializes a new instance of the class. - /// - /// The . - /// The . - public IPData(IPAddress address, IPNetwork? subnet) - : this(address, subnet, string.Empty) - { - } + /// + /// Initializes a new instance of the class. + /// + /// The . + /// The . + public IPData(IPAddress address, IPNetwork? subnet) + : this(address, subnet, string.Empty) + { + } - /// - /// Gets or sets the object's IP address. - /// - public IPAddress Address { get; set; } + /// + /// Gets or sets the object's IP address. + /// + public IPAddress Address { get; set; } - /// - /// Gets or sets the object's IP address. - /// - public IPNetwork Subnet { get; set; } + /// + /// Gets or sets the object's IP address. + /// + public IPNetwork Subnet { get; set; } - /// - /// Gets or sets the interface index. - /// - public int Index { get; set; } + /// + /// Gets or sets the interface index. + /// + public int Index { get; set; } - /// - /// Gets or sets the interface name. - /// - public string Name { get; set; } + /// + /// Gets or sets the interface name. + /// + public string Name { get; set; } - /// - /// Gets the AddressFamily of the object. - /// - public AddressFamily AddressFamily + /// + /// Gets the AddressFamily of the object. + /// + public AddressFamily AddressFamily + { + get { - get + if (Address.Equals(IPAddress.None)) + { + return Subnet.Prefix.AddressFamily.Equals(IPAddress.None) + ? AddressFamily.Unspecified + : Subnet.Prefix.AddressFamily; + } + else { - if (Address.Equals(IPAddress.None)) - { - return Subnet.Prefix.AddressFamily.Equals(IPAddress.None) - ? AddressFamily.Unspecified - : Subnet.Prefix.AddressFamily; - } - else - { - return Address.AddressFamily; - } + return Address.AddressFamily; } } } diff --git a/MediaBrowser.Model/Net/ISocketFactory.cs b/MediaBrowser.Model/Net/ISocketFactory.cs index 49a88c2277..128034eb8f 100644 --- a/MediaBrowser.Model/Net/ISocketFactory.cs +++ b/MediaBrowser.Model/Net/ISocketFactory.cs @@ -1,36 +1,35 @@ using System.Net; using System.Net.Sockets; -namespace MediaBrowser.Model.Net +namespace MediaBrowser.Model.Net; + +/// +/// Implemented by components that can create specific socket configurations. +/// +public interface ISocketFactory { /// - /// Implemented by components that can create specific socket configurations. + /// Creates a new unicast socket using the specified local port number. /// - public interface ISocketFactory - { - /// - /// Creates a new unicast socket using the specified local port number. - /// - /// The local port to bind to. - /// A new unicast socket using the specified local port number. - Socket CreateUdpBroadcastSocket(int localPort); + /// The local port to bind to. + /// A new unicast socket using the specified local port number. + Socket CreateUdpBroadcastSocket(int localPort); - /// - /// Creates a new unicast socket using the specified local port number. - /// - /// The bind interface. - /// The local port to bind to. - /// A new unicast socket using the specified local port number. - Socket CreateSsdpUdpSocket(IPData bindInterface, int localPort); + /// + /// Creates a new unicast socket using the specified local port number. + /// + /// The bind interface. + /// The local port to bind to. + /// A new unicast socket using the specified local port number. + Socket CreateSsdpUdpSocket(IPData bindInterface, int localPort); - /// - /// Creates a new multicast socket using the specified multicast IP address, multicast time to live and local port. - /// - /// The multicast IP address to bind to. - /// The bind interface. - /// The multicast time to live value. Actually a maximum number of network hops for UDP packets. - /// The local port to bind to. - /// A new multicast socket using the specfied bind interface, multicast address, multicast time to live and port. - Socket CreateUdpMulticastSocket(IPAddress multicastAddress, IPData bindInterface, int multicastTimeToLive, int localPort); - } + /// + /// Creates a new multicast socket using the specified multicast IP address, multicast time to live and local port. + /// + /// The multicast IP address to bind to. + /// The bind interface. + /// The multicast time to live value. Actually a maximum number of network hops for UDP packets. + /// The local port to bind to. + /// A new multicast socket using the specfied bind interface, multicast address, multicast time to live and port. + Socket CreateUdpMulticastSocket(IPAddress multicastAddress, IPData bindInterface, int multicastTimeToLive, int localPort); } -- cgit v1.2.3