Expose TCP keep alive settings

Author: Havret

src/ArtemisNetClient/AutoRecovering/AutoRecoveringConnection.cs

@@ -23,6 +23,7 @@ internal class AutoRecoveringConnection : IConnection
         private readonly Func<IMessageIdPolicy> _messageIdPolicyFactory;
         private readonly Func<string> _clientIdFactory;
         private readonly SslSettings _sslSettings;
+        private readonly TcpSettings _tcpSettings;
         private readonly ILogger<AutoRecoveringConnection> _logger;
         private readonly Endpoint[] _endpoints;
         private readonly ChannelReader<ConnectCommand> _reader;
@@ -37,13 +38,15 @@ public AutoRecoveringConnection(ILoggerFactory loggerFactory,
             IRecoveryPolicy recoveryPolicy,
             Func<IMessageIdPolicy> messageIdPolicyFactory,
             Func<string> clientIdFactory,
-            SslSettings sslSettings)
+            SslSettings sslSettings,
+            TcpSettings tcpSettings)
         {
             _logger = loggerFactory.CreateLogger<AutoRecoveringConnection>();
             _loggerFactory = loggerFactory;
             _messageIdPolicyFactory = messageIdPolicyFactory;
             _clientIdFactory = clientIdFactory;
             _sslSettings = sslSettings;
+            _tcpSettings = tcpSettings;
             _endpoints = endpoints.ToArray();
 
             var channel = Channel.CreateUnbounded<ConnectCommand>();
@@ -178,7 +181,7 @@ private Task<IConnection> CreateConnection(CancellationToken cancellationToken)
                 int retryCount = context.GetRetryCount();
                 var endpoint = GetNextEndpoint(retryCount);
                 context.SetEndpoint(endpoint);
-                var connectionBuilder = new ConnectionBuilder(_loggerFactory, _messageIdPolicyFactory, _clientIdFactory, _sslSettings);
+                var connectionBuilder = new ConnectionBuilder(_loggerFactory, _messageIdPolicyFactory, _clientIdFactory, _sslSettings, _tcpSettings);
                 var connection = await connectionBuilder.CreateAsync(endpoint, ct).ConfigureAwait(false);
 
                 if (retryCount > 0)

src/ArtemisNetClient/Builders/ConnectionBuilder.cs

@@ -18,17 +18,20 @@ internal class ConnectionBuilder
         private readonly Func<IMessageIdPolicy> _messageIdPolicyFactory;
         private readonly Func<string> _clientIdFactory;
         private readonly SslSettings _sslSettings;
+        private readonly TcpSettings _tcpSettings;
         private readonly TaskCompletionSource<bool> _tcs;
 
         public ConnectionBuilder(ILoggerFactory loggerFactory,
             Func<IMessageIdPolicy> messageIdPolicyFactory,
             Func<string> clientIdFactory,
-            SslSettings sslSettings)
+            SslSettings sslSettings,
+            TcpSettings tcpSettings)
         {
             _loggerFactory = loggerFactory;
             _messageIdPolicyFactory = messageIdPolicyFactory;
             _clientIdFactory = clientIdFactory;
             _sslSettings = sslSettings;
+            _tcpSettings = tcpSettings;
             _tcs = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
         }
 
@@ -51,6 +54,12 @@ public async Task<IConnection> CreateAsync(Endpoint endpoint, CancellationToken
                 connectionFactory.SSL.LocalCertificateSelectionCallback = _sslSettings.LocalCertificateSelectionCallback;
             }
 
+            if (_tcpSettings != null)
+            {
+                connectionFactory.TCP.KeepAlive.KeepAliveTime = _tcpSettings.KeepAliveTime;
+                connectionFactory.TCP.KeepAlive.KeepAliveInterval = _tcpSettings.KeepAliveInterval;
+            }
+
             try
             {
                 var open = GetOpenFrame(endpoint);

src/ArtemisNetClient/Configuration/TcpSettings.cs

@@ -0,0 +1,18 @@
+namespace ActiveMQ.Artemis.Client;
+
+/// <summary>
+/// Contains the TCP settings of a connection.
+/// </summary>
+public class TcpSettings
+{
+    /// <summary>
+    /// Gets or sets a value in milliseconds that defines how often a keep-alive transmission is sent to an idle connection.
+    /// </summary>
+    public uint KeepAliveTime { get; set; }
+
+    /// <summary>
+    /// Gets or sets a value in milliseconds that defines how often a keep-alive transmission
+    /// is sent when no response is received from previous keep-alive transmissions.
+    /// </summary>
+    public uint KeepAliveInterval { get; set; }
+}

src/ArtemisNetClient/ConnectionFactory.cs

@@ -19,6 +19,7 @@ public class ConnectionFactory
         private Func<IMessageIdPolicy> _messageIdPolicyFactory;
         private Func<string> _clientIdFactory;
         private SslSettings _sslSettings;
+        private TcpSettings _tcpSettings;
 
         public async Task<IConnection> CreateAsync(IEnumerable<Endpoint> endpoints, CancellationToken cancellationToken)
         {
@@ -31,13 +32,21 @@ public async Task<IConnection> CreateAsync(IEnumerable<Endpoint> endpoints, Canc
 
             if (AutomaticRecoveryEnabled)
             {
-                var autoRecoveringConnection = new AutoRecoveringConnection(LoggerFactory, endpointsList, RecoveryPolicy, MessageIdPolicyFactory, ClientIdFactory, _sslSettings);
+                var autoRecoveringConnection = new AutoRecoveringConnection(
+                    LoggerFactory,
+                    endpointsList,
+                    RecoveryPolicy,
+                    MessageIdPolicyFactory,
+                    ClientIdFactory,
+                    _sslSettings,
+                    _tcpSettings
+                );
                 await autoRecoveringConnection.InitAsync(cancellationToken).ConfigureAwait(false);
                 return autoRecoveringConnection;
             }
             else
             {
-                var connectionBuilder = new ConnectionBuilder(LoggerFactory, MessageIdPolicyFactory, ClientIdFactory, _sslSettings);
+                var connectionBuilder = new ConnectionBuilder(LoggerFactory, MessageIdPolicyFactory, ClientIdFactory, _sslSettings, _tcpSettings);
                 return await connectionBuilder.CreateAsync(endpointsList.First(), cancellationToken).ConfigureAwait(false);
             }
         }
@@ -69,5 +78,10 @@ public Func<string> ClientIdFactory
         /// Gets the SASL settings on the factory.
         /// </summary>
         public SslSettings SSL => _sslSettings ??= new SslSettings();
+
+        /// <summary>
+        /// Gets the TCP settings on the factory.
+        /// </summary>
+        public TcpSettings TCP => _tcpSettings ??= new TcpSettings();
     }
 }