* Add RoutingKey type and tests.

Author: lukebakken

projects/RabbitMQ.Client/PublicAPI.Unshipped.txt

@@ -692,6 +692,8 @@ RabbitMQ.Client.ReadOnlyBasicProperties.ReplyToAddress.get -> RabbitMQ.Client.Pu
 RabbitMQ.Client.ReadOnlyBasicProperties.Timestamp.get -> RabbitMQ.Client.AmqpTimestamp
 RabbitMQ.Client.ReadOnlyBasicProperties.Type.get -> string
 RabbitMQ.Client.ReadOnlyBasicProperties.UserId.get -> string
+RabbitMQ.Client.RoutingKey
+RabbitMQ.Client.RoutingKey.RoutingKey() -> void
 RabbitMQ.Client.ShutdownEventArgs
 RabbitMQ.Client.ShutdownEventArgs.Cause.get -> object
 RabbitMQ.Client.ShutdownEventArgs.ClassId.get -> ushort
@@ -887,7 +889,8 @@ virtual RabbitMQ.Client.TcpClientAdapter.ReceiveTimeout.set -> void
 ~override RabbitMQ.Client.AmqpString.ToString() -> string
 ~override RabbitMQ.Client.Events.AsyncEventingBasicConsumer.HandleBasicDeliver(string consumerTag, ulong deliveryTag, bool redelivered, System.ReadOnlyMemory<byte> exchange, System.ReadOnlyMemory<byte> routingKey, in RabbitMQ.Client.ReadOnlyBasicProperties properties, System.ReadOnlyMemory<byte> body) -> System.Threading.Tasks.Task
 ~override RabbitMQ.Client.Events.EventingBasicConsumer.HandleBasicDeliverAsync(string consumerTag, ulong deliveryTag, bool redelivered, System.ReadOnlyMemory<byte> exchange, System.ReadOnlyMemory<byte> routingKey, RabbitMQ.Client.ReadOnlyBasicProperties properties, System.ReadOnlyMemory<byte> body) -> System.Threading.Tasks.Task
