feat: create configuration option for broadcasting (#175)

Co-authored-by: dnatov <dnatov@gsdx.us>
Co-authored-by: FantasticFiasco <mattias@kindb.org>

Author: 3 people

CHANGELOG.md

@@ -6,6 +6,8 @@ This project adheres to [Semantic Versioning](http://semver.org/) and is followi
 
 ## Unreleased
 
+- [BREAKING CHANGE] Support for broadcast packages (contributed by [@dnatov](https://github.com/dnatov))
+
 ### :zap: Added
 
 - [BREAKING CHANGE] Support for specifying UDP datagram encoding (contributed by [@pedoc](https://github.com/pedoc))

src/Serilog.Sinks.Udp/LoggerSinkConfigurationExtensions.cs

@@ -55,6 +55,9 @@ public static class LoggerSinkConfigurationExtensions
     /// The TCP port from which the UDP client will communicate. The default is 0 and will
     /// cause the UDP client not to bind to a local port.
     /// </param>
+    /// <param name="enableBroadcast">
+    /// Whether the <see cref="UdpClient"/> may send broadcast packets.
+    /// </param>
     /// <param name="restrictedToMinimumLevel">
     /// The minimum level for events passed through the sink. The default is
     /// <see cref="LevelAlias.Minimum"/>.
@@ -81,6 +84,7 @@ public static LoggerConfiguration Udp(
         int remotePort,
         AddressFamily family,
         int localPort = 0,
+        bool enableBroadcast = false,
         LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
         LoggingLevelSwitch? levelSwitch = null,
         string outputTemplate = DefaultOutputTemplate,
@@ -99,6 +103,7 @@ public static LoggerConfiguration Udp(
             family,
             formatter,
             localPort,
+            enableBroadcast,
             restrictedToMinimumLevel,
             levelSwitch,
             encoding);
@@ -131,6 +136,9 @@ public static LoggerConfiguration Udp(
     /// The TCP port from which the UDP client will communicate. The default is 0 and will
     /// cause the UDP client not to bind to a local port.
     /// </param>
+    /// <param name="enableBroadcast">
+    /// Whether the <see cref="UdpClient"/> may send broadcast packets.
+    /// </param>
     /// <param name="restrictedToMinimumLevel">
     /// The minimum level for events passed through the sink. The default is
     /// <see cref="LevelAlias.Minimum"/>.
@@ -151,6 +159,7 @@ public static LoggerConfiguration Udp(
         AddressFamily family,
         ITextFormatter formatter,
         int localPort = 0,
+        bool enableBroadcast = false,
         LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
         LoggingLevelSwitch? levelSwitch = null,
         Encoding? encoding = null)
@@ -161,7 +170,7 @@ public static LoggerConfiguration Udp(
 
         try
         {
-            var client = UdpClientFactory.Create(localPort, family);
+            var client = UdpClientFactory.Create(localPort, family, enableBroadcast);
             var sink = new BatchingSink(new UdpSink(client, remoteAddress, remotePort, formatter, encoding));
 
             return sinkConfiguration.Sink(sink, restrictedToMinimumLevel, levelSwitch);

src/Serilog.Sinks.Udp/Sinks/Udp/Private/UdpClientFactory.cs

@@ -25,6 +25,6 @@ public static class UdpClientFactory
     /// <summary>
     /// Gets or sets the factory creating instances of <see cref="IUdpClient"/>.
     /// </summary>
-    public static Func<int, AddressFamily, IUdpClient> Create { get; set; }
-        = (localPort, family) => new UdpClientWrapper(localPort, family);
-}
+    public static Func<int, AddressFamily, bool, IUdpClient> Create { get; set; }
+        = (localPort, family, enableBroadcast) => new UdpClientWrapper(localPort, family, enableBroadcast);
+}

src/Serilog.Sinks.Udp/Sinks/Udp/Private/UdpClientWrapper.cs

@@ -23,7 +23,7 @@ internal class UdpClientWrapper : IUdpClient
 {
     private readonly UdpClient client;
 
-    public UdpClientWrapper(int localPort, AddressFamily family)
+    public UdpClientWrapper(int localPort, AddressFamily family, bool enableBroadcast)
     {
         if (localPort < IPEndPoint.MinPort || localPort > IPEndPoint.MaxPort) throw new ArgumentOutOfRangeException(nameof(localPort));
 
@@ -36,6 +36,9 @@ public UdpClientWrapper(int localPort, AddressFamily family)
         {
             client.Client.DualMode = true;
         }
+
+        // Enable broadcasting
+        client.EnableBroadcast = enableBroadcast;
     }
 
     public Socket Client => client.Client;
@@ -61,4 +64,4 @@ public void Dispose()
         client.Dispose();
     }
 #endif
-}
+}

test/Serilog.Sinks.Udp.Tests/SinkFixture.cs

@@ -11,15 +11,15 @@ namespace Serilog;
 
 public abstract class SinkFixture : IDisposable
 {
-    private readonly Func<int, AddressFamily, IUdpClient> originalFactory;
+    private readonly Func<int, AddressFamily, bool, IUdpClient> originalFactory;
     private readonly UdpClientMock client;
 
     protected SinkFixture()
     {
         originalFactory = UdpClientFactory.Create;
 
         client = new UdpClientMock();
-        UdpClientFactory.Create = (_, __) => client.Object;
+        UdpClientFactory.Create = (_, __, ___) => client.Object;
     }
 
     protected abstract string RemoteAddress { get; }
@@ -85,4 +85,4 @@ public void Dispose()
 
         UdpClientFactory.Create = originalFactory;
     }
-}
+}

test/Serilog.Sinks.Udp.Tests/Sinks/Udp/Private/UdpClientFactoryShould.cs

@@ -19,7 +19,7 @@ public class UdpClientFactoryShould : IDisposable
     public void UseDualModeOnInterNetworkV6()
     {
         // Act
-        client = UdpClientFactory.Create(0, AddressFamily.InterNetworkV6);
+        client = UdpClientFactory.Create(0, AddressFamily.InterNetworkV6, false);
 
         // Assert
         client.Client.DualMode.ShouldBeTrue();
@@ -31,7 +31,7 @@ public void UseDualModeOnInterNetworkV6()
     public async void SendPayload(string address, AddressFamily family)
     {
         // Arrange
-        client = UdpClientFactory.Create(0, family);
+        client = UdpClientFactory.Create(0, family, false);
 
         var ipAddress = IPAddress.Parse(address);
 
@@ -55,4 +55,4 @@ public void Dispose()
     {
         client.Dispose();
     }
-}
+}