aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Model/Net/ISocketFactory.cs
diff options
context:
space:
mode:
authorShadowghost <Ghost_of_Stone@web.de>2023-02-20 16:58:22 +0100
committerShadowghost <Ghost_of_Stone@web.de>2023-02-20 16:58:22 +0100
commita5f16136eb171b17b1e1ed661e9aeb017522ce89 (patch)
tree3c523ede9ed7f42813a4c9fb9361832007fb9339 /MediaBrowser.Model/Net/ISocketFactory.cs
parentc5a363a007b98e7a680bb2a95d9bd49a7dced8f2 (diff)
Apply review suggestions
Diffstat (limited to 'MediaBrowser.Model/Net/ISocketFactory.cs')
-rw-r--r--MediaBrowser.Model/Net/ISocketFactory.cs53
1 files changed, 26 insertions, 27 deletions
diff --git a/MediaBrowser.Model/Net/ISocketFactory.cs b/MediaBrowser.Model/Net/ISocketFactory.cs
index 49a88c227..128034eb8 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;
+
+/// <summary>
+/// Implemented by components that can create specific socket configurations.
+/// </summary>
+public interface ISocketFactory
{
/// <summary>
- /// Implemented by components that can create specific socket configurations.
+ /// Creates a new unicast socket using the specified local port number.
/// </summary>
- public interface ISocketFactory
- {
- /// <summary>
- /// Creates a new unicast socket using the specified local port number.
- /// </summary>
- /// <param name="localPort">The local port to bind to.</param>
- /// <returns>A new unicast socket using the specified local port number.</returns>
- Socket CreateUdpBroadcastSocket(int localPort);
+ /// <param name="localPort">The local port to bind to.</param>
+ /// <returns>A new unicast socket using the specified local port number.</returns>
+ Socket CreateUdpBroadcastSocket(int localPort);
- /// <summary>
- /// Creates a new unicast socket using the specified local port number.
- /// </summary>
- /// <param name="bindInterface">The bind interface.</param>
- /// <param name="localPort">The local port to bind to.</param>
- /// <returns>A new unicast socket using the specified local port number.</returns>
- Socket CreateSsdpUdpSocket(IPData bindInterface, int localPort);
+ /// <summary>
+ /// Creates a new unicast socket using the specified local port number.
+ /// </summary>
+ /// <param name="bindInterface">The bind interface.</param>
+ /// <param name="localPort">The local port to bind to.</param>
+ /// <returns>A new unicast socket using the specified local port number.</returns>
+ Socket CreateSsdpUdpSocket(IPData bindInterface, int localPort);
- /// <summary>
- /// Creates a new multicast socket using the specified multicast IP address, multicast time to live and local port.
- /// </summary>
- /// <param name="multicastAddress">The multicast IP address to bind to.</param>
- /// <param name="bindInterface">The bind interface.</param>
- /// <param name="multicastTimeToLive">The multicast time to live value. Actually a maximum number of network hops for UDP packets.</param>
- /// <param name="localPort">The local port to bind to.</param>
- /// <returns>A new multicast socket using the specfied bind interface, multicast address, multicast time to live and port.</returns>
- Socket CreateUdpMulticastSocket(IPAddress multicastAddress, IPData bindInterface, int multicastTimeToLive, int localPort);
- }
+ /// <summary>
+ /// Creates a new multicast socket using the specified multicast IP address, multicast time to live and local port.
+ /// </summary>
+ /// <param name="multicastAddress">The multicast IP address to bind to.</param>
+ /// <param name="bindInterface">The bind interface.</param>
+ /// <param name="multicastTimeToLive">The multicast time to live value. Actually a maximum number of network hops for UDP packets.</param>
+ /// <param name="localPort">The local port to bind to.</param>
+ /// <returns>A new multicast socket using the specfied bind interface, multicast address, multicast time to live and port.</returns>
+ Socket CreateUdpMulticastSocket(IPAddress multicastAddress, IPData bindInterface, int multicastTimeToLive, int localPort);
}