version.h File Reference

Describe the Bayeux API version. More...

#include <iosfwd>

Go to the source code of this file.

Classes
struct	bayeux::version
	Describe the Bayeux API version and features. More...

Namespaces
	bayeux
	Top-level namespace of the Bayeux library.

Macros
#define	BAYEUX_VERSION_MAJOR   3
	Major version number of Bayeux. More...
#define	BAYEUX_VERSION_MINOR   4
	Minor version number of Bayeux. More...
#define	BAYEUX_VERSION_PATCH   1
	Patch version number of Bayeux. More...
#define	BAYEUX_VERSION_REVISION   0
	Current revision/build number of Bayeux, 0 for a release. More...
#define	BAYEUX_ENCODE_VERSION(major, minor, patch)
	Encode Bayeux to ordered integer available at compile time. More...
#define	BAYEUX_VERSION
	Integer encoded Bayeux version available at compile time. More...
#define	BAYEUX_LIB_VERSION   "3.4.1"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	BAYEUX_IS_AT_LEAST(major, minor, patch)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the Bayeux API version.

Querying the version of Bayeux is needed at both compile and runtime by clients so that they may adjust their usage.

Macro Definition Documentation

BAYEUX_ENCODE_VERSION

#define BAYEUX_ENCODE_VERSION	(		major,
			minor,
			patch
	)

Value:

(((major) * 10000)   \
                                                    + ((minor) *   100) \
                                                    + ((patch) *     1))

Encode Bayeux to ordered integer available at compile time.

BAYEUX_IS_AT_LEAST

#define BAYEUX_IS_AT_LEAST	(		major,
			minor,
			patch
	)

Value:

(BAYEUX_VERSION >=        \
                                               BAYEUX_ENCODE_VERSION(major,minor,patch))

Check current version >= (major, minor, patch) at compile time.

BAYEUX_LIB_VERSION

#define BAYEUX_LIB_VERSION   "3.4.1"

String encoded full version number, e.g. "1.2.3", available at compile time.

BAYEUX_VERSION

#define BAYEUX_VERSION

Value:

BAYEUX_ENCODE_VERSION(BAYEUX_VERSION_MAJOR,  \
                                             BAYEUX_VERSION_MINOR,  \
                                             BAYEUX_VERSION_PATCH)

Integer encoded Bayeux version available at compile time.

BAYEUX_VERSION_MAJOR

#define BAYEUX_VERSION_MAJOR   3

Major version number of Bayeux.

BAYEUX_VERSION_MINOR

#define BAYEUX_VERSION_MINOR   4

Minor version number of Bayeux.

BAYEUX_VERSION_PATCH

#define BAYEUX_VERSION_PATCH   1

Patch version number of Bayeux.

BAYEUX_VERSION_REVISION

#define BAYEUX_VERSION_REVISION   0

Current revision/build number of Bayeux, 0 for a release.