G3D::GUniqueID Class Reference

#include <GUniqueID.h>

Public Member Functions
	GUniqueID ()
GUniqueID &	operator= (const Any &a)
	GUniqueID (const Any &a)
Any	toAny () const
std::string	toString16 () const
bool	uninitialized () const
uint16	tag () const
	operator uint64 () const
bool	operator== (const GUniqueID &other) const
bool	operator!= (const GUniqueID &other) const
void	serialize (class BinaryOutput &b) const
void	deserialize (class BinaryInput &b)
void	serialize (class TextOutput &t) const
void	deserialize (class TextInput &t)

Static Public Member Functions
static GUniqueID	fromString16 (const std::string &s)
static GUniqueID	NONE (uint16 tag)
static GUniqueID	create (uint16 tag=0)

Private Attributes
uint64	id

Detailed Description

Globally unique identifiers. The probability of two different programs generating the same value from UniqueID::create is vanishingly small.

UniqueIDs optionally contain a 10-bit application specific tag that distinguishes their type.

Constructor & Destructor Documentation

G3D::GUniqueID::GUniqueID ( )

inline

See also

create

: id(0) {}

Here is the caller graph for this function:

G3D::GUniqueID::GUniqueID ( const Any &  a )

inline

See also

create

 {
 *this = a;
 }

Member Function Documentation

GUniqueID G3D::GUniqueID::create ( uint16  tag = 0 )

static

Create a new ID

 {
 static uint64 counter = 0;
 static uint64 systemID = 0;
 
 if (systemID == 0) {
 // Create a unique ID for this machine/program instance
 
 // TODO: see ioctl(skfd, SIOCGIFHWADDR, &if_hwaddr)
 Array<NetAddress> addr;
 NetworkDevice::instance()->localHostAddresses(addr);
 if (addr.size() > 0) {
 systemID |= addr[0].ip();
 }
 
 union {
 float64 ft;
 uint64 ut;
 };
 ft = System::time();
 systemID = ut << 22;
 systemID ^= ((uint64)iRandom(0, 32768)) << 8;
 
 systemID &= ~((uint64)1023 << 54);

 // Ensure that the systemID is non-zero (vanishingly small probability)
 if (systemID == 0) {
 systemID = 1;
 }
 }
 
 // No need for modulo; we'll all be dead before this counter
 // overflows 54 bits
 ++counter;
 
 GUniqueID i;
 
 i.id = (((uint64)(tag & 1023)) << 54) | (counter ^ systemID);
 
 return i;
}

Here is the call graph for this function:

void G3D::GUniqueID::deserialize

(

class BinaryInput &

b

)

 {
 id = b.readUInt64();
}

Here is the call graph for this function:

void G3D::GUniqueID::deserialize

(

class TextInput &

t

)

 {
 t.readSymbol("(");
 id = (((uint64)t.readNumber()) << 32) + (uint64)t.readNumber();
 t.readSymbol(")");
}

Here is the call graph for this function:

GUniqueID G3D::GUniqueID::fromString16 ( const std::string &  s )

static

 {
 if (s.length() != 16) {
 debugAssertM(false, "Corrupt 16-character string");
 return GUniqueID();
 }
 
 uint32 high = 0, low = 0;
 sscanf(s.c_str(), "%08x%08x", &high, &low);
 GUniqueID i;
 i.id = (uint64(high) << 32) | low;
 return i;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GUniqueID G3D::GUniqueID::NONE ( uint16  tag )

static

Returns the ID that has the specified tag (so that it is not uninitialized), but which is a common sentinel "none" value.

 {
 GUniqueID i;
 uint64 t = tag;
 i.id = (t << 54);
 return i;
}

Here is the call graph for this function:

G3D::GUniqueID::operator uint64 ( ) const

inline

 {
 return id;
 } 

bool G3D::GUniqueID::operator!= ( const GUniqueID &  other ) const

inline

 {
 return id != other.id;
 }

GUniqueID & G3D::GUniqueID::operator=

(

const Any &

a

)

 {
 a.verifyName("GUniqueID");
 a.verifyType(Any::ARRAY);
 a.verifySize(1);
 std::string s = a[0];
 a.verify(s.length() == 16);
 id = GUniqueID::fromString16(s);
 return *this;
}

Here is the call graph for this function:

bool G3D::GUniqueID::operator== ( const GUniqueID &  other ) const

inline

 {
 return id == other.id;
 }

void G3D::GUniqueID::serialize

(

class BinaryOutput &

b

)

const

 {
 b.writeUInt64(id);
}

Here is the call graph for this function:

void G3D::GUniqueID::serialize

(

class TextOutput &

t

)

const

 {
 t.writeSymbol("(");
 t.writeNumber((double)(id >> 32));
 t.writeNumber((double)(id & 0xFFFFFFFF));
 t.writeSymbol(")");
}

Here is the call graph for this function:

uint16 G3D::GUniqueID::tag ( ) const

inline

 {
 return id >> 54;
 }

Here is the caller graph for this function:

Any G3D::GUniqueID::toAny

(

)

const

 {
 Any a(Any::ARRAY, "GUniqueID");
 a.append(toString16());
 return a;
}

Here is the call graph for this function:

std::string G3D::GUniqueID::toString16

(

)

const

Returns a 16-character string equivalent to this GUniqueID's uint64 value.

 {
 return format("%08x%08x", uint32(id >> 32), uint32(id & 0xFFFFFFFF));
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool G3D::GUniqueID::uninitialized ( ) const

inline

 {
 return id == 0;
 }

Member Data Documentation

uint64 G3D::GUniqueID::id

private

---

The documentation for this class was generated from the following files:

• dep/g3dlite/include/G3D/GUniqueID.h
• dep/g3dlite/source/GUniqueID.cpp