IHQueue<T> Interface

Namespace: Hazelcast.DistributedObjects

Assembly: Hazelcast.Net.dll

Defines a concurrent, blocking, distributed, non-partitioned and observable queue.

public interface IHQueue<T> : IHCollection<T>, IDistributedObject, IAsyncDisposable, IAsyncEnumerable<T>

Inherited Members

IHCollection<T>.AddAsync(T)

IHCollection<T>.AddAll<TItem>(ICollection<TItem>)

IHCollection<T>.GetAllAsync()

IHCollection<T>.GetSizeAsync()

IHCollection<T>.IsEmptyAsync()

IHCollection<T>.ContainsAllAsync<TItem>(ICollection<TItem>)

IHCollection<T>.ContainsAsync(T)

IHCollection<T>.RemoveAsync(T)

IHCollection<T>.RemoveAllAsync<TItem>(ICollection<TItem>)

IHCollection<T>.RetainAllAsync<TItem>(ICollection<TItem>)

IHCollection<T>.ClearAsync()

IHCollection<T>.SubscribeAsync(Action<CollectionItemEventHandlers<T>>, bool, object)

IHCollection<T>.UnsubscribeAsync(Guid)

IDistributedObject.ServiceName

IDistributedObject.Name

IDistributedObject.PartitionKey

IDistributedObject.DestroyAsync()

IAsyncDisposable.DisposeAsync()

IAsyncEnumerable<T>.GetAsyncEnumerator(CancellationToken)

Type Parameters

T

Remarks

The Hazelcast IHQueue is not a partitioned data-structure. Entire contents of an IHQueue is stored on a single machine (and in the backup). The IHQueue will not scale by adding more members to the cluster.

Methods

Name	Description
DrainToAsync(ICollection<T>)	Removes all available elements from this queue and adds them to the given collection.
DrainToAsync(ICollection<T>, int)	Removes at most the given number of available elements from this queue and adds them to the given collection.
GetElementAsync()	Retrieves, but does not remove, the head of this queue, or throws if this queue is empty.
GetRemainingCapacityAsync()	Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking, or MaxValue if there is no intrinsic limit.
OfferAsync(T, TimeSpan)	Tries to enqueue an item.
PeekAsync()	Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.
PollAsync(TimeSpan)	Tries to dequeue an item.
PutAsync(T)	Enqueues an item.
TakeAsync()	Dequeues the head item.