|
dxFeed Graal Native SDK 3.16.0
|
The dxfg_v4_ functions: the operations of the older functions of the C API in one uniform form.
The dxfg_v4_ functions: the operations of the older functions of the C API in one uniform form.
A function of the C API that has a dxfg_v4_ twin is deprecated in favour of it. The twin is declared in a dxfg_v4_<area>.h header next to the header of the older function (dxfg_v4_api.h and dxfg_api.h include all of them). dxfg_free_strings() and dxfg_free_string_to_double_map_entries() have no twin and are deprecated: the v4 functions return lists, released by their dxfg_v4_<element>_list_release() functions. The deprecated functions are removed in 4.0.0, the next major release; their deprecation warnings name the functions to move to. A twin does the same as the older function, only its form differs:
The dxfg_v4_ prefix names a generation of the C API, not a release of the SDK: the rules above hold for every function and type with this prefix, and later releases, major ones included, add functions with the same prefix. A new generation appears only when these rules change. It is named after the major release in which it becomes the only one: the v4 functions become the only ones in 4.0.0.
The v4 functions have two tiers:
The experimental functions are the twins of the Java API that is experimental (@Experimental in QD, and the transaction models taken from the experimental Java API), and the functions of the advanced headers: the dxfg_v4_*.h headers that dxfg_v4_api.h does not include, each one included on its own. The twins came out in 3.12.0, before the tiers, and are experimental since 3.13.0; their older functions stay until 4.0.0, as the other deprecated functions do, and their deprecation messages say that the replacement is experimental. An advanced header may include the basic headers, never the other way round. The experimental event types say so in their descriptions; their structures are delivered as the other events are. Every declaration added after 3.12.0 names the release that added it (@since).
The older and the v4 functions can be mixed on the same objects: a handle, a string or a list that one of them returned can be passed to the other one and released by the release function of either.
The older functions that have twins are marked with DXFG_DEPRECATED, so the compilers warn where they are used. To compile code that still uses them without the warnings, define the macro empty before the headers are included: #define DXFG_DEPRECATED(message) in the code, or -DDXFG_DEPRECATED(message)= on the command line of GCC and Clang. With MSVC, the warning is C4996 (/wd4996 disables it).
A wrapper for another language builds on these rules: Wrapper guide states what it may rely on and must do (threads, ownership, outcomes, versioning, delivery), and the conformance kit that checks it.