Interface IMessageQueue
- Namespace
- StockSharp.Messages
- Assembly
- StockSharp.Messages.dll
Describes a message queue with asynchronous semantics.
public interface IMessageQueue : ICloneable<IMessageQueue>, ICloneable
- Inherited Members
- Extension Methods
Properties
Count
Gets the current number of messages buffered in the queue.
int Count { get; }
Property Value
IsClosed
Gets a value indicating whether the queue is closed.
bool IsClosed { get; }
Property Value
Methods
Clear()
Removes all messages from the queue.
void Clear()
Close()
Closes the queue and prevents new messages from being enqueued.
void Close()
DequeueAsync(CancellationToken)
Removes and returns the next message from the queue asynchronously.
ValueTask<Message> DequeueAsync(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationTokenCancellation token.
Returns
Enqueue(Message, CancellationToken)
Enqueues the specified message.
ValueTask Enqueue(Message message, CancellationToken cancellationToken)
Parameters
messageMessageThe message to enqueue.
cancellationTokenCancellationTokenCancellation token.
Returns
Open()
Opens the queue and allows enqueue and dequeue operations.
void Open()
ReadAllAsync(CancellationToken)
Returns an async enumerable that yields messages from the queue.
IAsyncEnumerable<Message> ReadAllAsync(CancellationToken cancellationToken)
Parameters
cancellationTokenCancellationTokenCancellation token.
Returns
- IAsyncEnumerable<Message>
Async enumerable of messages.