.TH "rte_uuid.h" 3 "Version 25.11.0" "DPDK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
rte_uuid.h
.SH SYNOPSIS
.br
.PP
\fR#include <stdbool\&.h>\fP
.br
\fR#include <stddef\&.h>\fP
.br
\fR#include <string\&.h>\fP
.br

.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBRTE_UUID_INIT\fP(a,  b,  c,  d,  e)"
.br
.ti -1c
.RI "#define \fBRTE_UUID_STRLEN\fP   (36 + 1)"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "\fBtypedef\fP unsigned char \fBrte_uuid_t\fP[16]"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "bool \fBrte_uuid_is_null\fP (const \fBrte_uuid_t\fP uu)"
.br
.ti -1c
.RI "static void \fBrte_uuid_copy\fP (\fBrte_uuid_t\fP dst, const \fBrte_uuid_t\fP src)"
.br
.ti -1c
.RI "int \fBrte_uuid_compare\fP (const \fBrte_uuid_t\fP a, const \fBrte_uuid_t\fP b)"
.br
.ti -1c
.RI "int \fBrte_uuid_parse\fP (const char *in, \fBrte_uuid_t\fP uu)"
.br
.ti -1c
.RI "void \fBrte_uuid_unparse\fP (const \fBrte_uuid_t\fP uu, char *out, size_t len)"
.br
.in -1c
.SH "Detailed Description"
.PP 
UUID related functions originally from libuuid 
.PP
Definition in file \fBrte_uuid\&.h\fP\&.
.SH "Macro Definition Documentation"
.PP 
.SS "#define RTE_UUID_INIT( a,  b,  c,  d,  e)"
\fBValue:\fP
.nf
    {       \\
    ((a) >> 24) & 0xff, ((a) >> 16) & 0xff, \\
    ((a) >> 8) & 0xff, (a) & 0xff,      \\
    ((b) >> 8) & 0xff, (b) & 0xff,      \\
    ((c) >> 8) & 0xff, (c) & 0xff,      \\
    ((d) >> 8) & 0xff, (d) & 0xff,      \\
    ((e) >> 40) & 0xff, ((e) >> 32) & 0xff, \\
    ((e) >> 24) & 0xff, ((e) >> 16) & 0xff, \\
    ((e) >> 8) & 0xff, (e) & 0xff       \\
}
.PP
.fi
Helper for defining UUID values for id tables\&. 
.PP
Definition at line \fB29\fP of file \fBrte_uuid\&.h\fP\&.
.SS "#define RTE_UUID_STRLEN   (36 + 1)"
UUID string length 
.PP
Definition at line \fB41\fP of file \fBrte_uuid\&.h\fP\&.
.SH "Typedef Documentation"
.PP 
.SS "\fBtypedef\fP unsigned char rte_uuid_t[16]"
Struct describing a Universal Unique Identifier 
.PP
Definition at line \fB24\fP of file \fBrte_uuid\&.h\fP\&.
.SH "Function Documentation"
.PP 
.SS "bool rte_uuid_is_null (const \fBrte_uuid_t\fP uu)"
Test if UUID is all zeros\&.

.PP
\fBParameters\fP
.RS 4
\fIuu\fP The uuid to check\&. 
.RE
.PP
\fBReturns\fP
.RS 4
true if uuid is NULL value, false otherwise 
.RE
.PP

.SS "void rte_uuid_copy (\fBrte_uuid_t\fP dst, const \fBrte_uuid_t\fP src)\fR [inline]\fP, \fR [static]\fP"
Copy uuid\&.

.PP
\fBParameters\fP
.RS 4
\fIdst\fP Destination uuid 
.br
\fIsrc\fP Source uuid 
.RE
.PP

.PP
Definition at line \fB61\fP of file \fBrte_uuid\&.h\fP\&.
.SS "int rte_uuid_compare (const \fBrte_uuid_t\fP a, const \fBrte_uuid_t\fP b)"
Compare two UUID's

.PP
\fBParameters\fP
.RS 4
\fIa\fP A UUID to compare 
.br
\fIb\fP A UUID to compare 
.RE
.PP
\fBReturns\fP
.RS 4
returns an integer less than, equal to, or greater than zero if UUID a is is less than, equal, or greater than UUID b\&. 
.RE
.PP

.SS "int rte_uuid_parse (const char * in, \fBrte_uuid_t\fP uu)"
Extract UUID from string

.PP
\fBParameters\fP
.RS 4
\fIin\fP Pointer to string of characters to convert 
.br
\fIuu\fP Destination UUID 
.RE
.PP
\fBReturns\fP
.RS 4
Returns 0 on success, and -1 if string is not a valid UUID\&. 
.RE
.PP

.SS "void rte_uuid_unparse (const \fBrte_uuid_t\fP uu, char * out, size_t len)"
Convert UUID to string

.PP
\fBParameters\fP
.RS 4
\fIuu\fP UUID to format 
.br
\fIout\fP Resulting string buffer 
.br
\fIlen\fP Sizeof the available string buffer 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for DPDK from the source code\&.