src/NMS.AMQP/Transport/TransportContext.cs

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.Collections.Specialized;
using System.Net.Sockets;
using System.Threading.Tasks;
using Amqp;
using Amqp.Framing;
using Amqp.Handler;
using Apache.NMS.AMQP.Provider.Amqp;
using Apache.NMS.AMQP.Util;

namespace Apache.NMS.AMQP.Transport
{

    #region Transport Context

    /// <summary>
    /// Transport management is mainly handled by the AmqpNetLite library, Except for custom transports.
    /// TransportContext should configure the Amqp.ConnectionFactory for the tcp transport properties.
    /// </summary>
    internal class TransportContext : ITransportContext
    {
        protected readonly Amqp.ConnectionFactory connectionBuilder = null;
        
        internal TransportContext()
        {
            connectionBuilder = new Amqp.ConnectionFactory();
            connectionBuilder.SASL.Profile = Amqp.Sasl.SaslProfile.Anonymous;            
        }

        static TransportContext()
        {
            //
            // Set up tracing in AMQP.  We capture all AMQP traces in the TraceListener below
            // and map to NMS 'Tracer' logs as follows:
            //    AMQP          Tracer
            //    Verbose       Debug
            //    Frame         Debug
            //    Information   Info
            //    Output        Info    (should not happen)
            //    Warning       Warn
            //    Error         Error
            //
            Amqp.Trace.TraceLevel = Amqp.TraceLevel.Verbose | Amqp.TraceLevel.Frame;
            Amqp.Trace.TraceListener = (level, format, args) =>
            {
                switch (level)
                {
                    case Amqp.TraceLevel.Verbose:
                    case Amqp.TraceLevel.Frame:
                        Tracer.DebugFormat(format, args);
                        break;
                    case Amqp.TraceLevel.Information:
                    case Amqp.TraceLevel.Output:
                        // 
                        // Applications should not access AmqpLite directly so there
                        // should be no 'Output' level logs.
                        Tracer.InfoFormat(format, args);
                        break;
                    case Amqp.TraceLevel.Warning:
                        Tracer.WarnFormat(format, args);
                        break;
                    case Amqp.TraceLevel.Error:
                        Tracer.ErrorFormat(format, args);
                        break;
                    default:
                        Tracer.InfoFormat("Unknown AMQP LogLevel: {}", level);
                        Tracer.InfoFormat(format, args);
                        break;
                }
            };
        }

        #region Transport Options

        public int ReceiveBufferSize { get => this.connectionBuilder.TCP.ReceiveBufferSize; set => this.connectionBuilder.TCP.ReceiveBufferSize = value; }
        public int ReceiveTimeout { get => this.connectionBuilder.TCP.ReceiveTimeout; set => this.connectionBuilder.TCP.ReceiveTimeout = value; }
        public int SendBufferSize { get => this.connectionBuilder.TCP.SendBufferSize; set => this.connectionBuilder.TCP.SendBufferSize = value; }
        public int SendTimeout { get => this.connectionBuilder.TCP.SendTimeout; set => this.connectionBuilder.TCP.SendTimeout = value; }
        public bool TcpNoDelay { get => this.connectionBuilder.TCP.NoDelay; set => this.connectionBuilder.TCP.NoDelay = value; }
        public uint TcpKeepAliveTime { get => this.connectionBuilder.TCP.KeepAlive.KeepAliveTime; set => this.connectionBuilder.TCP.KeepAlive.KeepAliveTime = value; }
        public uint TcpKeepAliveInterval { get => this.connectionBuilder.TCP.KeepAlive.KeepAliveInterval; set => this.connectionBuilder.TCP.KeepAlive.KeepAliveInterval = value; }

        public bool SocketLingerEnabled
        {
            get => this.connectionBuilder.TCP?.LingerOption.Enabled ?? (this.connectionBuilder.TCP.LingerOption = new LingerOption(false, 0)).Enabled;
            set
            {
                if (this.connectionBuilder.TCP.LingerOption == null)
                {
                    (this.connectionBuilder.TCP.LingerOption = new LingerOption(false, 0)).Enabled = value;
                }
                else
                {
                    this.connectionBuilder.TCP.LingerOption.Enabled = value;
                }
            }
        }

        public int SocketLingerTime
        {
            get => this.connectionBuilder.TCP?.LingerOption.LingerTime ?? (this.connectionBuilder.TCP.LingerOption = new LingerOption(false, 0)).LingerTime;
            set
            {
                if (this.connectionBuilder.TCP.LingerOption == null)
                {
                    (this.connectionBuilder.TCP.LingerOption = new LingerOption(false, 0)).LingerTime = value;
                }
                else
                {
                    this.connectionBuilder.TCP.LingerOption.LingerTime = value;
                }
            }
        }

        /// <summary>
        /// UseLogging Enables AmqpNetLite's Frame logging level.
        /// </summary>
        public bool UseLogging
        {
            get => ((Amqp.Trace.TraceLevel & Amqp.TraceLevel.Frame) == Amqp.TraceLevel.Frame);
            set
            {
                if (value)
                {
                    Amqp.Trace.TraceLevel = Amqp.Trace.TraceLevel | Amqp.TraceLevel.Frame;
                }
                else
                {
                    Amqp.Trace.TraceLevel = Amqp.Trace.TraceLevel & ~Amqp.TraceLevel.Frame;
                }
            }
        }
        
        #endregion

        public virtual bool IsSecure { get; } = false;

        public virtual ITransportContext Copy()
        {
            TransportContext copy = new TransportContext();
            this.CopyInto(copy);
            return copy;
        }

        public virtual Task<Connection> CreateAsync(Address address, IHandler handler)
        {
            return connectionBuilder.CreateAsync(address, handler);    
        }

        protected virtual void CopyInto(TransportContext copy)
        {
            //copy.factory = this.factory;
            //copy.UseLogging = this.UseLogging;
            //Amqp.ConnectionFactory builder = new Amqp.ConnectionFactory();
            //this.CopyBuilder(builder);
            //copy.connectionBuilder = builder;
        }

        protected virtual void CopyBuilder(Amqp.ConnectionFactory copy)
        {
            StringDictionary amqpProperties = PropertyUtil.GetProperties(this.connectionBuilder.AMQP);
            StringDictionary tcpProperties = PropertyUtil.GetProperties(this.connectionBuilder.TCP);
            PropertyUtil.SetProperties(copy.AMQP, amqpProperties);
            PropertyUtil.SetProperties(copy.TCP, tcpProperties);
            copy.SASL.Profile = this.connectionBuilder.SASL.Profile;
        }
    }

    #endregion

}