mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 11:05:54 +00:00
108 lines
3.7 KiB
C++
108 lines
3.7 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of Beast: https://github.com/vinniefalco/Beast
|
|
Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>
|
|
|
|
Portions of this file are from JUCE.
|
|
Copyright (c) 2013 - Raw Material Software Ltd.
|
|
Please visit http://www.juce.com
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef BEAST_UUID_BEASTHEADER
|
|
#define BEAST_UUID_BEASTHEADER
|
|
|
|
#include "../text/beast_String.h"
|
|
|
|
|
|
//==============================================================================
|
|
/**
|
|
A universally unique 128-bit identifier.
|
|
|
|
This class generates very random unique numbers based on the system time
|
|
and MAC addresses if any are available. It's extremely unlikely that two identical
|
|
UUIDs would ever be created by chance.
|
|
|
|
The class includes methods for saving the ID as a string or as raw binary data.
|
|
*/
|
|
class BEAST_API Uuid : LeakChecked <Uuid>
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a new unique ID. */
|
|
Uuid();
|
|
|
|
/** Destructor. */
|
|
~Uuid() noexcept;
|
|
|
|
/** Creates a copy of another UUID. */
|
|
Uuid (const Uuid& other) noexcept;
|
|
|
|
/** Copies another UUID. */
|
|
Uuid& operator= (const Uuid& other) noexcept;
|
|
|
|
//==============================================================================
|
|
/** Returns true if the ID is zero. */
|
|
bool isNull() const noexcept;
|
|
|
|
bool operator== (const Uuid& other) const noexcept;
|
|
bool operator!= (const Uuid& other) const noexcept;
|
|
|
|
//==============================================================================
|
|
/** Returns a stringified version of this UUID.
|
|
|
|
A Uuid object can later be reconstructed from this string using operator= or
|
|
the constructor that takes a string parameter.
|
|
|
|
@returns a 32 character hex string.
|
|
*/
|
|
String toString() const;
|
|
|
|
/** Creates an ID from an encoded string version.
|
|
@see toString
|
|
*/
|
|
Uuid (const String& uuidString);
|
|
|
|
/** Copies from a stringified UUID.
|
|
The string passed in should be one that was created with the toString() method.
|
|
*/
|
|
Uuid& operator= (const String& uuidString);
|
|
|
|
|
|
//==============================================================================
|
|
/** Returns a pointer to the internal binary representation of the ID.
|
|
|
|
This is an array of 16 bytes. To reconstruct a Uuid from its data, use
|
|
the constructor or operator= method that takes an array of uint8s.
|
|
*/
|
|
const uint8* getRawData() const noexcept { return uuid; }
|
|
|
|
/** Creates a UUID from a 16-byte array.
|
|
@see getRawData
|
|
*/
|
|
Uuid (const uint8* rawData);
|
|
|
|
/** Sets this UUID from 16-bytes of raw data. */
|
|
Uuid& operator= (const uint8* rawData) noexcept;
|
|
|
|
|
|
private:
|
|
//==============================================================================
|
|
uint8 uuid[16];
|
|
};
|
|
|
|
|
|
#endif // BEAST_UUID_BEASTHEADER
|