OSDLBasic.h File Reference

#include "OSDLException.h"
#include "Ceylan.h"

Include dependency graph for OSDLBasic.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	OSDL
namespace	OSDL::Video
namespace	OSDL::Events
namespace	OSDL::Audio
Classes
class	OSDL::CommonModule
	Root of all OSDL modules. More...
Defines
#define	CHECK_OSDL_VERSIONS()
	Allows to ensure that the actual OSDL library being linked with is compatible with the one expected by the code that will use it (be it a library itself or a program).
Functions
const Ceylan::LibtoolVersion &	OSDL::GetVersion () throw ()
	Returns the version of the OSDL library currently linked.
void	OSDL::stop () throw ()
	Shutdowns all OSDL services.
OSDL_DLL CommonModule &	OSDL::getCommonModule (Ceylan::Flags flags) throw ()
	This friend function is intended to be the initial means of getting a reference to the common module : this is the entry point to the whole OSDL system.
bool	OSDL::hasExistingCommonModule () throw ()
	Tells whether there already exists a common module.
CommonModule &	OSDL::getExistingCommonModule () throw ()
	This function is intended to be the usual means of getting a reference to the common module, which must already exist.

---

Define Documentation

 

#define CHECK_OSDL_VERSIONS

(

)

Value:

Ceylan::LibtoolVersion headerVersion(                                \
            OSDL::actualOSDLHeaderLibtoolVersion ) ;                         \
        if ( ! /* library version */                                         \
                OSDL::GetVersion().isCompatibleWith( headerVersion ) )       \
            Ceylan::emergencyShutdown(                                       \
                "OSDL library version currently linked ("                    \
                + OSDL::GetVersion().toString()                              \
                + ") is not compatible with the one read from the OSDL "     \
                "header files used to compile this application ("            \
                + headerVersion.toString() + "), aborting." ) ;

Allows to ensure that the actual OSDL library being linked with is compatible with the one expected by the code that will use it (be it a library itself or a program).

The OSDL version is directly encoded in the library, whereas the version expected by a user program is found in this OSDL header file, according to the version being used to compile it.

Use this macro in your application that way : 'CHECK_OSDL_VERSIONS() ;' for example in the first lines of your 'main' function. Of course the main OSDL header file ('OSDL.h') should have been included previously.

This is a macro since it has to be evaluated within the user code environment, not when the OSDL library is built.

Definition at line 35 of file OSDLBasic.h.

---