Overview
| Description | The Keyple Common API provides public interfaces shared by all Keyple libraries. |
| Intended Audience | All developers. |
| Compatible OS | Windows, Linux, macOS, Android. |
| Versioning Note | The third version digit x.y.Z refers only to documentation updates, as this component contains no implementation. |
Implementations
| Latest Version | 2.0.2 |
| Changelog | List of changes and new features introduced in each release. |
| GitHub | Source code repository and issue tracker for the Java project. |
| User Guide | Step-by-step guide to learn how to build a Keyple-based standalone application. |
| API Reference | Complete documentation of all classes and methods in the Java API. |
| UML Class Diagram | UML diagram showing the structure and relationships between classes. |
| Maven Central | Official Maven Central page to include the Java component in your project. |
| Latest Version | 2.0.1 |
| Release History | List of published releases and related release notes. |
| GitHub | Source code repository and documentation for the C++ project. |
| User Guide | Step-by-step guide to learn how to build a Keyple-based standalone application. |
| API Reference | Complete documentation of all classes and functions in the C++ API. |
| UML Class Diagram | UML class diagram of the Java implementation, from which the C++ code is derived. |
C++ Specific Information
Versioning
The Keyple C++ implementation is a transposition of the Java version. As a result, the C++ version may lag behind the Java version by one or more release cycles.
To make version correspondence explicit:
- The Java implementation follows Semantic Versioning (SemVer) with three digits:
MAJOR.MINOR.PATCH - The C++ implementation uses four digits:
MAJOR.MINOR.PATCH.CPP_FIX
In this scheme, the first three digits of the C++ version reflect the corresponding Java source version, while the fourth digit represents any C++-specific fixes or adjustments.
UML Class Diagrams
The class structure of the C++ implementation is directly inspired by the UML class diagrams of the Java version, ensuring conceptual and architectural consistency between both languages.
User Guides
The user guides mainly provide Java code snippets, but the same concepts and logic are directly transposable to the C++ implementation.