diff options
| author | Jack Lloyd <[email protected]> | 2017-01-04 13:08:29 -0500 |
|---|---|---|
| committer | Jack Lloyd <[email protected]> | 2017-01-04 13:08:29 -0500 |
| commit | bb935199499b96f4a544bedc3f5367039e947e81 (patch) | |
| tree | f69760b2b01a3d85f03084a51e6d95c32fe55263 /doc | |
| parent | ddbacb3b1e874c68bd60f3fd32f6a7fd3bbcade3 (diff) | |
Add botan_ffi_supports_api function
This lets us upgrade the FFI version over time and still allow
applications to reliably detect if the current library binary
supports their version.
As an example, it would be useful to be able to add features to FFI
sometime in 2.x. In that case, we would increase the value of the
FFI API version, even though anything calling the old API would still
work perfectly. Applications can verify at runtime the API they want to
use is supported using this new call.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/ffi.rst | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/manual/ffi.rst b/doc/manual/ffi.rst index 7a01dc8ae..b7a0d750f 100644 --- a/doc/manual/ffi.rst +++ b/doc/manual/ffi.rst @@ -14,7 +14,17 @@ Versioning .. cpp:function:: uint32_t botan_ffi_api_version() - Returns the FFI version + Returns the version of the currently supported FFI API. This is + expressed in the form YYYYMMDD of the release date of this version + of the API. + +.. cpp:function int botan_ffi_supports_api(uint32_t version) + + Return 0 iff the FFI version specified is supported by this + library. Otherwise returns -1. The expression + botan_ffi_supports_api(botan_ffi_api_version()) will always + evaluate to 0. A particular version of the library may also support + other (older) versions of the FFI API. .. cpp:function:: const char* botan_version_string() |