Compatibility with .net standard

fred2u · fred2u · commit e2a40400993c · 2020-05-27T23:36:03.000+02:00
diff --git a/src/Serilog.Sinks.TCP/Serilog.Sinks.Splunk.TCP.csproj b/src/Serilog.Sinks.TCP/Serilog.Sinks.Splunk.TCP.csproj
@@ -2,9 +2,9 @@
 
   <PropertyGroup>
     <Description>The Splunk TCP Sink for Serilog</Description>
-    <VersionPrefix>1.2.0</VersionPrefix>
+    <VersionPrefix>1.3.0</VersionPrefix>
     <Authors>Matthew Erbs, Serilog Contributors</Authors>
-    <TargetFrameworks>net45;</TargetFrameworks>
+    <TargetFrameworks>net45;netstandard2.0</TargetFrameworks>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <AssemblyName>Serilog.Sinks.Splunk.TCP</AssemblyName>
     <PackageId>Serilog.Sinks.Splunk.TCP</PackageId>
@@ -19,14 +19,24 @@
     <SignAssembly>true</SignAssembly>
   </PropertyGroup>
 
-  <ItemGroup>
-    <PackageReference Include="Serilog.Sinks.Splunk" Version="2.5.0" />
-    <PackageReference Include="Splunk.Logging.Common" Version="1.6.0" />
-    <Reference Include="System.Net.Http" />
+  <PropertyGroup Condition=" '$(TargetFramework)' == 'net45' ">
+    <!-- Don't reference unused System assemblies -->
+    <DisableImplicitFrameworkReferences>true</DisableImplicitFrameworkReferences>
+  </PropertyGroup>
+
+  <ItemGroup Condition=" '$(TargetFramework)' == 'net45' ">
     <Reference Include="System" />
-    <Reference Include="Microsoft.CSharp" />
-    <PackageReference Include="Serilog" Version="2.6.0" />
-    <PackageReference Include="Serilog.Sinks.PeriodicBatching" Version="2.1.1" />
+    <Reference Include="System.Core" />
+    <Reference Include="System.Net.Http" />
+    <PackageReference Include="Splunk.Logging.Common" Version="1.7.2" />
+  </ItemGroup>
+
+  <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' ">
+    <!--<PackageReference Include="System.Net.Http" Version="4.3.0" />-->
+    <PackageReference Include="Splunk.Logging.Common.Core" Version="1.0.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Serilog.Sinks.Splunk" Version="3.3.0" />
   </ItemGroup>
- 
 </Project>
diff --git a/src/Serilog.Sinks.TCP/Sinks/Splunk/SplunkTcpSinkConnectionInfo.cs b/src/Serilog.Sinks.TCP/Sinks/Splunk/SplunkTcpSinkConnectionInfo.cs
@@ -0,0 +1,66 @@
+﻿// Copyright 2016 Serilog Contributors
+// 
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// 
+//     http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System.Net;
+
+namespace Serilog.Sinks.Splunk
+{
+    /// <summary>
+    /// Defines connection info used to connect against Splunk
+    /// using TCP.
+    /// </summary>
+    public class SplunkTcpSinkConnectionInfo
+    {
+        /// <summary>
+        /// Default size of the socket writer queue.
+        /// </summary>
+        public const int DefaultMaxQueueSize = 10000;
+
+        /// <summary>
+        /// Splunk host.
+        /// </summary>
+        public IPAddress Host { get; }
+
+        /// <summary>
+        /// Splunk port.
+        /// </summary>
+        public int Port { get; }
+
+        /// <summary>
+        /// Max Queue size for the TCP socket writer.
+        /// See <see cref="DefaultMaxQueueSize"/> for default value (10000).
+        /// </summary>
+        public int MaxQueueSize { get; set; } = DefaultMaxQueueSize;
+
+        /// <summary>
+        /// Creates an instance of <see cref="SplunkTcpSinkConnectionInfo"/> used
+        /// for defining connection info for connecting using TCP against Splunk.
+        /// </summary>
+        /// <param name="host">Splunk host.</param>
+        /// <param name="port">Splunk TCP port.</param>
+        public SplunkTcpSinkConnectionInfo(string host, int port) : this(IPAddress.Parse(host), port) { }
+
+        /// <summary>
+        /// Creates an instance of <see cref="SplunkTcpSinkConnectionInfo"/> used
+        /// for defining connection info for connecting using TCP against Splunk.
+        /// </summary>
+        /// <param name="host">Splunk host.</param>
+        /// <param name="port">Splunk TCP port.</param>
+        public SplunkTcpSinkConnectionInfo(IPAddress host, int port)
+        {
+            Host = host;
+            Port = port;
+        }
+    }
+}
diff --git a/src/Serilog.Sinks.TCP/Sinks/Splunk/TcpSink.cs b/src/Serilog.Sinks.TCP/Sinks/Splunk/TcpSink.cs
@@ -1,6 +1,4 @@
-﻿#if TCP
-
-// Copyright 2016 Serilog Contributors
+﻿// Copyright 2016 Serilog Contributors
 // 
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -14,14 +12,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-using System;
-using System.IO;
-using System.Net;
-using System.Text;
 using Serilog.Core;
 using Serilog.Events;
 using Serilog.Formatting;
 using Splunk.Logging;
