Tcp Keepalive for Linux (NET8.0)

New Target .NET 8.0
Fixes setup of Tcp Keepalive under Linux

Author: Christoph Bauer

src/NetMQ.Tests/ClientServer.cs

@@ -82,7 +82,7 @@ public async void AsyncWithCancellationToken()
             await Assert.ThrowsAnyAsync<OperationCanceledException>(async () => await server.ReceiveStringAsync(source.Token));
         }
 
-#if NETCOREAPP3_1
+#if NET8_0_OR_GREATER
 
         [Fact(Timeout = 120)]
         public async void AsyncEnumerableCanceled()

src/NetMQ/Annotations.cs

@@ -1,6 +1,6 @@
 // Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the LICENSE.md file in the project root for more information.
 
-#if !NETSTANDARD2_1
+#if !NETSTANDARD2_1 && !NET8_0_OR_GREATER
 
 namespace System.Diagnostics.CodeAnalysis
 {

src/NetMQ/AsyncReceiveExtensions.cs

@@ -1,4 +1,4 @@
-#if NETSTANDARD2_0 || NETSTANDARD2_1 || NET47
+#if NET8_0_OR_GREATER || NET8_0_OR_GREATER ||  NETSTANDARD2_0 || NETSTANDARD2_1 || NET47
 
 using System;
 using System.Collections.Generic;

src/NetMQ/Core/Mechanisms/CurveClientMechanism.cs

@@ -189,7 +189,7 @@ PullMsgResult ProduceInitiate(ref Msg msg)
 
             VouchNoncePrefix.CopyTo(vouchNonce);
             using var rng = RandomNumberGenerator.Create();
-#if NETSTANDARD2_1
+#if NET8_0_OR_GREATER || NETSTANDARD2_1
             rng.GetBytes(vouchNonce.Slice(8));
 #else
             byte[] temp = new byte[16];

src/NetMQ/Core/Mechanisms/CurveServerMechanism.cs

@@ -157,7 +157,7 @@ PullMsgResult ProduceWelcome(ref Msg msg)
             //  8-byte prefix plus 16-byte random nonce
             CookieNoncePrefix.CopyTo(cookieNonce);
             using var rng = RandomNumberGenerator.Create();
-#if NETSTANDARD2_1
+#if NET8_0_OR_GREATER || NETSTANDARD2_1
             rng.GetBytes(cookieNonce.Slice(8));
 #else
             byte[] temp = new byte[16];
@@ -184,7 +184,7 @@ PullMsgResult ProduceWelcome(ref Msg msg)
             //  Create full nonce for encryption
             //  8-byte prefix plus 16-byte random nonce
             WelcomeNoncePrefix.CopyTo(welcomeNonce);
-#if NETSTANDARD2_1
+#if NET8_0_OR_GREATER || NETSTANDARD2_1
             rng.GetBytes(welcomeNonce.Slice(8));
 #else
             rng.GetBytes(temp);

src/NetMQ/Core/Transports/Pgm/PgmSocket.cs

@@ -97,7 +97,7 @@ internal void Init()
                 Debug.WriteLine(xMsg);
 
                 // If running on Microsoft Windows, suggest to the developer that he may need to install MSMQ in order to get PGM socket support.
-#if NETSTANDARD1_1_OR_GREATER
+#if NET8_0_OR_GREATER || NETSTANDARD1_1_OR_GREATER
                 bool isWindows = RuntimeInformation.IsOSPlatform(OSPlatform.Windows);
 #else
                 bool isWindows = true;

src/NetMQ/Core/Transports/Tcp/TcpConnector.cs

@@ -250,6 +250,12 @@ public void OutCompleted(SocketError socketError, int bytesTransferred)
 
                     if (m_options.TcpKeepaliveIdle != -1 && m_options.TcpKeepaliveIntvl != -1)
                     {
+#if NET8_0_OR_GREATER
+                            if (m_options.TcpKeepaliveIdle != -1)
+                                m_s.SetSocketOption(SocketOptionLevel.Tcp, SocketOptionName.TcpKeepAliveTime, m_options.TcpKeepaliveIdle / 1000);
+                            if (m_options.TcpKeepaliveIntvl != -1)
+                                m_s.SetSocketOption(SocketOptionLevel.Tcp, SocketOptionName.TcpKeepAliveInterval, m_options.TcpKeepaliveIntvl / 1000);
+#else
                         // Write the TCP keep-alive options to a byte-array, to feed to the IOControl method..
                         var bytes = new ByteArraySegment(new byte[12]);
 
@@ -260,6 +266,7 @@ public void OutCompleted(SocketError socketError, int bytesTransferred)
                         bytes.PutInteger(endian, m_options.TcpKeepaliveIntvl, 8);
 
                         m_s.IOControl(IOControlCode.KeepAliveValues, (byte[])bytes, null);
+#endif
                     }
                 }
 

