Class Poco::UUIDGenerator

Library: Foundation
Package: UUID
Header: Poco/UUIDGenerator.h

Description

This class implements a generator for Universal Unique Identifiers, as specified in Appendix A of the DCE 1.1 Remote Procedure Call Specification (http://www.opengroup.org/onlinepubs/9629399/), RFC 2518 (WebDAV), section 6.4.1 and the UUIDs and GUIDs internet draft by Leach/Salz from February, 1998 (http://ftp.ics.uci.edu/pub/ietf/webdav/uuid-guid/draft-leach-uuids-guids-01.txt)

Version 6 and 7 UUIDs are based on RFC 9562.

Member Summary

Member Functions: create, createFromName, createOne, createRandom, createV6, createV7, defaultGenerator, seed, timeStamp

Constructors

UUIDGenerator

UUIDGenerator();

Creates the UUIDGenerator.

Destructor

~UUIDGenerator

~UUIDGenerator();

Destroys the UUIDGenerator.

Member Functions

create

UUID create();

Creates a new time-based UUID, using the MAC address of one of the system's ethernet adapters.

Throws a SystemException if no MAC address can be obtained.

createFromName

UUID createFromName(
const UUID & nsid,
const std::string & name
);

Creates a name-based UUID.

createFromName

UUID createFromName(
    const UUID & nsid,
    const std::string & name,
    DigestEngine & de
);

Creates a name-based UUID, using the given digest engine.

Note: in order to create a standard-compliant UUID, the given DigestEngine must be either an instance of MD5Engine or SHA1Engine. The version field of the UUID will be set accordingly.

createFromName

UUID createFromName(
    const UUID & nsid,
    const std::string & name,
    DigestEngine & de,
    UUID::Version version
);

Creates a name-based UUID, using the given digest engine and version.

createOne

UUID createOne();

Tries to create and return a time-based UUID (see create()), and, if that does not work due to the unavailability of a MAC address, creates and returns a random UUID (see createRandom()).

The UUID::version() method can be used to determine the actual kind of the UUID generated.

createRandom

UUID createRandom();

Creates a random UUID.

createV6

UUID createV6();

Creates a time-based version 6 UUID (according to RFC 9562) with a MAC address. If no MAC address is available, a random MAC address will be generated.