-~RabbitMQ.Client.AmqpString.AmqpString(string value, ushort maxLen, System.Text.Encoding validEncoding, string validatorRegex) -> void
+~RabbitMQ.Client.AmqpString.AmqpString(string value, ushort maxLen, System.Text.Encoding encoding) -> void
+~RabbitMQ.Client.AmqpString.AmqpString(string value, ushort maxLen, System.Text.Encoding encoding, string validatorRegex) -> void
 ~RabbitMQ.Client.AmqpTcpEndpoint.AmqpTcpEndpoint(string hostName, int portOrMinusOne, RabbitMQ.Client.SslOption ssl, uint maxInboundMessageBodySize) -> void
 ~RabbitMQ.Client.ConnectionFactory.CreateConnectionAsync(RabbitMQ.Client.IEndpointResolver endpointResolver, string clientProvidedName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<RabbitMQ.Client.IConnection>
 ~RabbitMQ.Client.ConnectionFactory.CreateConnectionAsync(string clientProvidedName, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<RabbitMQ.Client.IConnection>
@@ -937,6 +940,7 @@ virtual RabbitMQ.Client.TcpClientAdapter.ReceiveTimeout.set -> void
 ~RabbitMQ.Client.IConnectionFactory.CreateConnectionAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<RabbitMQ.Client.IConnection>
 ~RabbitMQ.Client.ICredentialsRefresher.Register(RabbitMQ.Client.ICredentialsProvider provider, RabbitMQ.Client.ICredentialsRefresher.NotifyCredentialRefreshedAsync callback) -> RabbitMQ.Client.ICredentialsProvider
 ~RabbitMQ.Client.QueueName.QueueName(string exchangeName) -> void
+~RabbitMQ.Client.RoutingKey.RoutingKey(string exchangeName) -> void
 ~RabbitMQ.Client.TimerBasedCredentialRefresher.Register(RabbitMQ.Client.ICredentialsProvider provider, RabbitMQ.Client.ICredentialsRefresher.NotifyCredentialRefreshedAsync callback) -> RabbitMQ.Client.ICredentialsProvider
 ~RabbitMQ.Client.TopologyRecoveryExceptionHandler.BindingRecoveryExceptionHandlerAsync.get -> System.Func<RabbitMQ.Client.IRecordedBinding, System.Exception, RabbitMQ.Client.IConnection, System.Threading.Tasks.Task>
 ~RabbitMQ.Client.TopologyRecoveryExceptionHandler.BindingRecoveryExceptionHandlerAsync.set -> void
@@ -969,7 +973,9 @@ virtual RabbitMQ.Client.TcpClientAdapter.ReceiveTimeout.set -> void
 ~static RabbitMQ.Client.IConnectionExtensions.CloseAsync(this RabbitMQ.Client.IConnection connection, ushort reasonCode, string reasonText) -> System.Threading.Tasks.Task
 ~static RabbitMQ.Client.IConnectionExtensions.CloseAsync(this RabbitMQ.Client.IConnection connection, ushort reasonCode, string reasonText, System.TimeSpan timeout) -> System.Threading.Tasks.Task
 ~static RabbitMQ.Client.QueueName.explicit operator RabbitMQ.Client.QueueName(string value) -> RabbitMQ.Client.QueueName
+~static RabbitMQ.Client.RoutingKey.explicit operator RabbitMQ.Client.RoutingKey(string value) -> RabbitMQ.Client.RoutingKey
 ~static readonly RabbitMQ.Client.ExchangeName.Empty -> RabbitMQ.Client.ExchangeName
 ~static readonly RabbitMQ.Client.QueueName.Empty -> RabbitMQ.Client.QueueName
+~static readonly RabbitMQ.Client.RoutingKey.Empty -> RabbitMQ.Client.RoutingKey
 ~virtual RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleBasicDeliver(string consumerTag, ulong deliveryTag, bool redelivered, System.ReadOnlyMemory<byte> exchange, System.ReadOnlyMemory<byte> routingKey, in RabbitMQ.Client.ReadOnlyBasicProperties properties, System.ReadOnlyMemory<byte> body) -> System.Threading.Tasks.Task
 ~virtual RabbitMQ.Client.DefaultBasicConsumer.HandleBasicDeliverAsync(string consumerTag, ulong deliveryTag, bool redelivered, System.ReadOnlyMemory<byte> exchange, System.ReadOnlyMemory<byte> routingKey, RabbitMQ.Client.ReadOnlyBasicProperties properties, System.ReadOnlyMemory<byte> body) -> System.Threading.Tasks.Task

projects/RabbitMQ.Client/client/api/AmqpString.cs

@@ -46,21 +46,37 @@ public AmqpString()
             _stringBytes = ReadOnlyMemory<byte>.Empty;
         }
 
-        public AmqpString(string value, ushort maxLen, Encoding validEncoding, string validatorRegex)
+        public AmqpString(string value, ushort maxLen, Encoding encoding)
+            : this(value, maxLen, encoding, null)
+        {
+        }
+
+        public AmqpString(string value, ushort maxLen, Encoding encoding, string validatorRegex)
         {
             if (value.Length > maxLen)
             {
                 throw new ArgumentOutOfRangeException(nameof(value));
             }
 
-            var re = new Regex(validatorRegex);
-            if (false == re.IsMatch(value))
+            if (false == string.IsNullOrWhiteSpace(validatorRegex))
             {
-                throw new ArgumentOutOfRangeException(nameof(value));
+                var re = new Regex(validatorRegex);
+                if (false == re.IsMatch(value))
+                {
+                    throw new ArgumentOutOfRangeException(nameof(value));
+                }
+            }
+
+            if (encoding == Encoding.ASCII)
+            {
+                if (false == isAscii(value))
+                {
+                    throw new ArgumentOutOfRangeException(nameof(value));
+                }
             }
 
             _value = value;
-            _stringBytes = new ReadOnlyMemory<byte>(validEncoding.GetBytes(value));
+            _stringBytes = new ReadOnlyMemory<byte>(encoding.GetBytes(value));
         }
 
         public override string ToString()
@@ -77,6 +93,11 @@ public static implicit operator ReadOnlyMemory<byte>(AmqpString amqpString)
         {
             return amqpString._stringBytes;
         }
+
+        private bool isAscii(string value)
+        {
+            return Encoding.UTF8.GetByteCount(value) == value.Length;
+        }
     }
 
     /*
@@ -132,4 +153,30 @@ public static explicit operator QueueName(string value)
             return new QueueName(value);
         }
     }
+
+    /*
+     * From the spec:
+     *  <field name="routing-key" domain="shortstr" label="Message routing key">
+     *    <doc> Specifies the routing key for the message. The routing key is used for routing messages depending on the exchange configuration. </doc>
+     *  </field>
+     *  <domain name = "shortstr" type="shortstr" label="short string (max. 256 characters)"/>
+     */
+    public class RoutingKey : AmqpString
+    {
+        public static readonly RoutingKey Empty = new RoutingKey();
+
+        public RoutingKey() : base()
+        {
+        }
+
+        public RoutingKey(string exchangeName)
+            : base(exchangeName, 256, Encoding.ASCII)
+        {
+        }
+
+        public static explicit operator RoutingKey(string value)
+        {
+            return new RoutingKey(value);
+        }
+    }
 }

projects/Test/Unit/TestAmqpString.cs

@@ -74,5 +74,22 @@ public void TestInvalidQueueNameThrows(string arg)
         {
             Assert.Throws<ArgumentOutOfRangeException>(() => new QueueName(arg));
         }
+
+        [Theory]
+        [InlineData("$key-ABC:123.abc_456*blargh///~~~?")]
+        [InlineData("")]
+        public void TestValidRoutingKeys(string arg)
+        {
+            var e = new RoutingKey(arg);
+            Assert.Equal(e, arg);
+        }
+
+        [Theory]
+        [InlineData("key-Евгений")]
+        [InlineData("O0s5Vu04DVyVSMp8twUjsxa0gjcQ9ixV43U10VDVS6wPTQr14mC2x8cK6fl1G0INoJlCs4v7291iOMlBLj171F09a3VBx4sFc7SKaF683YeG9nn5IQAhQZxDE6grPr20EmHPZpMy3TO3R5aW976WTNVPDzZC5vprruJgaBOh8P9ZKRwc77v2nXUnDcz1t2rX84V8l5deX6V3l0Fv4S0bQzSbGdpD5jiPSZ44yBsZVXtv61saCgu0FNGoFSuV9207s6PiY80XbjBK9nY39R947i2s03cAg261412IS1FzS4uEoJJ6cWZ50P0SJ3S4yqvzx0n4TN4NsROlWyEwaUG4I5Glrj1mI2N28QGbkf5t8Kyo7EavaqME5TrvhPxtJGY1p")]
+        public void TestInvalidRoutingKeyThrows(string arg)
+        {
+            Assert.Throws<ArgumentOutOfRangeException>(() => new RoutingKey(arg));
+        }
     }
 }