Commit d7789b4e authored by Marc Gravell's avatar Marc Gravell

tidy up documentation around ChannelMessageQueue

parent c6af6cf0
......@@ -30,6 +30,7 @@ internal ChannelMessage(RedisChannel channel, RedisValue value)
/// <summary>
/// Represents a message queue of pub/sub notifications
/// </summary>
/// <remarks>To create a ChannelMessageQueue, use ISubscriber.Subscribe[Async](RedisKey)</remarks>
public sealed class ChannelMessageQueue
{
private readonly Channel<ChannelMessage> _channel;
......
......@@ -258,7 +258,7 @@ public int ConnectTimeout
/// <summary>
/// Specifies whether asynchronous operations should be invoked in a way that guarantees their original delivery order
/// </summary>
[Obsolete("Not supported; attempting to guarantee delivery order is consistently a cause of major performance problems", false)]
[Obsolete("Not supported; if you require ordered pub/sub, please see " + nameof(ChannelMessageQueue), false)]
public bool PreserveAsyncOrder
{
get { return preserveAsyncOrder.GetValueOrDefault(true); }
......
......@@ -1809,7 +1809,7 @@ public override string ToString()
/// <summary>
/// Gets or sets whether asynchronous operations should be invoked in a way that guarantees their original delivery order
/// </summary>
[Obsolete("Not supported; attempting to guarantee delivery order is consistently a cause of major performance problems", false)]
[Obsolete("Not supported; if you require ordered pub/sub, please see " + nameof(ChannelMessageQueue), false)]
public bool PreserveAsyncOrder
{
get => false;
......
......@@ -44,7 +44,7 @@ public interface IConnectionMultiplexer
/// <summary>
/// Gets or sets whether asynchronous operations should be invoked in a way that guarantees their original delivery order
/// </summary>
[Obsolete("Not supported; attempting to guarantee delivery order is consistently a cause of major performance problems", false)]
[Obsolete("Not supported; if you require ordered pub/sub, please see " + nameof(ChannelMessageQueue), false)]
bool PreserveAsyncOrder { get; set; }
/// <summary>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment