Generate C++ for an AsyncAPI Specification
Project description
AsyncAPI Codegen
This 3rd-party open source tool creates C++ interfaces according to AsyncAPI specifications. Currently, only MQTT is supported.
Python Generator
The Python3 generator interprets a AsyncAPI specification and uses jinja2 templates to create a number of C++ sources and headers.
The AsyncAPI must be format-decoded first, using a JSON or YAML parser. The resulting parsed structure is then passed to the generator.
The generator interprets the specification directly. For example, if the specification defines a publish
operation, the generator creates code for publishing.
Output files
The generator creates the following types of output files:
- client interface. This is the main interface for publishing or subscribing to messages.
- servers. Represents a connection to a server. Currently, only unauthenticated MQTT connections are supported. A server object is provided to a client interface to establish the connection to the broker/server.
- parameters. These are just schema objects.
- messages. Currently, these are just schema objects. However, in the future these objects will also take protocol-specific message bindings.
- schemas. These are structures that always enforce schema compliance and provide (de-)serialization methods to rapidjson Value objects (which can thus be used to create JSON strings).
Generated code files should be annotated for doxygen document generation, or at least that is the goal.
Installation
pip3 install asyncapi-codegen
Python requirements for running code generator
See also requirements.txt
- python 3.7
- jinja2
- stringcase
- json-schema-codegen
- pyyaml
C++ requirements for generated code
- boost (boost::optional and boost::variant among others)
- rapidjson
- C++11
License
GPLv2
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for asyncapi_codegen-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8077c0a364c52a65e03671c298437d30420b0c1c34e2eceec74599cee694c68 |
|
MD5 | 6115322751499677e86c464bc9c14f02 |
|
BLAKE2b-256 | 0f3fa35e6560a39bfd713b72e89072e0a90d8b87462e3b721d9d7a434944f3c0 |