TLazThreadedQueue.PushItem function

Declaration

function PushItem(const AItem: T): TWaitResult

Description

PushItem is a TWaitResult function used to add the item specified in AItem to the thread-safe queue.

PushItem uses the value in the internal PushTimeout member to determine if a timeout is in effect for the enqueue request. When PushTimeout contains INFINITE, a timeout is not used for the operation. Instead, the request waits for an RTL Event that indicates room is available in the internal storage for the queue.

When PushTimeout contains 0, the request will timeout after the first failed attempt to add the specified item to the queue.

When ShutDown contains True, the return value is updated to indicate that the request should be abandoned.

The return value contains a TWaitResult enumeration value that indicates the status for the enqueue request. See TWaitResult for more information about enumeration values and their meanings.

See also

• ShutDown
• TWaitResult
• RTLEventWaitFor