BloombergLP::bdlcc::TimeQueue::remove

Synopses

Declared in <bdlcc_timequeue.h>

Remove from this queue the item having the specified handle.

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

» more...

Same as the preceding overload, with the specified key.

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

» more...

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
key	key that must also match