diff options
Diffstat (limited to 'ace/UUID.h')
| -rw-r--r-- | ace/UUID.h | 310 |
1 files changed, 155 insertions, 155 deletions
diff --git a/ace/UUID.h b/ace/UUID.h index 4fb1850cc03..ce69d6c7a81 100644 --- a/ace/UUID.h +++ b/ace/UUID.h @@ -12,221 +12,221 @@ #ifndef ACE_UUID_H #define ACE_UUID_H - #include /**/ "ace/pre.h" + #include "ace/OS.h" + +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + #include "ace/SString.h" #include "ace/Singleton.h" #include "ace/Synch.h" -/// Class to hold a MAC address -class ACE_Export UUID_node +namespace ACE_Utils { - public: + /// Class to hold a MAC address + class ACE_Export UUID_node + { + public: - /// Constructor - UUID_node (void); + /// Constructor + UUID_node (void); - enum {NODE_ID_SIZE = 6}; - typedef u_char NodeID[NODE_ID_SIZE]; + enum {NODE_ID_SIZE = 6}; + typedef u_char NodeID[NODE_ID_SIZE]; - NodeID& nodeID (void); - void nodeID (NodeID&); + NodeID& nodeID (void); + void nodeID (NodeID&); - /// Assignment Operation - UUID_node &operator=(const UUID_node &right); + /// Assignment Operation + UUID_node &operator=(const UUID_node &right); - /// Equality Operations - bool operator == (const UUID_node& right) const; - bool operator != (const UUID_node& right) const; + /// Equality Operations + bool operator == (const UUID_node& right) const; + bool operator != (const UUID_node& right) const; - /// Relational Operations - bool operator < (const UUID_node& right) const; + /// Relational Operations + bool operator < (const UUID_node& right) const; - private: - NodeID nodeID_; -}; + private: + NodeID nodeID_; + }; -/** - * @class ACE_UUID - * - * ACE_UUID represents a Universally Unique IDentifier (UUID) as - * described in (the expired) INTERNET-DRAFT specification entitled - * UUIDs and GUIDs. All instances of UUID are of the time-based - * variety. That is, the version number part of the timeHiAndVersion - * field is 1. - * - * The default constructor creates a nil UUID. - * - * UUIDs have value semantics. In addition, they may be compared for - * ordering and equality. - * - * Additionally in this implementation provisions have been made to include - * process and thread ids to make the UUIDs more unique. The variant 0xc0 - * has been added to facilitate this. - */ -class ACE_Export ACE_UUID -{ - public: - /// Constructor - ACE_UUID(void); + /** + * @class ACE_UUID + * + * ACE_UUID represents a Universally Unique IDentifier (UUID) as + * described in (the expired) INTERNET-DRAFT specification entitled + * UUIDs and GUIDs. All instances of UUID are of the time-based + * variety. That is, the version number part of the timeHiAndVersion + * field is 1. + * + * The default constructor creates a nil UUID. + * + * UUIDs have value semantics. In addition, they may be compared for + * ordering and equality. + * + * Additionally in this implementation provisions have been made to include + * process and thread ids to make the UUIDs more unique. The variant 0xc0 + * has been added to facilitate this. + */ + class ACE_Export UUID + { + public: - /// Copy constructor - ACE_UUID(const ACE_UUID &right); + /// Constructor + UUID (void); - /// Constructs a UUID from a string representation. - ACE_UUID (const ACE_CString& uuidString); + /// Copy constructor + UUID (const UUID &right); - // Destructor - ~ACE_UUID (void); + /// Constructs a UUID from a string representation. + UUID (const ACE_CString& uuidString); - ACE_UINT32 timeLow (void); - void timeLow (ACE_UINT32); + // Destructor + ~UUID (void); - ACE_UINT16 timeMid (void); - void timeMid (ACE_UINT16); + ACE_UINT32 timeLow (void); + void timeLow (ACE_UINT32); - ACE_UINT16 timeHiAndVersion (void); - void timeHiAndVersion (ACE_UINT16); + ACE_UINT16 timeMid (void); + void timeMid (ACE_UINT16); - u_char clockSeqHiAndReserved (void); - void clockSeqHiAndReserved (u_char); + ACE_UINT16 timeHiAndVersion (void); + void timeHiAndVersion (ACE_UINT16); - u_char clockSeqLow (void); - void clockSeqLow (u_char); + u_char clockSeqHiAndReserved (void); + void clockSeqHiAndReserved (u_char); - UUID_node* node (void); - void node (UUID_node*); + u_char clockSeqLow (void); + void clockSeqLow (u_char); - ACE_CString* thr_id (void); - void thr_id (char*); + UUID_node* node (void); + void node (UUID_node*); - ACE_CString* pid (void); - void pid (char*); + ACE_CString* thr_id (void); + void thr_id (char*); - /// Returns a string representation of the UUID - const ACE_CString* to_string (void); + ACE_CString* pid (void); + void pid (char*); - static ACE_UUID NIL_UUID; + /// Returns a string representation of the UUID + const ACE_CString* to_string (void); - /// Assignment Operation - ACE_UUID & operator=(const ACE_UUID &right); + static UUID NIL_UUID; - /// Equality Operations - bool operator==(const ACE_UUID &right) const; - bool operator!=(const ACE_UUID &right) const; + /// Assignment Operation + UUID & operator= (const UUID &right); - /// Relational Operations - bool operator< (const ACE_UUID &right) const; - bool operator> (const ACE_UUID &right) const; - bool operator<=(const ACE_UUID &right) const; - bool operator>=(const ACE_UUID &right) const; + /// Equality Operations + bool operator== (const UUID &right) const; + bool operator!= (const UUID &right) const; - private: + /// Relational Operations + bool operator< (const UUID &right) const; + bool operator> (const UUID &right) const; + bool operator<= (const UUID &right) const; + bool operator>= (const UUID &right) const; - /// Data Members for Class Attributes - ACE_UINT32 timeLow_; - ACE_UINT16 timeMid_; - ACE_UINT16 timeHiAndVersion_; - u_char clockSeqHiAndReserved_; - u_char clockSeqLow_; - UUID_node* node_; - int node_release_; - ACE_CString thr_id_; - ACE_CString pid_; + private: - /// The string representation of the UUID. This is created and - /// updated only on demand. - ACE_CString *as_string_; -}; + /// Data Members for Class Attributes + ACE_UINT32 timeLow_; + ACE_UINT16 timeMid_; + ACE_UINT16 timeHiAndVersion_; + u_char clockSeqHiAndReserved_; + u_char clockSeqLow_; + UUID_node* node_; + int node_release_; + ACE_CString thr_id_; + ACE_CString pid_; + /// The string representation of the UUID. This is created and + /// updated only on demand. + ACE_CString *as_string_; + }; -/** - * @class ACE_UUID_Generator - * - * Singleton class that generates UUIDs. - * - */ -class ACE_Export ACE_UUID_Generator -{ - public: - enum {ACE_UUID_CLOCK_SEQ_MASK = 0x3FFF}; + /** + * @class ACE_UUID_Generator + * + * Singleton class that generates UUIDs. + * + */ + class ACE_Export UUID_Generator + { + public: - ACE_UUID_Generator(); - ~ACE_UUID_Generator(); + enum {ACE_UUID_CLOCK_SEQ_MASK = 0x3FFF}; - void init (void); + UUID_Generator(); + ~UUID_Generator(); - /// Format timestamp, clockseq, and nodeID into an UUID of the - /// specified version and variant. For generating UUID's with - /// thread and process ids use variant=0xc0 - void generateUUID(ACE_UUID&, ACE_UINT16 version=0x0001, u_char variant=0x80); + void init (void); - /// Format timestamp, clockseq, and nodeID into a VI UUID. For - /// generating UUID's with thread and process ids use variant=0xc0 - ACE_UUID* generateUUID (ACE_UINT16 version=0x0001, u_char variant=0x80); + /// Format timestamp, clockseq, and nodeID into an UUID of the + /// specified version and variant. For generating UUID's with + /// thread and process ids use variant=0xc0 + void generateUUID (UUID&, ACE_UINT16 version=0x0001, u_char variant=0x80); - /// Type to represent UTC as a count of 100 nanosecond intervals - /// since 00:00:00.00, 15 October 1582. - typedef ACE_UINT64 UUID_time; + /// Format timestamp, clockseq, and nodeID into a VI UUID. For + /// generating UUID's with thread and process ids use variant=0xc0 + UUID* generateUUID (ACE_UINT16 version=0x0001, u_char variant=0x80); - /// The locking strategy prevents multiple generators from accessing - /// the UUID_state at the same time. Get the locking strategy. - ACE_SYNCH_MUTEX* lock (void); + /// Type to represent UTC as a count of 100 nanosecond intervals + /// since 00:00:00.00, 15 October 1582. + typedef ACE_UINT64 UUID_time; - /// Set a new locking strategy and return the old one. - ACE_SYNCH_MUTEX* lock (ACE_SYNCH_MUTEX*lock, - int release_lock); + /// The locking strategy prevents multiple generators from accessing + /// the UUID_state at the same time. Get the locking strategy. + ACE_SYNCH_MUTEX* lock (void); + /// Set a new locking strategy and return the old one. + ACE_SYNCH_MUTEX* lock (ACE_SYNCH_MUTEX*lock, + int release_lock); - private: - /// The system time when that last uuid was generated. - UUID_time timeLast_; + private: - /// Type to contain the UUID generator persistent state. This will - /// be kept in memory mapped shared memory - struct UUID_State - { - UUID_time timestamp; - UUID_node node; - ACE_UINT16 clockSequence; - }; + /// The system time when that last uuid was generated. + UUID_time timeLast_; - /// Obtain a UUID timestamp. Compensate for the fact that the time - /// obtained from getSystem time has a resolution less than 100ns. + /// Type to contain the UUID generator persistent state. This will + /// be kept in memory mapped shared memory + struct UUID_State + { + UUID_time timestamp; + UUID_node node; + ACE_UINT16 clockSequence; + }; + + /// Obtain a UUID timestamp. Compensate for the fact that the time + /// obtained from getSystem time has a resolution less than 100ns. void get_timestamp (UUID_time& timestamp); - /// Obtain the system time in UTC as a count of 100 nanosecond intervals - /// since 00:00:00.00, 15 October 1582 (the date of Gregorian reform to + /// Obtain the system time in UTC as a count of 100 nanosecond intervals + /// since 00:00:00.00, 15 October 1582 (the date of Gregorian reform to /// the Christian calendar). - void get_systemtime( UUID_time& timeNow); + void get_systemtime( UUID_time& timeNow); - /// The UUID generator persistent state. - UUID_State uuid_state_; + /// The UUID generator persistent state. + UUID_State uuid_state_; - ACE_SYNCH_MUTEX* lock_; - int destroy_lock_; -}; + ACE_SYNCH_MUTEX* lock_; + int destroy_lock_; + }; -typedef ACE_Singleton <ACE_UUID_Generator, ACE_SYNCH_MUTEX> ACE_UUID_GENERATOR; + typedef ACE_Singleton <UUID_Generator, ACE_SYNCH_MUTEX> UUID_GENERATOR; + +}; #if defined (__ACE_INLINE__) -#include "ace/UUID.i" +#include "ace/UUID.inl" #endif /* __ACE_INLINE__ */ #include /**/ "ace/post.h" #endif // ACE_UUID_H - - - - - - - - - - |