BloombergLP::bdlcc::TimeQueue::remove

Remove from this queue the item having the specified handle.

Synopsis

Declared in <bdlcc_timequeue.h>

int
remove(
    Handle handle,
    int* newLength = 0,
    bsls::TimeInterval* newMinTime = 0,
    TimeQueueItem<DATA>* item = 0);

Description

Remove from this queue the item having the specified handle, and optionally load into the optionally specified item the time and data values of the recently removed item. Optionally use the specified key to uniquely identify the item. If specified, load into the optionally specified newMinTime, the resulting lowest time value remaining in the queue. Return 0 on success, and a non‐zero value if no item with the handle exists in the queue. Note that if DATA follows the bdema allocator model, the allocator of the item instance is used to supply memory.

Return Value

0 on success, and a non‐zero value otherwise

Parameters

Name

Description

handle

handle of the item to remove

newLength

if non‐null, receives the new queue length

newMinTime

if non‐null, receives the new minimum time

item

if non‐null, receives the removed item

Created with MrDocs