forked from boostorg/uuid
/
uuid.html
689 lines (570 loc) · 24.5 KB
/
uuid.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Uuid Library</title>
<style type="text/css">
pre { margin: 1em; padding: 1em; border: 1px solid #ddd; }
</style>
</head>
<body>
<h1><img src="../../boost.png" alt="Boost" WIDTH="277" HEIGHT="86">Uuid</h1>
<h2><a name="Contents">Contents</a></h2>
<ol>
<li><a href="#Introduction">Introduction</a></li>
<li><a href="#Configuration">Configuration</a></li>
<li><a href="#Examples">Examples</a></li>
<ul>
<li><a href="#Tagging">Tagging</a></li>
<li><a href="#POD Efficiencies">POD Efficiencies</a></li>
<li><a href="#Byte Extraction">Byte Extraction</a></li>
</ul
<li><a href="#Reference">Reference</a></li>
<ul>
<li><a href="#boost/uuid/uuid.hpp">boost/uuid/uuid.hpp</a></li>
<ul>
<li><a href="#Synopsis">Synopsis</a></li>
<li><a href="#Size">Size</a></li>
<li><a href="#Iteration">Iteration</a></li>
<li><a href="#Nil">Nil uuid</a></li>
<li><a href="#Variant">Variant</a></li>
<li><a href="#Version">Version</a></li>
<li><a href="#Swap">Swap</a></li>
<li><a href="#Operators">Operators</a></li>
<li><a href="#Hash">Hash</a></li>
</ul>
<li><a href="#boost/uuid/uuid_generators.hpp">boost/uuid/uuid_generators.hpp</a></li>
<ul>
<li><a href="#Synopsis_generators">Synopsis</a></li>
</ul>
<li><a href="#boost/uuid/nil_generator.hpp">boost/uuid/nil_generator.hpp</a></li>
<ul>
<li><a href="#Synopsis_nil_generator">Synopsis</a></li>
<li><a href="#Nil Generator">Nil Generator</a></li>
</ul>
<li><a href="#boost/uuid/string_generator.hpp">boost/uuid/string_generator.hpp</a></li>
<ul>
<li><a href="#Synopsis_string_generator">Synopsis</a></li>
<li><a href="#String Generator">String Generator</a></li>
</ul>
<li><a href="#boost/uuid/name_generator.hpp">boost/uuid/name_generator.hpp</a></li>
<ul>
<li><a href="#Synopsis_name_generator">Synopsis</a></li>
<li><a href="#Name Generator">Name Generator</a></li>
</ul>
<li><a href="#boost/uuid/random_generator.hpp">boost/uuid/random_generator.hpp</a></li>
<ul>
<li><a href="#Synopsis_random_generator">Synopsis</a></li>
<li><a href="#Random Generator">Random Generator</a></li>
</ul>
<li><a href="#boost/uuid/uuid_io.hpp">boost/uuid/uuid_io.hpp</a></li>
<ul>
<li><a href="#Synopsis_io">Synopsis</a></li>
<li><a href="#Stream_operators">Stream Operators</a></li>
<li><a href="#to_string">To String</a></li>
</ul>
<li><a href="#boost/uuid/uuid_serialize.hpp">boost/uuid/uuid_serialize.hpp</a></li>
<ul>
<li><a href="#Synopsis_serialize">Synopsis</a></li>
<li><a href="#Serialization">Serialization</a></li>
</ul>
</ul>
<li><a href="#Design notes">Design notes</a></li>
<li><a href="#History and Acknowledgements">History and Acknowledgements</a></li>
</ol>
<h2><a name="Introduction">Introduction</a></h2>
<p>
A UUID, or Universally unique identifier, is intended to uniquely identify
information in a distributed environment without significant central
coordination. It can be used to tag objects with very short lifetimes, or
to reliably identify very persistent objects across a network.
<p>
UUIDs have many applications. Some examples follow: Databases may use UUIDs
to identify rows or records in order to ensure that they are unique across
different databases, or for publication/subscription services. Network messages
may be identified with a UUID to ensure that different parts of a message are put
back together again. Distributed computing may use UUIDs to identify a remote
procedure call. Transactions and classes involved in serialization may be
identified by UUIDs. Microsoft's component object model (COM) uses UUIDs to
distinguish different software component interfaces. UUIDs are inserted into
documents from Microsoft Office programs. UUIDs identify audio or
video streams in the Advanced Systems Format (ASF). UUIDs are also a basis
for OIDs (object identifiers), and URNs (uniform resource name).
<p>
An attractive feature of UUIDs when compared to alternatives is their relative
small size, of 128-bits, or 16-bytes. Another is that the creation of UUIDs
does not require a centralized authority.
<p>When UUIDs are generated by one of the defined
mechanisms, they are either guaranteed to be unique, different from all other
generated UUIDs (that is, it has never been generated before and it will
never be generated again), or it is extremely likely to be unique (depending
on the mechanism).
<h2><a name="Configuration">Configuration</a></h2>
<p>
The library does not require building or any special configuration to be used.
However, there are a few options that can be enabled by defining macros prior to
including library headers. These macros are summarized in the following table.
<p>
<table border="1">
<tr>
<th>Macro</th><th>Description</th>
</tr>
<tr>
<td><tt>BOOST_UUID_NO_SIMD</tt></td><td>If defined, disables any optimizations for <a href="http://en.wikipedia.org/wiki/SIMD">SIMD</a>-enabled processors. Generic versions of algorithms will be used instead. This may result in suboptimal performance. By default, optimized algorithms are used, when the library is able to detect the availability of SIMD extensions at compile time.</td>
</tr>
<tr>
<td><tt>BOOST_UUID_USE_SSE2</tt></td><td>If defined, enables optimizations for <a href="http://en.wikipedia.org/wiki/SSE2">SSE2</a> exstensions available in modern x86 processors.</td>
</tr>
<tr>
<td><tt>BOOST_UUID_USE_SSE3</tt></td><td>If defined, enables optimizations for <a href="http://en.wikipedia.org/wiki/SSE3">SSE3</a> exstensions available in modern x86 processors.</td>
</tr>
<tr>
<td><tt>BOOST_UUID_USE_SSE41</tt></td><td>If defined, enables optimizations for <a href="http://en.wikipedia.org/wiki/SSE4#SSE4.1">SSE4.1</a> exstensions available in modern x86 processors.</td>
</tr>
</table>
<p>
By default the library attempts to detect the availability of SIMD extensions in the target CPU at compile time and automatically defines the appropriate macros if succeeded. The <tt>BOOST_UUID_USE_SSE*</tt> macros can be defined by users, if auto-detection fails and it is known that the target CPU will have the extension. Do not enable these extensions unless you're certain that they will always be available on any machine that will run your program. The library performs no run time checks, so if an extension is missing, the program will likely crash. Note that enabling more advanced extensions implies that more basic ones are also available.
<h2><a name="Examples">Examples</a></h2>
<h3><a name="Tagging">Tagging</a></h3>
<pre>
// example of tagging an object with a uuid
// see <a href="./test/test_tagging.cpp"><tt>boost/libs/uuid/test/test_tagging.cpp</tt></a>
#include <<a href="./../../boost/uuid/uuid.hpp"><tt>boost/uuid/uuid.hpp</tt></a>>
#include <<a href="./../../boost/uuid/uuid_generators.hpp"><tt>boost/uuid/uuid_generators.hpp</tt></a>>
class object
{
public:
object()
: tag(boost::uuids::random_generator()())
, state(0)
{}
explicit object(int state)
: tag(boost::uuids::random_generator()())
, state(state)
{}
object(object const& rhs)
: tag(rhs.tag)
, state(rhs.state)
{}
bool operator==(object const& rhs) const {
return tag == rhs.tag;
}
object& operator=(object const& rhs) {
tag = rhs.tag;
state = rhs.state;
}
int get_state() const { return state; }
void set_state(int new_state) { state = new_state; }
private:
boost::uuids::uuid tag;
int state;
};
object o1(1);
object o2 = o1;
o2.set_state(2);
assert(o1 == o2);
object o3(3);
assert(o1 != o3);
assert(o2 != o3);
</pre>
<h3><a name="POD Efficiencies">POD Efficiencies</a></h3>
<p>
This library implements a UUID as a POD allowing a UUID
to be used in the most efficient ways, including using memcpy,
and aggregate initializers. A drawback is that a POD can
not have any constructors, and thus declaring a UUID will not
initialize it to a value generated by one of the defined
mechanisms. But a class based on a UUID can be defined
that does initialize itself to a value generated by one of
the defined mechanisms.
<p>
Note that <tt>boost::is_pod</tt> is specialized for <tt>boost::uuids::uuid</tt>
and depends on <a href="http://www.boost.org/libs/type_traits">Boost.TypeTraits</a>.
Define <tt>BOOST_UUID_NO_TYPE_TRAITS</tt> before including <a href="./../../boost/uuid/uuid.hpp"><tt>boost/uuid/uuid.hpp</tt></a>
to remove the dependency on <a href="http://www.boost.org/libs/type_traits">Boost.TypeTraits</a>.
<pre>
// example using memcpy and aggregate initializers
// example of a class uuid see <a href="./test/test_uuid_class.cpp"><tt>boost/libs/uuid/test/test_uuid_class.cpp</tt></a>
#include <<a href="./../../boost/uuid/uuid.hpp"><tt>boost/uuid/uuid.hpp</tt></a>>
#include <<a href="./../../boost/uuid/uuid_generators.hpp"><tt>boost/uuid/uuid_generators.hpp</tt></a>>
{ // example using memcpy
unsigned char uuid_data[16];
// fill uuid_data
boost::uuids::uuid u;
memcpy(&u, uuid_data, 16);
}
{ // example using aggregate initializers
boost::uuids::uuid u =
{ 0x12 ,0x34, 0x56, 0x78
, 0x90, 0xab
, 0xcd, 0xef
, 0x12, 0x34
, 0x56, 0x78, 0x90, 0xab, 0xcd, 0xef
};
}
// example of creating a uuid class that
// initializes the uuid in the constructor
// using a defined mechanism
class uuid_class : public boost::uuids::uuid
{
public:
uuid_class()
: boost::uuids::uuid(boost::uuids::random_generator()())
{}
explicit uuid_class(boost::uuids::uuid const& u)
: boost::uuids::uuid(u)
{}
operator boost::uuids::uuid() {
return static_cast<boost::uuids::uuid&>(*this);
}
operator boost::uuids::uuid() const {
return static_cast<boost::uuids::uuid const&>(*this);
}
};
uuid_class u1;
uuid_class u2;
assert(u1 != u2);
</pre>
<h3><a name="Byte Extraction">Byte Extraction</a></h3>
<p>It is sometimes useful to get at the 16 bytes of a <b>uuid</b> directly.
Typical use is as follows:
<pre>
boost::uuids::uuid u;
std::vector<char> v(u.size());
std::copy(u.begin(), u.end(), v.begin());
</pre>
<p>Note: <tt>boost::uuids::uuid::size()</tt> always returns 16.
<h2><a name="Reference">Reference</a></h2>
<h3><a name="boost/uuid/uuid.hpp" href="./../../boost/uuid/uuid.hpp">boost/uuid/uuid.hpp</a></h3>
<h4><a name="Synopsis">Synopsis</a></h4>
<pre>
namespace boost {
namespace uuids {
class uuid {
public:
typedef uint8_t value_type;
typedef uint8_t& reference;
typedef uint8_t const& const_reference;
typedef uint8_t* iterator;
typedef uint8_t const* const_iterator;
typedef std::size_t size_type;
typedef std::ptrdiff_t difference_type;
static constexpr size_type static_size() noexcept;
// iteration
iterator begin() noexcept;
iterator end() noexcept;
const_iterator begin() const noexcept;
const_iterator end() const noexcept;
constexpr size_type size() const noexcept;
bool is_nil() const noexcept;
enum variant_type {
variant_ncs, // NCS backward compatibility
variant_rfc_4122, // defined in RFC 4122 document
variant_microsoft, // Microsoft Corporation backward compatibility
variant_future // future definition
};
variant_type variant() const noexcept;
enum version_type {
version_unknown = -1,
version_time_based = 1,
version_dce_security = 2,
version_name_based_md5 = 3,
version_random_number_based = 4,
version_name_based_sha1 = 5
};
version_type version() const noexcept;
// Swap function
void swap(uuid& rhs) noexcept;
uint8_t data[static_size()];
};
// standard operators
bool operator==(uuid const& lhs, uuid const& rhs) noexcept;
bool operator!=(uuid const& lhs, uuid const& rhs) noexcept;
bool operator<(uuid const& lhs, uuid const& rhs) noexcept;
bool operator>(uuid const& lhs, uuid const& rhs) noexcept;
bool operator<=(uuid const& lhs, uuid const& rhs) noexcept;
bool operator>=(uuid const& lhs, uuid const& rhs) noexcept;
void swap(uuid& lhs, uuid& rhs) noexcept;
std::size_t hash_value(uuid const& u) noexcept;
}} // namespace boost::uuids
</pre>
<h4><a name="Size">Size</a></h4>
<p>The size of a <b>uuid</b> (in bytes) can be obtained either by
calling the function <tt>boost::uuids::uuid::size()</tt> or by
calling the static function <tt>boost::uuids::uuid::static_size()</tt>,
both always return 16.
<pre>
boost::uuids::uuid u;
assert(16 == u.size());
assert(16 == boost::uuids::uuid::static_size());
</pre>
<h4><a name="Iteration">Iteration</a></h4>
<p>Both iterators and constant iterators are provided.
<pre>
boost::uuids::uuid u;
for (boost::uuids::uuid::const_iterator it=u.begin(); it!=u.end(); ++it) {
boost::uuids::uuid::value_type v = *it;
}
for (boost::uuids::uuid::iterator it=u.begin(); it!=u.end(); ++it) {
*it = 0;
}
</pre>
<h4><a name="Nil">Nil uuid</a></h4>
<p>The function, <tt>boost::uuids::uuid::is_nil()</tt> returns true if and
only if the <b>uuid</b> is equal to {00000000-0000-0000-0000-000000000000}.
</p>
<h4><a name="Variant">Variant</a></h4>
<p>Three bits of a <b>uuid</b> determine the variant.</p>
<pre>
boost::uuids::uuid u;
boost::uuids::uuid::variant_type v = u.variant();
</pre>
<h4><a name="Version">Version</a></h4>
<p>Four bits of a <b>uuid</b> determine the variant, that is the mechanism
used to generate the <b>uuid</b>.
</p>
<pre>
boost::uuids::uuid u;
boost::uuids::uuid::version_type v = u.version();
</pre>
<h4><a name="Swap">Swap</a></h4>
<p>Both <tt>boost::uuids::uuid::swap()</tt> and <tt>boost::uuids::swap()</tt>
are provided.
</p>
<pre>
boost::uuids::uuid u1, u2;
u1.swap(u2);
swap(u1, u2);
</pre>
<h4><a name="Operators">Operators</a></h4>
<p>
All of the standard numeric operators are defined for the <b>uuid</b>
class. These include:
<pre>
operator==
operator!=
operator<
operator>
operator<=
operator>=
</pre>
<h4><a name="Hash">Hash Function</a></h4>
<p>
This function allows <b>uuid</b>s to be used with
<a href="http://www.boost.org/doc/html/hash.html"><b>boost::hash</b></a>
<pre>
boost::hash<boost::uuids::uuid> uuid_hasher;
std::size_t uuid_hash_value = uuid_hasher(boost::uuids::uuid());
</pre>
<h3><a name="boost/uuid/uuid_generators.hpp" href="./../../boost/uuid/uuid_generators.hpp">boost/uuid/uuid_generators.hpp</a></h3>
<h4><a name="Synopsis_generators">Synopsis</a></h4>
This file includes all the <b>uuid</b> generators for convenience.
<pre>
#include <<a href="./../../boost/uuid/nil_generator.hpp"><tt>boost/uuid/nil_generator.hpp</tt></a>>
#include <<a href="./../../boost/uuid/string_generator.hpp"><tt>boost/uuid/string_generator.hpp</tt></a>>
#include <<a href="./../../boost/uuid/name_generator.hpp"><tt>boost/uuid/name_generator.hpp</tt></a>>
#include <<a href="./../../boost/uuid/random_generator.hpp"><tt>boost/uuid/random_generator.hpp</tt></a>>
</pre>
<h3><a name="boost/uuid/nil_generator.hpp" href="./../../boost/uuid/nil_generator.hpp">boost/uuid/nil_generator.hpp</a></h3>
<h4><a name="Synopsis_nil_generator">Synopsis</a></h4>
<pre>
namespace boost {
namespace uuids {
struct nil_generator {
typedef uuid result_type;
uuid operator()() const;
};
uuid nil_uuid();
}} //namespace boost::uuids
</pre>
<h4><a name="Nil Generator">Nil Generator</a></h4>
<p>The <tt>boost::uuids::nil_generator</tt> class always generates a nil <b>uuid</b>.
<pre>
boost::uuids::nil_generator gen;
boost::uuids::uuid u = gen();
assert(u.is_nil() == true);
// or for convenience
boost::uuids::uuid u = boost::uuids::nil_uuid();
assert(u.is_nil() == true);
</pre>
<h3><a name="boost/uuid/string_generator.hpp" href="./../../boost/uuid/string_generator.hpp">boost/uuid/string_generator.hpp</a></h3>
<h4><a name="Synopsis_string_generator">Synopsis</a></h4>
<pre>
namespace boost {
namespace uuids {
struct string_generator {
typedef uuid result_type;
template <typename ch, typename char_traits, typename alloc>
uuid operator()(std::basic_string<ch, char_traits, alloc> const& s) const;
};
}} //namespace boost::uuids
</pre>
<h4><a name="String Generator">String Generator</a></h4>
<p>The <tt>boost::uuids::string_generator</tt> class generates a <b>uuid</b> from a string.
<pre>
boost::uuids::string_generator gen;
boost::uuids::uuid u1 = gen("{01234567-89ab-cdef-0123-456789abcdef}");
boost::uuids::uuid u2 = gen(L"01234567-89ab-cdef-0123-456789abcdef");
boost::uuids::uuid u3 = gen(std::string("0123456789abcdef0123456789abcdef"));
boost::uuids::uuid u4 = gen(std::wstring(L"01234567-89ab-cdef-0123-456789abcdef"));
</pre>
<h3><a name="boost/uuid/name_generator.hpp" href="./../../boost/uuid/name_generator.hpp">boost/uuid/name_generator.hpp</a></h3>
<h4><a name="Synopsis_name_generator">Synopsis</a></h4>
<pre>
namespace boost {
namespace uuids {
class name_generator {
public:
typedef uuid result_type;
explicit name_generator(uuid const& namespace_uuid);
uuid operator()(const char* name) const;
uuid operator()(const wchar_t* name) const;
tempate <typename ch, typename char_traits, typename alloc>
uuid operator()(std::basic_string<ch, char_traits, alloc> const& name) const;
uuid operator()(void const* buffer, std::size_t byte_count) const;
};
}} //namespace boost::uuids
</pre>
<h4><a name="Name Generator">Name Generator</a></h4>
<p>
The <tt>boost::uuids::name_generator</tt> class generates a name based <b>uuid</b> from a
namespace uuid and a name.
<pre>
boost::uuids::uuid dns_namespace_uuid; // initialize to {6ba7b810-9dad-11d1-80b4-00c04fd430c8}
boost::uuids::name_generator gen(dns_namespace_uuid);
boost::uuids::uuid u = gen("boost.org");
</pre>
<h3><a name="boost/uuid/random_generator.hpp" href="./../../boost/uuid/random_generator.hpp">boost/uuid/random_generator.hpp</a></h3>
<h4><a name="Synopsis_random_generator">Synopsis</a></h4>
<pre>
namespace boost {
namespace uuids {
template <typename UniformRandomNumberGenerator>
class basic_random_generator {
public:
typedef uuid result_type;
basic_random_generator();
explicit basic_random_generator(UniformRandomNumberGenerator& gen);
explicit basic_random_generator(UniformRandomNumberGenerator* pGen);
uuid operator()();
};
typedef basic_random_generator<mt19937> random_generator;
}} // namespace boost::uuids
</pre>
<h4><a name="Random Generator">Random Generator</a></h4>
<p>
The <tt>boost::uuids::basic_random_generator</tt> class generates a random number
based uuid from a random number generator (one that conforms to the
<a href="http://www.boost.org/libs/random/random-concepts.html#uniform-rng">UniformRandomNumberGenerator</a>
concept).
<pre>
//default construct the random number generator and seed it
boost::uuids::basic_random_generator<boost::mt19937> gen;
boost::uuids::uuid u = gen();
//for convenience boost::uuids::random_generator
//is equivalent to boost::uuids::basic_random_generator<boost::mt19937>
boost::uuids::random_generator gen;
boost::uuids::uuid u = gen();
//use an existing random number generator
//pass either a reference or a pointer to the random number generator
boost::mt19937 ran;
boost::uuids::basic_random_generator<boost::mt19937> gen(&ran);
boost::uuids::uuid u = gen();
</pre>
<h3><a name="boost/uuid/uuid_io.hpp" href="./../../boost/uuid/uuid_io.hpp">boost/uuid/uuid_io.hpp</a></h3>
<h4><a name="Synopsis_io">Synopsis</a></h4>
<pre>
namespace boost {
namespace uuids {
template <typename ch, typename char_traits>
std::basic_ostream<ch, char_traits>& operator<<(std::basic_ostream<ch, char_traits> &os, uuid const& u);
template <typename ch, typename char_traits>
std::basic_istream<ch, char_traits>& operator>>(std::basic_istream<ch, char_traits> &is, uuid &u);
std::string to_string(uuid const& u);
std::wstring to_wstring(uuid const& u);
}} // namespace boost::uuids
</pre>
<h4><a name="Stream_operators">Stream Operators</a></h4>
<p>
The standard input and output stream operators <tt><<</tt> and <tt>>></tt>
are provided by including <a href="../../boost/uuid/uuid_io.hpp"><tt>boost/uuid/uuid_io.hpp</tt></a>.
The string representation of a <b>uuid</b> is <tt>hhhhhhhh-hhhh-hhhh-hhhh-hhhhhhhhhhhh</tt>
where <tt>h</tt> is a hexidecimal digit.
<pre>
boost::uuids::uuid u1; // initialize uuid
std::stringstream ss;
ss << u1;
boost::uuids::uuid u2;
ss >> u2;
assert(u1, u2);
</pre>
<p>
One can also use <a href="http://www.boost.org/libs/conversion/lexical_cast.htm"><tt>boost::lexical_cast</tt></a>.
<pre>
boost::uuids::uuid u1; // initialize uuid
std::string s = boost::lexical_cast<std::string>(u);
boost::uuids::uuid u2 = boost::lexical_cast<boost::uuids::uuid>(s);
assert(u1 == u2);
</pre>
<h4><a name="to_string">To String</a></h4>
<p>
The functions <tt>to_string</tt> and <tt>to_wstring</tt> are provided as a
convenience to convert a <b>uuid</b> to a string. They are also likely faster than
the stream operators or using <a href="http://www.boost.org/libs/conversion/lexical_cast.htm"><tt>boost::lexical_cast</tt></a>.
<pre>
boost::uuids::uuid u; // initialize uuid
std::string s1 = to_string(u);
std::wstring s2 = to_wstring(u);
</pre>
<h3><a name="boost/uuid/uuid_serialize.hpp" href="./../../boost/uuid/uuid_serialize.hpp">boost/uuid/uuid_serialize.hpp</a></h3>
<h4><a name="Synopsis_serialize">Synopsis</a></h4>
<pre>
namespace boost {
namespace uuids {
BOOST_CLASS_IMPLEMENTATION(boost::uuids::uuid, boost::serialization::primitive_type)
}} // namespace boost::uuids
</pre>
<h4><a name="Serialization">Serialization</a></h4>
<p>
Serialization is accomplished with the <a href="http://www.boost.org/libs/serialization/doc/index.html">
Boost Serialization</a> library. A <b>uuid</b> is serialized as a
<a href="http://www.boost.org/libs/serialization/doc/serialization.html#primitiveoperators">
primitive type</a>, thus only the <b>uuid</b> value will be saved to/loaded from an archive.
<p>
Include <a href="../../boost/uuid/uuid_serialize.hpp"><tt>boost/uuid/uuid_serialize.hpp</tt></a> to enable serialization for <b>uuid</b>s.
<h2><a name="Design notes">Design notes</a></h2>
<p>
The document, <a href="http://www.itu.int/ITU-T/studygroups/com17/oid/X.667-E.pdf">
http://www.itu.int/ITU-T/studygroups/com17/oid/X.667-E.pdf</a>, was used to design
and implement the <b>boost::uuids::uuid</b> struct.
<p>The <tt>boost::uuids::basic_random_generator</tt> class' default constructor
seeds the random number generator with a SHA-1 hash of a number of different
values including <tt>std::time(0)</tt>, <tt>std::clock()</tt>, uninitialized
data, value return from <tt>new unsigned int</tt>, etc..
<p>Using <a href="http://valgrind.org/">Valgrind</a> produces a number of false
positives with the default constructor of <tt>boost::uuids::basic_random_generator</tt>.
One solution is to suppress the errors as described in
<a href="http://valgrind.org/docs/manual/manual-core.html#manual-core.suppress">Valgrind's documentation</a>.
Another solution is to use a different constructor of <tt>boost::uuids::basic_random_generator</tt>
and explicitly pass in a random number generator.
<pre>
boost::mt19937 ran;
ran.seed(time(NULL)); // one should likely seed in a better way
boost::uuids::basic_random_generator<boost::mt19937> gen(&ran);
boost::uuids::uuid u = gen();
</pre>
<p>The <tt>boost::uuids::name_generator</tt> class uses the SHA-1 hash function to
compute the <b>uuid</b>.
<p>All functions are re-entrant. Classes are as thread-safe as an int. That is an
instance can not be shared between threads without proper synchronization.
<h2><a name="History and Acknowledgements">History and Acknowledgements</a></h2>
<p>
A number of people on the <a href="http://www.boost.org/">boost.org</a>
mailing list provided useful comments and greatly helped to shape the library.
<p>Revised February 6, 2010</p>
<hr>
<p>© Copyright Andy Tompkins, 2006</p>
<p> Distributed under the Boost Software
License, Version 1.0. (See accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
www.boost.org/LICENSE_1_0.txt</a>)</p>
</body>
</html>