ACE_Utils::UUID Class Reference

#include <UUID.h>

Collaboration diagram for ACE_Utils::UUID:

[legend]List of all members.

Public Member Functions
	UUID (void)
	Constructor.
	UUID (const ACE_CString &uuidString)
	Construct a UUID from a string representation of an UUID.
	UUID (const UUID &right)
	~UUID (void)
ACE_UINT32	time_low (void) const
	Data Members for Class Attributes.
void	time_low (ACE_UINT32)
ACE_UINT16	time_mid (void) const
void	time_mid (ACE_UINT16)
ACE_UINT16	time_hi_and_version (void) const
void	time_hi_and_version (ACE_UINT16)
u_char	clock_seq_hi_and_reserved (void) const
void	clock_seq_hi_and_reserved (u_char)
u_char	clock_seq_low (void) const
void	clock_seq_low (u_char)
UUID_Node *	node (void) const
void	node (UUID_Node *)
ACE_CString *	thr_id (void)
void	thr_id (char *)
ACE_CString *	pid (void)
void	pid (char *)
const ACE_CString *	to_string (void)
	Returns a string representation of the UUID.
void	from_string (const ACE_CString &uuid_string)
	Set the value using a string.
bool	operator== (const UUID &right) const
	Equality Operations.
bool	operator!= (const UUID &right) const
Static Public Attributes
static UUID	NIL_UUID
Private Member Functions
void	from_string_i (const ACE_CString &uuid_string)
	Relational Operations.
UUID &	operator= (const UUID &)
Private Attributes
ACE_UINT32	time_low_
	Data Members for Class Attributes.
ACE_UINT16	time_mid_
ACE_UINT16	time_hi_and_version_
u_char	clock_seq_hi_and_reserved_
u_char	clock_seq_low_
UUID_Node *	node_
bool	node_release_
ACE_CString	thr_id_
ACE_CString	pid_
ACE_CString *	as_string_

---

Detailed Description

Definition at line 75 of file UUID.h.

---

Constructor & Destructor Documentation

ACE_Utils::UUID::UUID

(

void

)

Constructor.

Construct a nil UUID. Such a UUID has every one of it's data elements set to zero.

Definition at line 50 of file UUID.cpp.

References ACE_NEW, and node_.

    : time_low_ (0),
      time_mid_ (0),
      time_hi_and_version_ (0),
      clock_seq_hi_and_reserved_ (0),
      clock_seq_low_ (0),
      node_ (0),
      node_release_ (true),
      as_string_ (0)
  {
    ACE_NEW (node_,
             UUID_Node);
  }

ACE_Utils::UUID::UUID

(

const ACE_CString &

uuidString

)

Construct a UUID from a string representation of an UUID.

Definition at line 65 of file UUID.cpp.

References ACE_NEW, from_string_i(), and node_.

    : time_low_ (0),
      time_mid_ (0),
      time_hi_and_version_ (0),
      clock_seq_hi_and_reserved_ (0),
      clock_seq_low_ (0),
      node_ (0),
      node_release_ (true),
      as_string_ (0)
  {
    ACE_NEW (node_,
             UUID_Node);

    this->from_string_i (uuid_string);
  }

ACE_Utils::UUID::UUID

(

const UUID &

right

)

Definition at line 81 of file UUID.cpp.

References ACE_NEW, and node_.

    : time_low_ (right.time_low_),
      time_mid_ (right.time_mid_),
      time_hi_and_version_ (right.time_hi_and_version_),
      clock_seq_hi_and_reserved_ (right.clock_seq_hi_and_reserved_),
      clock_seq_low_ (right.clock_seq_low_),
      as_string_ (0)
  {
    ACE_NEW (node_,
             UUID_Node (*right.node_));
  }

ACE_Utils::UUID::~UUID

(

void

)

Definition at line 93 of file UUID.cpp.

References as_string_, node_, and node_release_.

  {
    if (node_release_)
      delete node_;

    if (as_string_ != 0)
      delete as_string_;
  }

---

Member Function Documentation

ACE_INLINE void ACE_Utils::UUID::clock_seq_hi_and_reserved

(

u_char

)

Definition at line 54 of file UUID.inl.

References clock_seq_hi_and_reserved_.

  {
    this->clock_seq_hi_and_reserved_ = clock_seq_hi_and_reserved;
  }

ACE_INLINE u_char ACE_Utils::UUID::clock_seq_hi_and_reserved

