Page.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_IPC_MEM_PAGE_H
#define SQUID_SRC_IPC_MEM_PAGE_H
 
#include "ipc/mem/forward.h"
 
#include <iosfwd>
 
namespace Ipc
{
 
namespace Mem
{
 
class PageId
{
public:
    PageId(): pool(0), number(0), purpose(maxPurpose) {}
 
    bool set() const { return pool && number; }
 
    // safer than bool which would enable silent casts to int
    typedef const uint32_t PageId::*SaferBool;
    operator SaferBool() const { return set() ? &PageId::number : nullptr; }
 
    PoolId pool;
 
    // uint32_t segment; ///< memory segment ID within the pool; unused for now
    uint32_t number; 
 
    enum Purpose { cachePage, ioPage, maxPurpose };
    Purpose purpose; 
};
 
std::ostream &operator <<(std::ostream &os, const PageId &page);
 
} // namespace Mem
 
} // namespace Ipc
 
#endif /* SQUID_SRC_IPC_MEM_PAGE_H */