snapshot()

template<typename T , typename StoragePolicy , typename ConcurrencyPolicy = SingleThreadedPolicy, typename AccessPattern = QueueAccess>

std::vector< T > MayaFlux::Memory::RingBuffer< T, StoragePolicy, ConcurrencyPolicy, AccessPattern >::snapshot ( ) const

inline

Thread-safe snapshot of buffer contents.

Returns

Vector copy ordered by AccessPattern

Safe for lock-free contexts but allocates memory. For LockFreePolicy, provides consistent view despite concurrent access.

Not Real-time Safe: Allocates std::vector.

For MPSCPolicy, returns an empty vector. Use pop() to drain instead; a slot-by-slot index walk is not safe while producers are active.

// Lock-free queue
LockFreeQueue<Event, 1024> queue;
auto events = queue.snapshot();  // Safe despite concurrent push
 
for (const auto& event : events) {
    write_to_disk(event);  // Can block safely
}

Definition at line 1003 of file RingBuffer.hpp.

    {
        std::vector<T> result;
 
        if constexpr (is_mpsc) {
            // snapshot() is not defined for MPSC - ready flags make a consistent
            // index-walk impossible without stopping producers. Use pop() to drain.
            return result;
        } else if constexpr (is_lock_free) {
            const size_t cap = m_storage.capacity();
            auto read = m_state.read_index.load(std::memory_order_acquire);
            auto write = m_state.write_index.load(std::memory_order_acquire);
 
            result.reserve(cap);
            while (read != write) {
                result.push_back(m_storage.buffer[read]);
                read = State::increment(read, cap);
            }
        } else {
            auto view = linearized_view();
            result.assign(view.begin(), view.end());
        }
 
        return result;
    }

References MayaFlux::Memory::RingBuffer< T, StoragePolicy, ConcurrencyPolicy, AccessPattern >::is_lock_free, MayaFlux::Memory::RingBuffer< T, StoragePolicy, ConcurrencyPolicy, AccessPattern >::is_mpsc, MayaFlux::Memory::RingBuffer< T, StoragePolicy, ConcurrencyPolicy, AccessPattern >::linearized_view(), MayaFlux::Memory::RingBuffer< T, StoragePolicy, ConcurrencyPolicy, AccessPattern >::m_state, and MayaFlux::Memory::RingBuffer< T, StoragePolicy, ConcurrencyPolicy, AccessPattern >::m_storage.

Referenced by MayaFlux::Memory::RingBuffer< T, StoragePolicy, ConcurrencyPolicy, AccessPattern >::resize().

Here is the call graph for this function:

Here is the caller graph for this function: