IQueueT InterfaceHazelcast .Net Client Class Library
Concurrent, blocking, distributed, observable queue.

Namespace: Hazelcast.Core
Assembly: Hazelcast.Net (in Hazelcast.Net.dll) Version: 3.5.0.6
Syntax

public interface IQueue<T> : IHCollection<T>, 
	ICollection<T>, IEnumerable<T>, IEnumerable, IDistributedObject

Type Parameters

T

The IQueueT type exposes the following members.

Methods

  NameDescription
Public methodAdd(T)
Adds the specified item.
(Inherited from IHCollectionT.)
Public methodAdd(T) (Inherited from ICollectionT.)
Public methodAddAllTE
Adds all.
(Inherited from IHCollectionT.)
Public methodAddItemListener
Adds an item listener for this collection.
(Inherited from IHCollectionT.)
Public methodClear (Inherited from ICollectionT.)
Public methodContains(T) (Inherited from ICollectionT.)
Public methodContains(Object)
Public methodContainsAllTE
Determines whether this collection contains all of the elements in the specified collection.
(Inherited from IHCollectionT.)
Public methodCopyTo (Inherited from ICollectionT.)
Public methodDestroy
Destroys this object cluster-wide.
(Inherited from IDistributedObject.)
Public methodDrainToTE(ICollectionTE)
Removes all available elements from this queue and adds them to the given collection. This operation may be more efficient than repeatedly polling this queue. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
Public methodDrainToTE(ICollectionTE, Int32)
Removes at most the given number of available elements from this queue and adds them to the given collection. A failure encountered while attempting to add elements to collection c may result in elements being in neither, either or both collections when the associated exception is thrown. Attempts to drain a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.
Public methodElement
Retrieves, but does not remove, the head of this queue. This method differs from Peek only in that it throws an exception if this queue is empty.
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
(Inherited from IEnumerableT.)
Public methodGetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from IEnumerable.)
Public methodGetName
Returns the unique name for this IDistributedObject.
(Inherited from IDistributedObject.)
Public methodGetPartitionKey
Returns the key of partition this IDistributedObject is assigned to.
(Inherited from IDistributedObject.)
Public methodGetServiceName
Returns the service name for this object.
(Inherited from IDistributedObject.)
Public methodIsEmpty
Determines whether this instance is empty.
(Inherited from IHCollectionT.)
Public methodOffer(T)
Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available.
Public methodOffer(T, Int64, TimeUnit)
Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.
Public methodPeek
Public methodPoll
Retrieves and removes the head of this queue, or returns null if this queue is empty.
Public methodPoll(Int64, TimeUnit)
Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.
Public methodPut
Inserts the specified element into this queue, waiting if necessary for space to become available.
Public methodRemainingCapacity
Returns the number of additional elements that this queue can ideally (in the absence of memory or resource constraints) accept without blocking, or Int64.MaxValue if there is no intrinsic limit.

Note that you cannot always tell if an attempt to insert an element will succeed by inspecting remainingCapacity because it may be the case that another thread is about to insert or remove an element.

Public methodRemove
Retrieves and removes the head of this queue. This method differs from Poll only in that it throws an exception if this queue is empty.
Public methodRemove(T) (Inherited from ICollectionT.)
Public methodRemove(Object)
Removes a single instance of the specified element from this queue, if it is present
Public methodRemoveAllTE
Removes all of the elements in the specified collection from this collection.
(Inherited from IHCollectionT.)
Public methodRemoveItemListener
Removes the specified item listener.
(Inherited from IHCollectionT.)
Public methodRetainAllTE
Retains only the elements in this collection that are contained in the specified collection (optional operation).
(Inherited from IHCollectionT.)
Public methodSize
Gets the number of elements contained in the collection.
(Inherited from IHCollectionT.)
Public methodTake
Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.
Public methodToArray
Returns an array containing all of the elements in this collection.
(Inherited from IHCollectionT.)
Public methodToArrayTE(TE)
Returns an array containing all of the elements in this collection the runtime type of the returned array is that of the specified array
(Inherited from IHCollectionT.)
Top
Properties

  NameDescription
Public propertyCount (Inherited from ICollectionT.)
Public propertyIsReadOnly (Inherited from ICollectionT.)
Top
See Also

Reference