carb/Framework.h

↰ Parent directory: carb/

Core header for registering and acquiring interfaces.

Source: carb/Framework.h

Included By

• carb/assert/AssertUtils.h: Helper utility functions to modify assertion failure behaviour.

• carb/crashreporter/CrashReporterUtils.h: !

• carb/InterfaceUtils.h: Utilities for Carbonite Interface management.

• carb/l10n/L10nUtils.h: The L10n interface.

• carb/profiler/Profile.h: carb::profiler macros and helpers

• carb/BindingsUtils.h: Utilities for script bindings.

• carb/StartupUtils.h: Contains carb::startupFramework and carb::shutdownFramework. Consider using OMNI_CORE_INIT, which invokes these methods for you in a safe manner.

• carb/dictionary/DictionaryUtils.h: Utility helper functions for common dictionary operations.

• carb/dictionary/ISerializer.h: Interface to handle serializing data from a file format into an carb::dictionary::IDictionary item. This interface is currently implemented in two plugins, each offering a different input/output format - JSON and TOML. The plugins are called carb.dictionary.serializer-json.plugin and carb.dictionary.serializer-toml.plugin. The caller must ensure they are using the appropriate one for their needs when loading, the plugin, acquiring the interface, and performing serialization operations (both to and from strings).

• carb/extras/VariableSetup.h: Provides helper functions to retrieve setup variable values.

• carb/audio/AudioUtils.h: Inline utility functions for audio processing.

• carb/audio/AudioStreamerUtils.h: Helper classes for streaming data from carb::audio::IAudioPlayback.

• carb/events/EventsUtils.h: Helper utilities for carb::events.

• carb/extras/SharedMemory.h: Provides a helper class to manage a block of shared memory.

• carb/tasking/IFiberEvents.h: IFiberEvents definition file.

Namespaces

• carb: The main Carbonite namespace.

• carb::details: Internal definition detail.

Classes

• carb::AcquireInterfaceOptions: A structure used with Framework::internalAcquireInterface(). Typically callers should use one of the adapter functions such as Framework::tryAcquireInterface() and not use this directly.

• carb::Framework: Defines the framework for creating Carbonite applications and plugins.

• carb::PluginLoadingDesc: Describes parameters for finding plugins on disk. Multiple search paths, matching wildcards, and exclusion wildcards can be specified. Used primarily by Framework::loadPlugins.

• carb::PluginRegistrationDesc: Describes the different functions a plugin can define for use by carb::Framework.

Enums

• carb::AcquireInterfaceFlags: Flags for use with carb::AcquireInterfaceOptions.

• carb::LoadPluginResult: Result of loading a plugin. Used by carb::Framework::loadPlugin. Non-negative values indicated success.

Functions

• carb::acquireFramework: Acquire the Carbonite framework for an application.

• carb::carbGetSdkVersion: Retrieves the Carbonite SDK version string,.

• carb::details::setClientName: Sets the client name for the calling module.

• carb::getFramework: Gets the Carbonite framework.

• carb::isFrameworkValid: Returns true if the Carbonite framework has been created and is still alive. Creation happens at the first carb::acquireFramework call and ends at any carb::releaseFramework call.

• carb::quickReleaseFrameworkAndTerminate: Releases the Carbonite framework immediately and exits the process, without running C/C++ atexit() registered functions or static destructors.

• carb::releaseFramework: Releases the Carbonite framework immediately.

Defines

• CARB_FRAMEWORK_GLOBALS: Defines global variables for use by Carbonite. Call this macro from the global namespace.

• CARB_IS_SAME_SDK_VERSION: Tests whether the Carbonite SDK headers match the version of used to build the framework.

• CARBONITE_MAJOR: Defines the current major version of the Carbonite framework.

• CARBONITE_MINOR: Defines the current minor version of the Carbonite framework.

Typedefs

• carb::LoadHookFn: Load Hook function.

• carb::ReleaseHookFn: Release Hook function.

Variables

• carb::kCarb_FourCC: Four character code used to identify a carb::PluginRegistrationDesc object that is likely to have further data provided in it.

• carb::kFrameworkVersion: Defines the current version of the Carbonite framework.

• g_carbClientName: The client’s name.

• g_carbFramework: Defines the client’s global carb::Framework pointer.

• g_needToCall_CARB_GLOBALS_atGlobalScope: Global symbol to enforce the use of CARB_GLOBALS in Carbonite modules. Do not modify or use this value.