(

void

)

const

Definition at line 48 of file UUID.inl.

References clock_seq_hi_and_reserved_.

Referenced by from_string_i(), ACE_Utils::UUID_Generator::generate_UUID(), and operator==().

  {
    return this->clock_seq_hi_and_reserved_;
  }

ACE_INLINE void ACE_Utils::UUID::clock_seq_low

(

u_char

)

Definition at line 66 of file UUID.inl.

References clock_seq_low_.

  {
    this->clock_seq_low_ = clock_seq_low;
  }

ACE_INLINE u_char ACE_Utils::UUID::clock_seq_low

(

void

)

const

Definition at line 60 of file UUID.inl.

References clock_seq_low_.

Referenced by from_string_i(), ACE_Utils::UUID_Generator::generate_UUID(), and operator==().

  {
    return this->clock_seq_low_;
  }

ACE_INLINE void ACE_Utils::UUID::from_string

(

const ACE_CString &

uuid_string

)

Set the value using a string.

Definition at line 112 of file UUID.inl.

References from_string_i().

  {
    this->from_string_i (uuidString);
  }

void ACE_Utils::UUID::from_string_i

(

const ACE_CString &

uuid_string

)

[private]

Relational Operations.

Special case for the nil UUID.

Support versions 1, 3, and 4 only

Definition at line 177 of file UUID.cpp.

References ACE_ASSERT, ACE_DEBUG, ACE_ERROR, ACE_String_Base< CHAR >::c_str(), clock_seq_hi_and_reserved(), clock_seq_hi_and_reserved_, clock_seq_low(), clock_seq_low_, ACE_String_Base< CHAR >::find(), ACE_String_Base< CHAR >::length(), LM_DEBUG, LM_ERROR, NIL_UUID, node(), node_, ACE_Utils::UUID_Node::node_ID(), ACE_Utils::UUID_Node::NODE_ID_SIZE, pid_, ACE_String_Base< CHAR >::substr(), thr_id_, time_hi_and_version(), time_hi_and_version_, time_low(), time_low_, time_mid(), time_mid_, and to_string().

