# README
Socket UUIDs for the M-Lab platform
This allows us to generate a globally unique ID for any TCP socket. When we say globally, we really mean globally - it should be impossible to have two machines generate the same UUID.
The only case the uniqueness of the UUID could be violated is if two machines have the same hostname and booted up at the exact same second in time, but it is bad practice to give machines the same hostname (so don't).
⚠️: This library is fully supported on Linux systems only. Using this library on non Linux system will compile but most likely will not work as intended. Use on non Linux systems at your own risk.
The design of the UUIDs and this system for creating them can be found in
DESIGN.md.
# Functions
FromCookie returns a string that is a globally unique identifier for the passed-in socket cookie.
FromFile returns a string that is a globally unique identifier for the socket represented by the os.File pointer.
FromTCPConn returns a string that is a globally unique identifier for the socket held by the passed-in TCPConn (assuming hostnames are unique).
SetUUIDPrefixFile allows the prefix filename to be passed in via a function call instead of via the command line.