src/NetMQ/Core/Transports/Tcp/TcpListener.cs

@@ -22,7 +22,7 @@ You should have received a copy of the GNU Lesser General Public License
 using System;
 using System.Diagnostics;
 using System.Net.Sockets;
-#if NETSTANDARD2_0 || NETSTANDARD2_1
+#if NET8_0_OR_GREATER || NETSTANDARD2_0 || NETSTANDARD2_1
 using System.Runtime.InteropServices;
 #endif
 using AsyncIO;
@@ -45,12 +45,12 @@ internal class TcpListener : Own, IProactorEvents
         /// </summary>
         private AsyncSocket? m_handle;
 
-/*
-        /// <summary>
-        /// socket being accepted
-        /// </summary>
-        private AsyncSocket m_acceptedSocket;
-*/
+        /*
+                /// <summary>
+                /// socket being accepted
+                /// </summary>
+                private AsyncSocket m_acceptedSocket;
+        */
 
         /// <summary>
         /// Socket the listener belongs to.
@@ -107,7 +107,7 @@ protected override void ProcessPlug()
         protected override void ProcessTerm(int linger)
         {
             Assumes.NotNull(m_handle);
-           
+
             m_ioObject.SetHandler(this);
             m_ioObject.RemoveSocket(m_handle);
             Close();
@@ -141,7 +141,7 @@ public virtual void SetAddress(string addr)
                     }
                 }
 
-#if NETSTANDARD2_0 || NETSTANDARD2_1
+#if NET8_0_OR_GREATER || NETSTANDARD2_0 || NETSTANDARD2_1
                 // This command is failing on linux
                 if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
                     m_handle.ExclusiveAddressUse = false;
