Public API

Collaboration diagram for Public API:

Topics
	XXH32 family
	XXH64 family
	XXH3 family

Macros
#define	XXH_PUBLIC_API   /* do nothing */
#define	XXH_VERSION_MAJOR   0
#define	XXH_VERSION_MINOR   8
#define	XXH_VERSION_RELEASE   1
#define	XXH_VERSION_NUMBER   (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)

Enumerations
enum	XXH_errorcode {   XXH_OK =0 ,   XXH_ERROR }

Functions
XXH_PUBLIC_API unsigned	XXH_versionNumber (void)
	Obtains the xxHash version.
typedef unsigned long long	XXH64_hash_t

Detailed Description

Contains details on the public xxHash functions.

Macro Definition Documentation

XXH_PUBLIC_API

#define XXH_PUBLIC_API   /* do nothing */

XXH_VERSION_MAJOR

#define XXH_VERSION_MAJOR   0

XXH_VERSION_MINOR

#define XXH_VERSION_MINOR   8

XXH_VERSION_NUMBER

#define XXH_VERSION_NUMBER   (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)

XXH_VERSION_RELEASE

#define XXH_VERSION_RELEASE   1

Typedef Documentation

XXH64_hash_t

typedef unsigned long long XXH64_hash_t

Enumeration Type Documentation

XXH_errorcode

enum XXH_errorcode

Enumerator
XXH_OK
XXH_ERROR

Function Documentation

XXH_versionNumber()

XXH_PUBLIC_API unsigned XXH_versionNumber

(

void

)

Obtains the xxHash version.

This is mostly useful when xxHash is compiled as a shared library, since the returned value comes from the library, as opposed to header file.

Returns

XXH_VERSION_NUMBER of the invoked library.