+using System;
+using System.IO;
+using System.Text;
 
 namespace Serilog.Sinks.Splunk
 {
@@ -30,7 +27,10 @@ namespace Serilog.Sinks.Splunk
     /// </summary>
     public class TcpSink : ILogEventSink, IDisposable
     {
-        readonly ITextFormatter _formatter;
+        private readonly ITextFormatter _formatter;
+        private readonly SplunkTcpSinkConnectionInfo _connectionInfo;
+        private bool disposedValue = false;
+
         private TcpSocketWriter _writer;
 
         /// <summary>
@@ -39,70 +39,41 @@ public class TcpSink : ILogEventSink, IDisposable
         /// <param name="connectionInfo">Connection info used for connecting against Splunk.</param>
         /// <param name="formatProvider">Optional format provider</param>
         /// <param name="renderTemplate">If true, the message template will be rendered</param>
-        public TcpSink(
-            SplunkTcpSinkConnectionInfo connectionInfo,
-            IFormatProvider formatProvider = null,
-            bool renderTemplate = true)
+        public TcpSink(SplunkTcpSinkConnectionInfo connectionInfo, IFormatProvider formatProvider = null, bool renderTemplate = true)
+            : this(connectionInfo, CreateDefaultFormatter(formatProvider, renderTemplate))
         {
-            _writer = CreateSocketWriter(connectionInfo);
-            _formatter = CreateDefaultFormatter(formatProvider, renderTemplate);
         }
 
         /// <summary>
         /// Creates an instance of the Splunk TCP Sink.
         /// </summary>
         /// <param name="connectionInfo">Connection info used for connecting against Splunk.</param>
         /// <param name="formatter">Custom formatter to use if you e.g. do not want to use the JsonFormatter.</param>
-        public TcpSink(
-            SplunkTcpSinkConnectionInfo connectionInfo,
-            ITextFormatter formatter)
+        public TcpSink(SplunkTcpSinkConnectionInfo connectionInfo, ITextFormatter formatter)
         {
-            _writer = CreateSocketWriter(connectionInfo);
+            _connectionInfo = connectionInfo;
             _formatter = formatter;
+            _writer = CreateSocketWriter(connectionInfo);
         }
 
-        /// <summary>
-        /// Creates an instance of the Splunk TCP Sink
-        /// </summary>
-        /// <param name="host">The Splunk Host</param>
-        /// <param name="port">The TCP port configured in Splunk</param>
-        /// <param name="formatProvider">Optional format provider</param>
-        /// <param name="renderTemplate">If true, the message template will be rendered</param>
-        [Obsolete("Use the overload accepting a connection info object instead. This overload will be removed.", false)]
-        public TcpSink(
-            string host,
-            int port,
-            IFormatProvider formatProvider = null,
-            bool renderTemplate = true) : this(new SplunkTcpSinkConnectionInfo(host, port), formatProvider, renderTemplate)
-        {
-        }
-
-        /// <summary>
-        /// Creates an instance of the Splunk TCP Sink
-        /// </summary>
-        /// <param name="hostAddress">The Splunk Host</param>
-        /// <param name="port">The TCP port configured in Splunk</param>
-        /// <param name="formatProvider">Optional format provider</param>
-        /// <param name="renderTemplate">If true, the message template will be rendered</param>
-        [Obsolete("Use the overload accepting a connection info object instead. This overload will be removed.", false)]
-        public TcpSink(
-            IPAddress hostAddress,
-            int port,
-            IFormatProvider formatProvider = null,
-            bool renderTemplate = true) : this(new SplunkTcpSinkConnectionInfo(hostAddress, port), formatProvider, renderTemplate)
+        /// <inheritdoc/>
+        protected virtual void Dispose(bool disposing)
         {
+            if (!disposedValue)
+            {
+                if (disposing)
+                {
+                    _writer?.Dispose();
+                    _writer = null;
+                }
+                disposedValue = true;
+            }
         }
 
-        private static TcpSocketWriter CreateSocketWriter(SplunkTcpSinkConnectionInfo connectionInfo)
+        /// <inheritdoc/>
+        public void Dispose()
         {
-            var reconnectionPolicy = new ExponentialBackoffTcpReconnectionPolicy();
-
-            return new TcpSocketWriter(connectionInfo.Host, connectionInfo.Port, reconnectionPolicy, connectionInfo.MaxQueueSize);
-        }
-
-        private static SplunkJsonFormatter CreateDefaultFormatter(IFormatProvider formatProvider, bool renderTemplate)
-        {
-            return new SplunkJsonFormatter(renderTemplate, formatProvider);
+            Dispose(true);
         }
 
         /// <inheritdoc/>
@@ -116,62 +87,16 @@ public void Emit(LogEvent logEvent)
             _writer.Enqueue(sb.ToString());
         }
 
-        /// <inheritdoc/>
-        public void Dispose()
+        private static TcpSocketWriter CreateSocketWriter(SplunkTcpSinkConnectionInfo connectionInfo)
         {
-            _writer?.Dispose();
-            _writer = null;
-        }
-    }
-
-
-    /// <summary>
-    /// Defines connection info used to connect against Splunk
-    /// using TCP.
-    /// </summary>
-    public class SplunkTcpSinkConnectionInfo
-    {
-        /// <summary>
-        /// Default size of the socket writer queue.
-        /// </summary>
-        public const int DefaultMaxQueueSize = 10000;
-
-        /// <summary>
-        /// Splunk host.
-        /// </summary>
-        public IPAddress Host { get; }
-
-        /// <summary>
-        /// Splunk port.
-        /// </summary>
-        public int Port { get; }
-
-        /// <summary>
-        /// Max Queue size for the TCP socket writer.
-        /// See <see cref="DefaultMaxQueueSize"/> for default value (10000).
-        /// </summary>
-        public int MaxQueueSize { get; set; } = DefaultMaxQueueSize;
+            var reconnectionPolicy = new ExponentialBackoffTcpReconnectionPolicy();
 
-        /// <summary>
-        /// Creates an instance of <see cref="SplunkTcpSinkConnectionInfo"/> used
-        /// for defining connection info for connecting using TCP against Splunk.
-        /// </summary>
-        /// <param name="host">Splunk host.</param>
-        /// <param name="port">Splunk TCP port.</param>
-        public SplunkTcpSinkConnectionInfo(string host, int port) : this(IPAddress.Parse(host), port) { }
+            return new TcpSocketWriter(connectionInfo.Host, connectionInfo.Port, reconnectionPolicy, connectionInfo.MaxQueueSize);
+        }
 
-        /// <summary>
-        /// Creates an instance of <see cref="SplunkTcpSinkConnectionInfo"/> used
-        /// for defining connection info for connecting using TCP against Splunk.
-        /// </summary>
-        /// <param name="host">Splunk host.</param>
-        /// <param name="port">Splunk TCP port.</param>
-        public SplunkTcpSinkConnectionInfo(IPAddress host, int port)
+        private static SplunkJsonFormatter CreateDefaultFormatter(IFormatProvider formatProvider, bool renderTemplate)
         {
-            Host = host;
-            Port = port;
+            return new SplunkJsonFormatter(renderTemplate, formatProvider);
         }
     }
 }
-
-#endif
diff --git a/src/Serilog.Sinks.TCP/SplunkLoggingConfigurationExtensions.cs b/src/Serilog.Sinks.TCP/SplunkLoggingConfigurationExtensions.cs
