Public API

Topics
	XXH32 family
	XXH64 family
	XXH3 family

Macros
#define	XXH_CAT(A, B)
#define	XXH_NAME2(A, B)
#define	XXH_IPREF(Id)
#define	XXHASH_H_5627135585666179   1
#define	XXH_PUBLIC_API   /* do nothing */
	Marks a global symbol.
#define	XXH_PUBLIC_API   /* do nothing */
	Marks a global symbol.
#define	XXH_CONSTF   /* disable */
#define	XXH_PUREF
#define	XXH_MALLOCF
#define	XXH_VERSION_MAJOR   0
#define	XXH_VERSION_MINOR   8
#define	XXH_VERSION_RELEASE   3
#define	XXH_VERSION_NUMBER   (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)
	Version number, encoded as two digits each.

Enumerations
enum	XXH_errorcode { XXH_OK = 0 , XXH_ERROR }
	Exit code for the streaming API. More...

Functions
XXH_PUBLIC_API XXH_CONSTF 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_CAT

#define XXH_CAT	(		A,
			B )

Value:

A##B

Definition at line 326 of file xxhash.h.

XXH_CONSTF

#define XXH_CONSTF   /* disable */

Definition at line 541 of file xxhash.h.

XXH_IPREF

#define XXH_IPREF

(

Id

)

Value:

XXH_NAME2(XXH_NAMESPACE, Id)

Definition at line 328 of file xxhash.h.

XXH_MALLOCF

#define XXH_MALLOCF

Definition at line 543 of file xxhash.h.

XXH_NAME2

#define XXH_NAME2	(		A,
			B )

Value:

XXH_CAT(A,B)

Definition at line 327 of file xxhash.h.

XXH_PUBLIC_API [1/2]

#define XXH_PUBLIC_API   /* do nothing */

Marks a global symbol.

Definition at line 458 of file xxhash.h.

XXH_PUBLIC_API [2/2]

#define XXH_PUBLIC_API   /* do nothing */

Marks a global symbol.

Definition at line 458 of file xxhash.h.

XXH_PUREF

#define XXH_PUREF

Definition at line 542 of file xxhash.h.

XXH_VERSION_MAJOR

#define XXH_VERSION_MAJOR   0

Definition at line 549 of file xxhash.h.

XXH_VERSION_MINOR

#define XXH_VERSION_MINOR   8

Definition at line 550 of file xxhash.h.

XXH_VERSION_NUMBER

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

Version number, encoded as two digits each.

Definition at line 553 of file xxhash.h.

XXH_VERSION_RELEASE

#define XXH_VERSION_RELEASE   3

Definition at line 551 of file xxhash.h.

XXHASH_H_5627135585666179

#define XXHASH_H_5627135585666179   1

Definition at line 447 of file xxhash.h.

Typedef Documentation

XXH64_hash_t

typedef unsigned long long XXH64_hash_t

Definition at line 875 of file xxhash.h.

Enumeration Type Documentation

XXH_errorcode

enum XXH_errorcode

Exit code for the streaming API.

Enumerator
XXH_OK	OK
XXH_ERROR	Error

Definition at line 573 of file xxhash.h.

Function Documentation

XXH_versionNumber()

XXH_PUBLIC_API XXH_CONSTF 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.