File: Poco.UUID.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (235 lines) | stat: -rw-r--r-- 17,628 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::UUID</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class UUID</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> UUID<br />
<b>Header:</b> Poco/UUID.h</p>
<h2>Description</h2>
<div class="description">
<p>A <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> is an identifier that is unique across both space and time, with respect to the space of all UUIDs. Since a <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> is a fixed size and contains a time field, it is possible for values to rollover (around A.D. 3400, depending on the specific algorithm used). A <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> can be used for multiple purposes, from tagging objects with an extremely short lifetime, to reliably identifying very persistent objects across a network. This class implements a Universal Unique Identifier, as specified in Appendix A of the DCE 1.1 Remote Procedure Call Specification (<a href="http://www.opengroup.org/onlinepubs/9629399/" target="_blank">http://www.opengroup.org/onlinepubs/9629399/</a>), <a href="http://www.ietf.org/rfc/rfc2518.txt" target="_blank">RFC 2518</a> (WebDAV), section 6.4.1 and the UUIDs and GUIDs internet draft by Leach/Salz from February, 1998  (<a href="http://ftp.ics.uci.edu/pub/ietf/webdav/uuid-guid/draft-leach-uuids-guids-01.txt" target="_blank">http://ftp.ics.uci.edu/pub/ietf/webdav/uuid-guid/draft-leach-uuids-guids-01.txt</a>) and also <a href="http://www.ietf.org/internet-drafts/draft-mealling-uuid-urn-03.txt" target="_blank">http://www.ietf.org/internet-drafts/draft-mealling-uuid-urn-03.txt</a> </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.UUID.html#11727" title="Poco::UUID::appendHex()">appendHex</a>, <a href="Poco.UUID.html#11725" title="Poco::UUID::compare()">compare</a>, <a href="Poco.UUID.html#11692" title="Poco::UUID::copyFrom()">copyFrom</a>, <a href="Poco.UUID.html#11694" title="Poco::UUID::copyTo()">copyTo</a>, <a href="Poco.UUID.html#11712" title="Poco::UUID::dns()">dns</a>, <a href="Poco.UUID.html#11738" title="Poco::UUID::fromNetwork()">fromNetwork</a>, <a href="Poco.UUID.html#11710" title="Poco::UUID::isNil()">isNil</a>, <a href="Poco.UUID.html#11736" title="Poco::UUID::nibble()">nibble</a>, <a href="Poco.UUID.html#11711" title="Poco::UUID::nil()">nil</a>, <a href="Poco.UUID.html#11714" title="Poco::UUID::oid()">oid</a>, <a href="Poco.UUID.html#11700" title="Poco::UUID::operator !=()">operator&nbsp;!=</a>, <a href="Poco.UUID.html#11702" title="Poco::UUID::operator <()">operator&nbsp;&lt;</a>, <a href="Poco.UUID.html#11704" title="Poco::UUID::operator <=()">operator&nbsp;&lt;=</a>, <a href="Poco.UUID.html#11685" title="Poco::UUID::operator =()">operator&nbsp;=</a>, <a href="Poco.UUID.html#11698" title="Poco::UUID::operator ==()">operator&nbsp;==</a>, <a href="Poco.UUID.html#11706" title="Poco::UUID::operator >()">operator&nbsp;&gt;</a>, <a href="Poco.UUID.html#11708" title="Poco::UUID::operator >=()">operator&nbsp;&gt;=</a>, <a href="Poco.UUID.html#11689" title="Poco::UUID::parse()">parse</a>, <a href="Poco.UUID.html#11687" title="Poco::UUID::swap()">swap</a>, <a href="Poco.UUID.html#11739" title="Poco::UUID::toNetwork()">toNetwork</a>, <a href="Poco.UUID.html#11691" title="Poco::UUID::toString()">toString</a>, <a href="Poco.UUID.html#11713" title="Poco::UUID::uri()">uri</a>, <a href="Poco.UUID.html#11697" title="Poco::UUID::variant()">variant</a>, <a href="Poco.UUID.html#11696" title="Poco::UUID::version()">version</a>, <a href="Poco.UUID.html#11715" title="Poco::UUID::x500()">x500</a></p>
<h2>Enumerations</h2>
<h3><a name="11672">Version</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="11673">UUID_TIME_BASED</a> = 0x01</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="11674">UUID_DCE_UID</a> = 0x02</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="11675">UUID_NAME_BASED</a> = 0x03</p>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="11676">UUID_RANDOM</a> = 0x04</p>
<div class="description">
<p></p>
</div>
<h2>Constructors</h2>
<h3><a name="11677">UUID</a></h3>
<p class="decl"><a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>();</p>
<div class="description">
<p>Creates a nil (all zero) <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>. </p>
</div>
<h3><a name="11678">UUID</a></h3>
<p class="decl"><a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />);</p>
<div class="description">
<p>Copy constructor. </p>
</div>
<h3><a name="11680">UUID</a></h3>
<p class="decl">explicit <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; uuid<br />);</p>
<div class="description">
<p>Parses the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> from a string. </p>
</div>
<h3><a name="11682">UUID</a></h3>
<p class="decl">explicit <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const char * uuid<br />);</p>
<div class="description">
<p>Parses the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> from a string. </p>
</div>
<h3><a name="11722">UUID</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const char * bytes,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.UUID.html#11672" title="enum  Poco::UUID::Version">Version</a> version<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="11716">UUID</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11354" title="Poco::UInt32">UInt32</a> timeLow,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11354" title="Poco::UInt32">UInt32</a> timeMid,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11354" title="Poco::UInt32">UInt32</a> timeHiAndVersion,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11352" title="Poco::UInt16">UInt16</a> clockSeq,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11350" title="Poco::UInt8">UInt8</a> node[]<br />);</p>
<div class="description">
<p></p>
</div>
<h2>Destructor</h2>
<h3><a name="11684">~UUID</a></h3>
<p class="decl">~<a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="11692">copyFrom</a></h3>
<p class="decl">void copyFrom(<br />&nbsp;&nbsp;&nbsp;&nbsp;const char * buffer<br />);</p>
<div class="description">
<p>Copies the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> (16 bytes) from a buffer or byte array. The <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> fields are expected to be stored in network byte order. The buffer need not be aligned. </p>
</div>
<h3><a name="11694">copyTo</a></h3>
<p class="decl">void copyTo(<br />&nbsp;&nbsp;&nbsp;&nbsp;char * buffer<br />) const;</p>
<div class="description">
<p>Copies the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> to the buffer. The fields are in network byte order. The buffer need not be aligned. There must have room for at least 16 bytes. </p>
</div>
<h3><a name="11712">dns</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; dns();</p>
<div class="description">
<p>Returns the namespace identifier for the DNS namespace. </p>
</div>
<h3><a name="11710">isNil</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool isNil() const;</p>
<div class="description">
<p>Returns true if and only if the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> is nil (in other words, consists of all zeros). </p>
</div>
<h3><a name="11711">nil</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; nil();</p>
<div class="description">
<p>Returns a nil <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>. </p>
</div>
<h3><a name="11714">oid</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; oid();</p>
<div class="description">
<p>Returns the namespace identifier for the OID namespace. </p>
</div>
<h3><a name="11700">operator !=</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool operator != (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />) const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11702">operator &lt;</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool operator &lt; (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />) const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11704">operator &lt;=</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool operator &lt;= (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />) const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11685">operator =</a></h3>
<p class="decl"><a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; operator = (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />);</p>
<div class="description">
<p>Assignment operator. </p>
</div>
<h3><a name="11698">operator ==</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool operator == (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />) const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11706">operator &gt;</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool operator &gt; (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />) const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11708">operator &gt;=</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool operator &gt;= (<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />) const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11689">parse</a></h3>
<p class="decl">void parse(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; uuid<br />);</p>
<div class="description">
<p>Parses the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> from its string representation. </p>
</div>
<h3><a name="11687">swap</a></h3>
<p class="decl">void swap(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />);</p>
<div class="description">
<p>Swaps the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> with another one.	 </p>
</div>
<h3><a name="11691">toString</a></h3>
<p class="decl">std::string toString() const;</p>
<div class="description">
<p>Returns a string representation of the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> consisting of groups of hexadecimal digits separated by hyphens. </p>
</div>
<h3><a name="11713">uri</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uri();</p>
<div class="description">
<p>Returns the namespace identifier for the <a href="Poco.URI.html" title="class Poco::URI">URI</a> (former URL) namespace. </p>
</div>
<h3><a name="11697">variant</a></h3>
<p class="decl">int variant() const;</p>
<div class="description">
<p>Returns the variant number of the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>: </p>
<ul>
<li>0 reserved for NCS backward compatibility </li>
<li>2 the Leach-Salz variant (used by this class) </li>
<li>6 reserved, Microsoft Corporation backward compatibility </li>
<li>7 reserved for future definition </li>
</ul>
</div>
<h3><a name="11696">version</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.UUID.html#11672" title="enum  Poco::UUID::Version">Version</a> version() const;</p>
<div class="description">
<p>Returns the version of the <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a>. </p>
</div>
<h3><a name="11715">x500</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; x500();</p>
<div class="description">
<p>Returns the namespace identifier for the X500 namespace. </p>
</div>
<h3><a name="11727">appendHex</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void appendHex(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::string &amp; str,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11350" title="Poco::UInt8">UInt8</a> n<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="11730">appendHex</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void appendHex(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::string &amp; str,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11352" title="Poco::UInt16">UInt16</a> n<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="11733">appendHex</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static void appendHex(<br />&nbsp;&nbsp;&nbsp;&nbsp;std::string &amp; str,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.html#11354" title="Poco::UInt32">UInt32</a> n<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="11725">compare</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int compare(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.UUID.html" title="class Poco::UUID">UUID</a> &amp; uuid<br />) const;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11738">fromNetwork</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void fromNetwork();</p>
<div class="description">
<p></p>
</div>
<h3><a name="11736">nibble</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static <a href="Poco.html#11350" title="Poco::UInt8">UInt8</a> nibble(<br />&nbsp;&nbsp;&nbsp;&nbsp;char hex<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="11739">toNetwork</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void toNetwork();</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>