Show
Ignore:
Timestamp:
04/03/08 06:48:19 (4 years ago)
Author:
maxter
Message:

Removed the time-based generator, sys and ipc packages. Added more API documentation.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/tango/scrapple/util/uuid/doc/NameUuidGen.html

    r50 r56  
    44    </head><body> 
    55    <h1>tango.scrapple.util.uuid.NameUuidGen</h1> 
    6     <!-- Generated by Ddoc from E:\d-projects\scrapple\tango\scrapple\util\uuid\NameUuidGen.d --> 
     6    <!-- Generated by Ddoc from NameUuidGen.d --> 
    77<b>License:</b><br> 
    88BSD style:  
     
    3131<br><br> 
    3232 
    33 <dl><dt><big>Uuid <u>newUuidSha1</u>(Uuid <i>nsUuid</i>, char[] <i>name</i>); 
     33<dl><dt><big>Uuid <u>newUuidSha1</u>(Uuid <i>nsUuid</i>, char[] <i>name</i>); 
    3434</big></dt> 
    3535<dd>Generates a name-based UUID using SHA-1 hashing algorithm (version 5 UUID). 
     
    4646 
    4747</dd> 
    48 <dt><big>Uuid <u>newUuidMd5</u>(Uuid <i>nsUuid</i>, char[] <i>name</i>); 
     48<dt><big>Uuid <u>newUuidMd5</u>(Uuid <i>nsUuid</i>, char[] <i>name</i>); 
    4949</big></dt> 
    5050<dd>Generates a name-based UUID using MD-5 hashing algorithm (version 3 UUID). 
  • trunk/tango/scrapple/util/uuid/doc/NativeUuidGen.html

    r50 r56  
    44    </head><body> 
    55    <h1>tango.scrapple.util.uuid.NativeUuidGen</h1> 
    6     <!-- Generated by Ddoc from E:\d-projects\scrapple\tango\scrapple\util\uuid\NativeUuidGen.d --> 
     6    <!-- Generated by Ddoc from NativeUuidGen.d --> 
    77<b>License:</b><br> 
    88BSD style:  
     
    2626<br><br> 
    2727 
    28 <dl><dt><big>Uuid <u>newUuid</u>(); 
     28<dl><dt><big>Uuid <u>newUuid</u>(); 
    2929</big></dt> 
    3030<dd>Generates a UUID using the safest method available on the target platform. 
     
    3737 
    3838</dd> 
    39 <dt><big>Uuid <u>newTimeUuid</u>(); 
     39<dt><big>Uuid <u>newTimeUuid</u>(); 
    4040</big></dt> 
    4141<dd>Generates a time-based (version 1) UUID if supported by the target platform. 
  • trunk/tango/scrapple/util/uuid/doc/RandomUuidGen.html

    r50 r56  
    44    </head><body> 
    55    <h1>tango.scrapple.util.uuid.RandomUuidGen</h1> 
    6     <!-- Generated by Ddoc from E:\d-projects\scrapple\tango\scrapple\util\uuid\RandomUuidGen.d --> 
     6    <!-- Generated by Ddoc from RandomUuidGen.d --> 
    77<b>License:</b><br> 
    88BSD style:  
     
    6969</dl> 
    7070</dd> 
    71 <dt><big>const RandomUuidGen!(int(*)()) <u>newUuid</u>; 
     71<dt><big>const RandomUuidGen!(int function()) <u>newUuid</u>; 
    7272</big></dt> 
    7373<dd>Generates a random UUID using the C runtime's random number generator. 
  • trunk/tango/scrapple/util/uuid/doc/Uuid.html

    r50 r56  
    1313<br><br> 
    1414 
    15         This module defines the 128-bit Universally Unique Identifier structure 
     15        This module defines a 128-bit Universally Unique Identifier structure 
    1616        conforming to Proposed Stardard RFC-4122. 
    1717 
     
    3737<dl><dt><big>enum <u>UuidVariant</u>; 
    3838</big></dt> 
    39 <dd>Uuid variants
     39<dd>The UUID variants. The UUID variant determines the layout of the UUID
    4040<br><br> 
    4141 
    4242<dl><dt><big><u>Ncs</u></big></dt> 
    43 <dd><br><br> 
     43<dd>Reserved, NCS backward compatibility. 
     44<br><br> 
     45 
    4446</dd> 
    4547<dt><big><u>Standard</u></big></dt> 
    46 <dd><br><br> 
     48<dd>The UUID is compatible with RFC-4122. 
     49<br><br> 
     50 
    4751</dd> 
    4852<dt><big><u>Microsoft</u></big></dt> 
    49 <dd><br><br> 
     53<dd>Reserved, Microsoft backward compatibility. 
     54<br><br> 
     55 
    5056</dd> 
    5157<dt><big><u>Future</u></big></dt> 
    52 <dd><br><br> 
     58<dd>Reserved for future definition. 
     59<br><br> 
     60 
    5361</dd> 
    5462</dl> 
     
    5664<dt><big>enum <u>UuidVersion</u>; 
    5765</big></dt> 
    58 <dd>Uuid versions
     66<dd>Versions of a standard UUID
    5967<br><br> 
    6068 
    6169<dl><dt><big><u>TimeBased</u></big></dt> 
    62 <dd><br><br> 
     70<dd>The time-based version. 
     71<br><br> 
     72 
    6373</dd> 
    6474<dt><big><u>Dce</u></big></dt> 
    65 <dd><br><br> 
     75<dd>The DCE security version, with embedded POSIX UIDs. 
     76<br><br> 
     77 
    6678</dd> 
    6779<dt><big><u>NameBasedMd5</u></big></dt> 
    68 <dd><br><br> 
     80<dd>The name-based version that uses MD5 hashing. 
     81<br><br> 
     82 
    6983</dd> 
    7084<dt><big><u>Random</u></big></dt> 
    71 <dd><br><br> 
     85<dd>The randomly or pseudo-randomly generated version. 
     86<br><br> 
     87 
    7288</dd> 
    7389<dt><big><u>NameBasedSha1</u></big></dt> 
    74 <dd><br><br> 
     90<dd>The name-based version specified that uses SHA1 hashing. 
     91<br><br> 
     92 
    7593</dd> 
    7694</dl> 
     
    83101<dl><dt><big>uint <u>timeLow</u>; 
    84102</big></dt> 
    85 <dd><br><br> 
     103<dd>The low field of the timestamp. 
     104<br><br> 
     105 
    86106</dd> 
    87107<dt><big>ushort <u>timeMid</u>; 
    88108</big></dt> 
    89 <dd><br><br> 
     109<dd>The middle field of the timestamp. 
     110<br><br> 
     111 
    90112</dd> 
    91113<dt><big>ushort <u>versionTimeHigh</u>; 
    92114</big></dt> 
    93 <dd><br><br> 
     115<dd>The high field of the timestamp multiplexed with the version number. 
     116<br><br> 
     117 
    94118</dd> 
    95119<dt><big>ubyte <u>variantClockSeqHigh</u>; 
    96120</big></dt> 
    97 <dd><br><br> 
     121<dd>The high field of the clock sequence multiplexed with the variant. 
     122<br><br> 
     123 
    98124</dd> 
    99125<dt><big>ubyte <u>clockSeqLow</u>; 
    100126</big></dt> 
    101 <dd><br><br> 
     127<dd>The low field of the clock sequence. 
     128<br><br> 
     129 
    102130</dd> 
    103131<dt><big>ubyte[6u] <u>node</u>; 
    104132</big></dt> 
    105 <dd><br><br> 
     133<dd>The spatially unique <u>node</u> identifier. 
     134<br><br> 
     135 
    106136</dd> 
    107137<dt><big><u>StringLength</u></big></dt> 
    108 <dd>Length of the string representation of a UUID, in UTF-8 characters (36). 
     138<dd>The length of the string representation of a UUID (36 characters). 
    109139         
    110140<br><br> 
     
    142172 
    143173</dd> 
    144 <dt><big>UuidVersion <u>ver</u>(UuidVersion <u>ver</u>); 
     174<dt><big>UuidVersion <u>ver</u>(UuidVersion <i>v</i>); 
    145175</big></dt> 
    146176<dd>Sets the UUID version. 
    147177<br><br> 
    148178<b>Params:</b><br> 
    149 <table><tr><td>UuidVersion <u>ver</u></td> 
     179<table><tr><td>UuidVersion <i>v</i></td> 
    150180<td>UUID version.</td></tr> 
    151181</table><br> 
     
    219249 
    220250</dd> 
    221 <dt><big>Uuid <u>opAssign</u>(char[] <i>str</i>); 
     251<dt><big>Uuid <u>opAssign</u>(char[] <i>str</i>); 
    222252</big></dt> 
    223253<dd>Parses the UUID string and assigns the result to this UUID. 
     
    235265 
    236266</dd> 
    237 <dt><big>Uuid <u>opAssign</u>(ubyte[] <i>octets</i>); 
     267<dt><big>Uuid <u>opAssign</u>(ubyte[] <i>octets</i>); 
    238268</big></dt> 
    239269<dd>Assigns the UUID octets arranged in network byte order to this UUID . 
     
    245275 
    246276</dd> 
    247 <dt><big>static Uuid <u>opCall</u>(uint <i>timeLow</i>, ushort <i>timeMid</i>, ushort <i>versionTimeHigh</i>, ubyte <i>variantClockSeqHigh</i>, ubyte <i>clockSeqLow</i>, ubyte[6u] <i>node</i>); 
     277<dt><big>static Uuid <u>opCall</u>(uint <i>timeLow</i>, ushort <i>timeMid</i>, ushort <i>versionTimeHigh</i>, ubyte <i>variantClockSeqHigh</i>, ubyte <i>clockSeqLow</i>, ubyte[6u] <i>node</i>); 
    248278</big></dt> 
    249279<dd>Creates a UUID from UUID field values. 
     
    252282 
    253283</dd> 
    254 <dt><big>static Uuid <u>opCall</u>(char[] <i>str</i>); 
     284<dt><big>static Uuid <u>opCall</u>(char[] <i>str</i>); 
    255285</big></dt> 
    256286<dd>Creates a new UUID from the supplied string. 
     
    263293 
    264294</dd> 
    265 <dt><big>char[] <u>opCast</u>(); 
    266 </big></dt> 
    267 <dd>Casts the UUID to its string representation. 
    268      
    269 <br><br> 
    270  
    271 </dd> 
    272 <dt><big>static Uuid  <u>opCall</u>(ubyte[] <i>octets</i>); 
     295<dt><big>static Uuid <u>opCall</u>(ubyte[] <i>octets</i>); 
    273296</big></dt> 
    274297<dd>Creates a UUID from octets arranged in network byte order.