Interface IQueue<E>

Concurrent, distributed, observable queue.

Methods that require serialization/deserialization may throw RangeError, e.g when there is no suitable serializer for a certain type.

Type Parameters

E

Hierarchy

DistributedObject
- IQueue

Methods

add

add(item: E): Promise<boolean>
Adds given item to the end of the queue. Operation is successful only if queue has required capacity.

Throws
IllegalStateError if queue is full.

Returns
true.
Parameters
- item: E
  
  element to add.
Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:34

addAll

addAll(items: E[]): Promise<boolean>
Adds all items in the specified item array to this queue. If items array changes during this operation, behaviour is unspecified.

Returns
true if this queue changed, false otherwise.
Parameters
- items: E[]
  
  items to be added.
Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:42

addItemListener

addItemListener(listener: ItemListener<E>, includeValue: boolean): Promise<string>
Adds an item listener for this queue. Listener will be invoked for any add/remove item events.

Returns
Registration id of the listener.
Parameters
- listener: ItemListener<E>
- includeValue: boolean
  
  true if updated item should be included in the event.
Returns Promise<string>
- Defined in src/proxy/IQueue.ts:51

clear

clear(): Promise<void>
Removes all of the elements in this queue.

Returns Promise<void>
- Defined in src/proxy/IQueue.ts:56

contains

contains(item: E): Promise<boolean>
Returns true if this queue contains the given item.

Returns
true if this queue contains the item, false otherwise.
Parameters
- item: E
Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:63

containsAll

containsAll(items: E[]): Promise<boolean>
Checks if this queue contains all of the items in given array.

Returns
true if thi queue contains all items, false otherwise.
Parameters
- items: E[]
Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:70

destroy

destroy(): Promise<void>
Destroys this object cluster-wide. Clears all resources taken for this object.

Returns Promise<void>
Inherited from DistributedObject.destroy
- Defined in src/core/DistributedObject.ts:43

drainTo

drainTo(arr: E[], maxElements?: number): Promise<number>
Removes all items in this queue and add them to the end of given arr.

Returns
number of items moved from this queue to the array.
Parameters
- arr: E[]
- Optional maxElements: number
  
  maximum number of elements that would be moved.
Returns Promise<number>
- Defined in src/proxy/IQueue.ts:78

getName

getName(): string
Returns the unique name of this object.

Returns string
Inherited from DistributedObject.getName
- Defined in src/core/DistributedObject.ts:32

getPartitionKey

getPartitionKey(): string
Returns the key of the partition that this DistributedObject is assigned to. For a partitioned data structure, the returned value will not be null, but otherwise undefined.

Returns string
Inherited from DistributedObject.getPartitionKey
- Defined in src/core/DistributedObject.ts:27

getServiceName

getServiceName(): string
Returns the service name for this object.

Returns string
Inherited from DistributedObject.getServiceName
- Defined in src/core/DistributedObject.ts:37

isEmpty

isEmpty(): Promise<boolean>
Checks if this queue contains any element.

Returns
true if number of elements in this queue is 0.

Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:84

offer

offer(item: E, time?: number): Promise<boolean>
Inserts given item at the end of the queue if there is room. If queue capacity is full, offer operation fails.

Returns
true if the item is successfully added, false otherwise.
Parameters
- item: E
- Optional time: number
  
  if specified, operation waits for time milliseconds for space to become available before returning false.
Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:94

peek

peek(): Promise<E>
Retrieves, but does not remove the head of this queue.

Returns
the head of this queue or null if the queue is empty.

Returns Promise<E>
- Defined in src/proxy/IQueue.ts:100

poll

poll(time?: number): Promise<E>
Retrieves and removes the top of this queue.

Returns
the head of this queue or null if no element is available.
Parameters
- Optional time: number
  
  operation waits upto time milliseconds if this queue is empty. The default value of this parameter is 0, which means no waiting.
Returns Promise<E>
- Defined in src/proxy/IQueue.ts:108

put

put(item: E): Promise<void>
Inserts the item at the end of this queue. It waits to return until space becomes available if necessary.
Parameters
- item: E
Returns Promise<void>
- Defined in src/proxy/IQueue.ts:115

remainingCapacity

remainingCapacity(): Promise<number>
Returns the number of additional items, this queue can contain.

Returns
remaining capacity or Integer.MAX_VALUE at server side.

Returns Promise<number>
- Defined in src/proxy/IQueue.ts:121

remove

remove(item: E): Promise<boolean>
Removes an instance of given item from this queue.

Returns
true if this queue changed, false otherwise.
Parameters
- item: E
Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:127

removeAll

removeAll(items: E[]): Promise<boolean>
Removes all items in given items from this queue.

Returns
true if this queue changed, false otherwise.
Parameters
- items: E[]
Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:134

removeItemListener

removeItemListener(registrationId: string): Promise<boolean>
Removes an item listener for this queue.

Returns
true if the item listener is removed, false otherwise.
Parameters
- registrationId: string
  
  Registration id of the listener to be removed.
Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:141

retainAll

retainAll(items: E[]): Promise<boolean>
Retains only the items that are present it given items.

Returns
true if this queue changed, false otherwise.
Parameters
- items: E[]
Returns Promise<boolean>
- Defined in src/proxy/IQueue.ts:148

size

size(): Promise<number>
Returns the number of items in this queue.

Returns
number of items or Integer.MAX_VALUE if number of elements is more than Integer.MAX_VALUE on server side.

Returns Promise<number>
- Defined in src/proxy/IQueue.ts:155

take

take(): Promise<E>
Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

Returns
head of the queue.

Returns Promise<E>
- Defined in src/proxy/IQueue.ts:162

toArray

toArray(): Promise<E[]>
Returns an array that contains all items of this queue in proper sequence.

Returns Promise<E[]>
- Defined in src/proxy/IQueue.ts:167

Generated using TypeDoc