1. apireference
2. memorystorequeue

RemoveAsync

Parameters

Returns

Code Samples

Using a MemoryStoreQueue

The following code sample demonstrates using MemoryStoreQueue/ReadAsync and MemoryStoreQueue/RemoveAsync to reliably read, process, and remove items from a queue. While the processing code can be as complicated as necessary, in this example we simply set a flag in the corresponding datastore item; it guarantees that every item will eventually be processed even if some of the calls encounter errors or the game server crashes:

• If ReadAsync() fails, no items are retrieved from the queue. An item will be picked up for processing during the next iteration of the loop.
• If ReadAsync() succeeds but DataStoreService/UpdateAsync|ds:UpdateAsync fails, the item will stay invisible until the queue’s invisibility timeout expires, leading to the item becoming visible again to be returned in a future loop iteration.
• Similarly, if RemoveAsync() fails, the item will become visible again in the future and will be processed again.

Note that depending on where the failure happens, it is possible that an item will be processed more than once and the processing code should account for that. It’s not a problem in this sample code since the end result is the same, even if ds:UpdateAsync is invoked multiple times.

-- obtain necessary services and instances
local UMS = game:GetService("MemoryStoreService")
local DSS = game:GetService(“DataStoreService”)
local queue = UMS:GetQueue("PlayerQueue")
local ds = DSS:GetDataStore(“PlayerStore”)

-- main processing loop
while true do
    pcall(function()
        -- wait for an item to process
        local items, id = queue:ReadAsync(1, false, 30)

        -- check if an item was retrieved
        if #items > 0 then
            -- mark the item as processed
            ds:UpdateAsync(items[0], function(data)
                data = data or {}
                data.processed = 1
                return data
            end)

            -- remove the item from the queue
            queue:RemoveAsync(id)
        end
    end)
end