@@ -194,68 +194,75 @@ public void InCompleted(SocketError socketError, int bytesTransferred)
             switch (socketError)
             {
                 case SocketError.Success:
-                {
-                    // TODO: check TcpFilters
-                    var acceptedSocket = m_handle.GetAcceptedSocket();
+                    {
+                        // TODO: check TcpFilters
+                        var acceptedSocket = m_handle.GetAcceptedSocket();
 
                         acceptedSocket.NoDelay = true;
 
-                    if (m_options.TcpKeepalive != -1)
-                    {
-                        acceptedSocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.KeepAlive, m_options.TcpKeepalive);
-
-                        if (m_options.TcpKeepaliveIdle != -1 && m_options.TcpKeepaliveIntvl != -1)
+                        if (m_options.TcpKeepalive != -1)
                         {
-                            var bytes = new ByteArraySegment(new byte[12]);
+                            acceptedSocket.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.KeepAlive, m_options.TcpKeepalive);
+
+                            if (m_options.TcpKeepaliveIdle != -1 && m_options.TcpKeepaliveIntvl != -1)
+                            {
+#if NET8_0_OR_GREATER
+                            if (m_options.TcpKeepaliveIdle != -1)
+                                acceptedSocket.SetSocketOption(SocketOptionLevel.Tcp, SocketOptionName.TcpKeepAliveTime, m_options.TcpKeepaliveIdle / 1000);
+                            if (m_options.TcpKeepaliveIntvl != -1)
+                                acceptedSocket.SetSocketOption(SocketOptionLevel.Tcp, SocketOptionName.TcpKeepAliveInterval, m_options.TcpKeepaliveIntvl / 1000);
+#else
+                                var bytes = new ByteArraySegment(new byte[12]);
 
-                            Endianness endian = BitConverter.IsLittleEndian ? Endianness.Little : Endianness.Big;
+                                Endianness endian = BitConverter.IsLittleEndian ? Endianness.Little : Endianness.Big;
 
-                            bytes.PutInteger(endian, m_options.TcpKeepalive, 0);
-                            bytes.PutInteger(endian, m_options.TcpKeepaliveIdle, 4);
-                            bytes.PutInteger(endian, m_options.TcpKeepaliveIntvl, 8);
+                                bytes.PutInteger(endian, m_options.TcpKeepalive, 0);
+                                bytes.PutInteger(endian, m_options.TcpKeepaliveIdle, 4);
+                                bytes.PutInteger(endian, m_options.TcpKeepaliveIntvl, 8);
 
-                            acceptedSocket.IOControl(IOControlCode.KeepAliveValues, (byte[])bytes, null);
+                                acceptedSocket.IOControl(IOControlCode.KeepAliveValues, (byte[])bytes, null);
+#endif
+                            }
                         }
-                    }
 
-                    // Create the engine object for this connection.
-                    var engine = new StreamEngine(acceptedSocket, m_options, m_endpoint);
+                        // Create the engine object for this connection.
+                        var engine = new StreamEngine(acceptedSocket, m_options, m_endpoint);
 
-                    // Choose I/O thread to run connector in. Given that we are already
-                    // running in an I/O thread, there must be at least one available.
-                    IOThread? ioThread = ChooseIOThread(m_options.Affinity);
+                        // Choose I/O thread to run connector in. Given that we are already
+                        // running in an I/O thread, there must be at least one available.
+                        IOThread? ioThread = ChooseIOThread(m_options.Affinity);
 
-                    Assumes.NotNull(ioThread);
+                        Assumes.NotNull(ioThread);
 
-                    // Create and launch a session object.
-                    // TODO: send null in address parameter, is unneeded in this case
-                    SessionBase session = SessionBase.Create(ioThread, false, m_socket, m_options, new Address(m_handle.LocalEndPoint));
-                    session.IncSeqnum();
-                    LaunchChild(session);
+                        // Create and launch a session object.
+                        // TODO: send null in address parameter, is unneeded in this case
+                        SessionBase session = SessionBase.Create(ioThread, false, m_socket, m_options, new Address(m_handle.LocalEndPoint));
+                        session.IncSeqnum();
+                        LaunchChild(session);
 
-                    SendAttach(session, engine, false);
+                        SendAttach(session, engine, false);
 
-                    m_socket.EventAccepted(m_endpoint, acceptedSocket);
+                        m_socket.EventAccepted(m_endpoint, acceptedSocket);
 
-                    Accept();
-                    break;
-                }
+                        Accept();
+                        break;
+                    }
                 case SocketError.ConnectionReset:
                 case SocketError.NoBufferSpaceAvailable:
                 case SocketError.TooManyOpenSockets:
-                {
-                    m_socket.EventAcceptFailed(m_endpoint, socketError.ToErrorCode());
+                    {
+                        m_socket.EventAcceptFailed(m_endpoint, socketError.ToErrorCode());
 
-                    Accept();
-                    break;
-                }
+                        Accept();
+                        break;
+                    }
                 default:
-                {
-                    NetMQException exception = NetMQException.Create(socketError);
+                    {
+                        NetMQException exception = NetMQException.Create(socketError);
 
-                    m_socket.EventAcceptFailed(m_endpoint, exception.ErrorCode);
-                    throw exception;
-                }
+                        m_socket.EventAcceptFailed(m_endpoint, exception.ErrorCode);
+                        throw exception;
+                    }
             }
         }
 

src/NetMQ/Core/Utils/OpCode.cs

@@ -20,7 +20,7 @@ public static bool Open()
             string val = Environment.GetEnvironmentVariable("NETQM_SUPPRESS_RDTSC");
             if (!string.IsNullOrEmpty(val))
                 return false;
-#if NETSTANDARD1_1_OR_GREATER || NET471_OR_GREATER
+#if NET8_0_OR_GREATER || NETSTANDARD1_1_OR_GREATER || NET471_OR_GREATER
             if (RuntimeInformation.ProcessArchitecture != Architecture.X86 &&
                 RuntimeInformation.ProcessArchitecture != Architecture.X64)
             {

src/NetMQ/Core/Utils/SpanUtility.cs

@@ -7,7 +7,7 @@ internal static class SpanUtility
     {
         public static string ToAscii(Span<byte> bytes)
         {
-#if NETSTANDARD2_1
+#if NET8_0_OR_GREATER || NETSTANDARD2_1
             return Encoding.ASCII.GetString(bytes);
 #else
             return Encoding.ASCII.GetString(bytes.ToArray());