jellyfin/MediaBrowser.Model/Net/ISocketFactory.cs

29 lines
1.2 KiB
C#
Raw Normal View History

2020-02-04 00:49:27 +00:00
#pragma warning disable CS1591
using System.Net;
2018-12-27 23:27:57 +00:00
namespace MediaBrowser.Model.Net
{
/// <summary>
/// Implemented by components that can create a platform specific UDP socket implementation, and wrap it in the cross platform <see cref="ISocket"/> interface.
/// </summary>
public interface ISocketFactory
2019-01-07 23:24:34 +00:00
{
2018-12-27 23:27:57 +00:00
ISocket CreateUdpBroadcastSocket(int localPort);
/// <summary>
/// Creates a new unicast socket using the specified local port number.
2018-12-27 23:27:57 +00:00
/// </summary>
ISocket CreateSsdpUdpSocket(IPAddress localIp, int localPort);
2018-12-27 23:27:57 +00:00
/// <summary>
/// Creates a new multicast socket using the specified multicast IP address, multicast time to live and local port.
2018-12-27 23:27:57 +00:00
/// </summary>
/// <param name="ipAddress">The multicast IP address to bind to.</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 <see cref="ISocket"/> implementation.</returns>
ISocket CreateUdpMulticastSocket(string ipAddress, int multicastTimeToLive, int localPort);
}
}