Referenced by from_string(), and UUID().

  {
    if (uuid_string.length () < NIL_UUID.to_string ()->length ())
      {
        ACE_ERROR ((LM_ERROR,
                    "%N ACE_UUID::from_string_i - "
                    "IllegalArgument (incorrect string length)\n"));
        return;
      }

    /// Special case for the nil UUID.
    if (uuid_string == *NIL_UUID.to_string ())
      {
        bool copy_constructor_not_supported = false;
        ACE_ASSERT (copy_constructor_not_supported);
        //*this = NIL_UUID;
        ACE_UNUSED_ARG (copy_constructor_not_supported);
        return;
      }

    unsigned int time_low;
    unsigned int time_mid;
    unsigned int time_hi_and_version;
    unsigned int clock_seq_hi_and_reserved;
    unsigned int clock_seq_low;
    unsigned int node [UUID_Node::NODE_ID_SIZE];
    char thr_pid_buf [BUFSIZ];

    if (uuid_string.length () == NIL_UUID.to_string ()->length ())
      {
        // This might seem quite strange this being in ACE, but it
        // seems to be a bit difficult to write a facade for ::sscanf
        // because some compilers dont support vsscanf, including
        // MSVC. It appears that most platforms support sscanf though
        // so we need to use it directly.
        const int nScanned =
#if defined (ACE_HAS_TR24731_2005_CRT)
          sscanf_s (
#else
          ::sscanf (
#endif /* ACE_HAS_TR24731_2005_CRT */
                   uuid_string.c_str (),
                   "%8x-%4x-%4x-%2x%2x-%2x%2x%2x%2x%2x%2x",
                   &time_low,
                   &time_mid,
                   &time_hi_and_version,
                   &clock_seq_hi_and_reserved,
                   &clock_seq_low,
                   &node[0],
                   &node[1],
                   &node[2],
                   &node[3],
                   &node[4],
                   &node[5]
                   );

        if (nScanned != 11)
          {
            ACE_DEBUG ((LM_DEBUG,
                        "UUID::from_string_i - "
                        "IllegalArgument (invalid string representation)\n"));
            return;
          }
      }
    else
      {
        const int nScanned =
#if defined (ACE_HAS_TR24731_2005_CRT)
          sscanf_s (uuid_string.c_str (),
                    "%8x-%4x-%4x-%2x%2x-%2x%2x%2x%2x%2x%2x-%s",
                    &time_low,
                    &time_mid,
                    &time_hi_and_version,
                    &clock_seq_hi_and_reserved,
                    &clock_seq_low,
                    &node[0],
                    &node[1],
                    &node[2],
                    &node[3],
                    &node[4],
                    &node[5],
                    thr_pid_buf,
                    BUFSIZ
                    );
#else
          ::sscanf (uuid_string.c_str (),
                    "%8x-%4x-%4x-%2x%2x-%2x%2x%2x%2x%2x%2x-%s",
                    &time_low,
                    &time_mid,
                    &time_hi_and_version,
                    &clock_seq_hi_and_reserved,
                    &clock_seq_low,
                    &node[0],
                    &node[1],
                    &node[2],
                    &node[3],
                    &node[4],
                    &node[5],
                    thr_pid_buf
                    );
#endif /* ACE_HAS_TR24731_2005_CRT */

        if (nScanned != 12)
          {
            ACE_DEBUG ((LM_DEBUG,
                        "ACE_UUID::from_string_i - "
                        "IllegalArgument (invalid string representation)\n"));
            return;
          }
      }

    this->time_low_ = static_cast<ACE_UINT32> (time_low);
    this->time_mid_ = static_cast<ACE_UINT16> (time_mid);
    this->time_hi_and_version_ = static_cast<ACE_UINT16> (time_hi_and_version);
    this->clock_seq_hi_and_reserved_ = static_cast<u_char> (clock_seq_hi_and_reserved);
    this->clock_seq_low_ = static_cast<u_char> (clock_seq_low);

    UUID_Node::Node_ID node_id;
    for (int i = 0; i < UUID_Node::NODE_ID_SIZE; ++i)
      node_id [i] = static_cast<u_char> (node[i]);

    this->node_->node_ID (node_id);

    // Support varient 10- only
    if ((this->clock_seq_hi_and_reserved_ & 0xc0) != 0x80 && (this->clock_seq_hi_and_reserved_ & 0xc0) != 0xc0)
      {
        ACE_DEBUG ((LM_DEBUG,
                    "ACE_UUID::from_string_i - "
                    "IllegalArgument (unsupported variant)\n"));
        return;
      }

    /// Support versions 1, 3, and 4 only
    ACE_UINT16 V1 = this->time_hi_and_version_;

    if ((V1 & 0xF000) != 0x1000 &&
        (V1 & 0xF000) != 0x3000 &&
        (V1 & 0xF000) != 0x4000)
      {
        ACE_DEBUG ((LM_DEBUG,
                    "ACE_UUID::from_string_i - "
                    "IllegalArgument (unsupported version)\n"));
        return;
      }

    if ((this->clock_seq_hi_and_reserved_ & 0xc0) == 0xc0)
      {
        if (uuid_string.length () == NIL_UUID.to_string ()->length ())
          {
            ACE_DEBUG ((LM_DEBUG,
                      "ACE_UUID::from_string_i - "
                        "IllegalArgument (Missing Thread and Process Id)\n"));
            return;
          }
        ACE_CString thr_pid_str (thr_pid_buf);
        ssize_t pos = static_cast<ssize_t> (thr_pid_str.find ('-'));
        if (pos == -1)
          ACE_DEBUG ((LM_DEBUG,
                      "ACE_UUID::from_string_i - "
                      "IllegalArgument (Thread and Process Id format incorrect)\n"));

        this->thr_id_ = thr_pid_str.substr (0, pos);
      this->pid_ = thr_pid_str.substr (pos+1, thr_pid_str.length ()-pos-1);
      }
  }

ACE_INLINE void ACE_Utils::UUID::node

(

UUID_Node *

)

Definition at line 78 of file UUID.inl.

References node(), node_, and node_release_.

  {
    if (node_release_)
      delete node_;

    this->node_ = node;
    node_release_ = false;
  }

ACE_INLINE UUID_Node * ACE_Utils::UUID::node

(

void

)

const

Definition at line 72 of file UUID.inl.

References node_.

Referenced by from_string_i(), ACE_Utils::UUID_Generator::generate_UUID(), node(), and operator==().

  {
    return this->node_;
  }

ACE_INLINE bool ACE_Utils::UUID::operator!=

(

const UUID &

right

)

const

Definition at line 132 of file UUID.inl.

  {
    return !(*this == right);
  }

UUID& ACE_Utils::UUID::operator=

(

const UUID &

)

[private]

ACE_INLINE bool ACE_Utils::UUID::operator==

(

const UUID &

right

)

const

Equality Operations.

Definition at line 118 of file UUID.inl.

References clock_seq_hi_and_reserved(), clock_seq_low(), node(), time_hi_and_version(), time_low(), and time_mid().

  {
    if ((this->time_low_ != right.time_low ()) ||
        (this->time_mid_ != right.time_mid ()) ||
        (this->time_hi_and_version_ != right.time_hi_and_version ()) ||
        (this->clock_seq_hi_and_reserved_ != right.clock_seq_hi_and_reserved ()) ||
        (this->clock_seq_low_ != right.clock_seq_low ()) ||
        (*this->node_ != *right.node ()))
      return false;

      return true;
  }

ACE_INLINE void ACE_Utils::UUID::pid

(

char *

)

Definition at line 106 of file UUID.inl.

References pid_.

  {
    this->pid_ = pid;
  }

ACE_INLINE ACE_CString * ACE_Utils::UUID::pid

(

void

)

Definition at line 100 of file UUID.inl.

References pid_.

Referenced by ACE_Utils::UUID_Generator::generate_UUID().

  {
    return &this->pid_;
  }

ACE_INLINE void ACE_Utils::UUID::thr_id

(

char *

)

Definition at line 94 of file UUID.inl.

References thr_id_.

  {
    this->thr_id_ = thr_id;
  }

ACE_INLINE ACE_CString * ACE_Utils::UUID::thr_id

(

void

)

Definition at line 88 of file UUID.inl.

References thr_id_.

Referenced by ACE_Utils::UUID_Generator::generate_UUID().

  {
    return &this->thr_id_;
  }

ACE_INLINE void ACE_Utils::UUID::time_hi_and_version

(

ACE_UINT16

)

Definition at line 42 of file UUID.inl.

References time_hi_and_version_.

  {
    this->time_hi_and_version_ = time_hi_and_version;
  }

ACE_INLINE ACE_UINT16 ACE_Utils::UUID::time_hi_and_version

(

void

)

const

Definition at line 36 of file UUID.inl.

References time_hi_and_version_.

Referenced by from_string_i(), ACE_Utils::UUID_Generator::generate_UUID(), and operator==().

  {
    return this->time_hi_and_version_;
  }

ACE_INLINE void ACE_Utils::UUID::time_low

(

ACE_UINT32

)

Definition at line 18 of file UUID.inl.

References time_low_.

  {
    this->time_low_ = timelow;
  }

ACE_INLINE ACE_UINT32 ACE_Utils::UUID::time_low

(

void

)

const

Data Members for Class Attributes.

Definition at line 12 of file UUID.inl.

References time_low_.

Referenced by from_string_i(), ACE_Utils::UUID_Generator::generate_UUID(), and operator==().

  {
    return this->time_low_;
  }

ACE_INLINE void ACE_Utils::UUID::time_mid

(

ACE_UINT16

)

Definition at line 30 of file UUID.inl.

References time_mid_.

  {
    this->time_mid_ = time_mid;
  }

ACE_INLINE ACE_UINT16 ACE_Utils::UUID::time_mid

(

void

)

const

Definition at line 24 of file UUID.inl.

References time_mid_.

Referenced by from_string_i(), ACE_Utils::UUID_Generator::generate_UUID(), and operator==().

  {
    return this->time_mid_;
  }

const ACE_CString * ACE_Utils::UUID::to_string

(

void

)

Returns a string representation of the UUID.

Only compute the string representation once.

Definition at line 103 of file UUID.cpp.

References ACE_NEW_NORETURN, ACE_NEW_RETURN, as_string_, ACE_String_Base< CHAR >::c_str(), ACE_String_Base< CHAR >::length(), pid_, ACE_OS::sprintf(), and thr_id_.

Referenced by from_string_i().

  {
    /// Only compute the string representation once.
    if (as_string_ == 0)
      {
        // Get a buffer exactly the correct size. Use the nil UUID as a
        // gauge.  Don't forget the trailing nul.
        size_t UUID_STRING_LENGTH = 36 + thr_id_.length () + pid_.length ();
        char *buf = 0;

        if ((thr_id_.length () != 0) && (pid_.length () != 0))
          {
            UUID_STRING_LENGTH += 2; //for '-'
            ACE_NEW_RETURN (buf,
                            char[UUID_STRING_LENGTH + 1],
                            0);

            ACE_OS::sprintf (buf,
                             "%8.8x-%4.4x-%4.4x-%2.2x%2.2x-%2.2x%2.2x%2.2x%2.2x%2.2x%2.2x-%s-%s",
                             this->time_low_,
                             this->time_mid_,
                             this->time_hi_and_version_,
                             this->clock_seq_hi_and_reserved_,
                             this->clock_seq_low_,
                             (this->node_->node_ID ()) [0],
                             (this->node_->node_ID ()) [1],
                             (this->node_->node_ID ()) [2],
                             (this->node_->node_ID ()) [3],
                             (this->node_->node_ID ()) [4],
                             (this->node_->node_ID ()) [5],
                             thr_id_.c_str (),
                             pid_.c_str ()
                             );
          }
        else
          {
            ACE_NEW_RETURN (buf,
                            char[UUID_STRING_LENGTH + 1],
                            0);

            ACE_OS::sprintf (buf,
                             "%8.8x-%4.4x-%4.4x-%2.2x%2.2x-%2.2x%2.2x%2.2x%2.2x%2.2x%2.2x",
                             this->time_low_,
                             this->time_mid_,
                             this->time_hi_and_version_,
                             this->clock_seq_hi_and_reserved_,
                             this->clock_seq_low_,
                             (this->node_->node_ID ()) [0],
                             (this->node_->node_ID ()) [1],
                             (this->node_->node_ID ()) [2],
                             (this->node_->node_ID ()) [3],
                             (this->node_->node_ID ()) [4],
                             (this->node_->node_ID ()) [5]
                             );
          }

        // We allocated 'buf' above dynamically, so we shouldn't use
        // ACE_NEW_RETURN here to avoid a possible memory leak.
        ACE_NEW_NORETURN (this->as_string_,
                          ACE_CString (buf, UUID_STRING_LENGTH));

        // we first free the dynamically allocated 'buf'.
        delete [] buf;

        // then we test that ACE_NEW succeded for 'as_string_'
        // if not, we return 0 (NULL) to indicate failure.
        if (this->as_string_ == 0 )
          return 0;
      }

    return as_string_;
  }

---

Member Data Documentation

ACE_CString* ACE_Utils::UUID::as_string_ [private]

The string representation of the UUID. This is created and updated only on demand.

Definition at line 150 of file UUID.h.

Referenced by to_string(), and ~UUID().

u_char ACE_Utils::UUID::clock_seq_hi_and_reserved_ [private]

Definition at line 141 of file UUID.h.

Referenced by clock_seq_hi_and_reserved(), and from_string_i().

u_char ACE_Utils::UUID::clock_seq_low_ [private]

Definition at line 142 of file UUID.h.

Referenced by clock_seq_low(), and from_string_i().

UUID ACE_Utils::UUID::NIL_UUID [static]

Definition at line 120 of file UUID.h.

Referenced by from_string_i().

UUID_Node* ACE_Utils::UUID::node_ [private]

Definition at line 143 of file UUID.h.

Referenced by from_string_i(), node(), UUID(), and ~UUID().

bool ACE_Utils::UUID::node_release_ [private]

Definition at line 144 of file UUID.h.

Referenced by node(), and ~UUID().

ACE_CString ACE_Utils::UUID::pid_ [private]

Definition at line 146 of file UUID.h.

Referenced by from_string_i(), pid(), and to_string().

ACE_CString ACE_Utils::UUID::thr_id_ [private]

Definition at line 145 of file UUID.h.

Referenced by from_string_i(), thr_id(), and to_string().

ACE_UINT16 ACE_Utils::UUID::time_hi_and_version_ [private]

Definition at line 140 of file UUID.h.

Referenced by from_string_i(), and time_hi_and_version().

ACE_UINT32 ACE_Utils::UUID::time_low_ [private]

Data Members for Class Attributes.

Definition at line 138 of file UUID.h.

Referenced by from_string_i(), and time_low().

ACE_UINT16 ACE_Utils::UUID::time_mid_ [private]

Definition at line 139 of file UUID.h.

Referenced by from_string_i(), and time_mid().

---

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

• UUID.h
• UUID.cpp
• UUID.inl

---