RandomUuid.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_BASE_RANDOMUUID_H
#define SQUID_SRC_BASE_RANDOMUUID_H
 
#include <array>
#include <iosfwd>
 
class RandomUuid
{
public:
    using Serialized = std::array<uint8_t, 128/8>;
 
    RandomUuid();
 
    explicit RandomUuid(const Serialized &);
 
    RandomUuid(RandomUuid &&) = default;
    RandomUuid &operator=(RandomUuid &&) = default;
 
    // (Implicit) public copying is prohibited to prevent accidental duplication
    // of supposed-to-be-unique values. Use clone() when duplication is needed.
    RandomUuid &operator=(const RandomUuid &) = delete;
 
    Serialized serialize() const;
 
    bool operator ==(const RandomUuid &) const;
    bool operator !=(const RandomUuid &other) const { return !(*this == other); }
 
    RandomUuid clone() const { return *this; }
 
    void print(std::ostream &os) const;
 
private:
    RandomUuid(const RandomUuid &) = default;
 
    char *raw() { return reinterpret_cast<char*>(this); }
 
    const char *raw() const { return reinterpret_cast<const char*>(this); }
 
    bool sane() const;
 
    /*
     * These field sizes and names come from RFC 4122 Section 4.1.2. They do not
     * accurately represent the actual UUID version 4 structure which, the six
     * version/variant bits aside, contains just random bits.
     */
    uint32_t timeLow;
    uint16_t timeMid;
    uint16_t timeHiAndVersion;
    uint8_t clockSeqHiAndReserved;
    uint8_t clockSeqLow;
    uint8_t node[6];
};
 
std::ostream &operator<<(std::ostream &os, const RandomUuid &uuid);
 
#endif /* SQUID_SRC_BASE_RANDOMUUID_H */