XDK API  3.6.0
Documentation
Macros | Functions
Serval_Version.h File Reference

Interface to query the version of the communication stack. More...

Macros

#define CURRENT_SERVAL_VERSION   SERVAL_VERSION(SERVAL_VERSION_MAJOR, SERVAL_VERSION_MINOR, SERVAL_VERSION_PATCH)
 
#define SERVAL_VERSION(major, minor, patch)   (((major) << 16) + ((minor) << 8) + (patch))
 
#define SERVAL_VERSION_MAJOR   2
 
#define SERVAL_VERSION_MINOR   0
 
#define SERVAL_VERSION_PATCH   0
 

Functions

unsigned int Version_getMajor (void)
 
unsigned int Version_getMinor (void)
 
unsigned int Version_getPatch (void)
 
unsigned int Version_getRevision (void)
 

Detailed Description

This file provides functions that allow the developer to obtain version information about the currently used communication stack.

Macro Definition Documentation

The current serval version

#define SERVAL_VERSION (   major,
  minor,
  patch 
)    (((major) << 16) + ((minor) << 8) + (patch))

This is a macro to help compare version numbers in code. Use to compare against the current serval version:

e.g. #if CURRENT_SERVAL_VERSION < SERVAL_VERSION(1,4,0) #error "Require at least version 1.4 of the serval stack #endif

See also
CURRENT_SERVAL_VERSION
Since
1.4.0
#define SERVAL_VERSION_MAJOR   2

This macro gives the major version of the stack

#define SERVAL_VERSION_MINOR   0

This macro gives the minor version of the stack

#define SERVAL_VERSION_PATCH   0

This macro gives the version of latest patch applied to the stack

Function Documentation

unsigned int Version_getMajor ( void  )

Returns the major version number of the communication stack.

Returns
The major version number of the stack.
unsigned int Version_getMinor ( void  )

Returns the minor version number of the communication stack.

Returns
The minor version number of the stack.
unsigned int Version_getPatch ( void  )

Returns the patch version number of the communication stack.

Returns
The patch version number of the stack.
unsigned int Version_getRevision ( void  )

Returns the build revision number of the communication stack. This number is only non-zero in development builds of the stack. For releases this number will always be zero.

Returns
The build revision number of the stack.

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:46 by doxygen 1.8.8