stinger-ipc 0.0.10__py3-none-any.whl → 0.0.26__py3-none-any.whl

{stinger_ipc-0.0.10.dist-info → stinger_ipc-0.0.26.dist-info}/METADATA

@@ -1,11 +1,12 @@
 Metadata-Version: 2.4
 Name: stinger-ipc
-Version: 0.0.10
+Version: 0.0.26
 Summary: Tools to create code to do IPC over MQTT
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: jacobs-jinja-too>=0.2.4
+Requires-Dist: jacobs-jinja-too>=0.2.5
+Requires-Dist: jacobs-json-schema>=0.4.2
 Requires-Dist: packaging>=25.0
 Requires-Dist: pydantic>=2.11.7
 Requires-Dist: pyyaml>=6.0.2

{stinger_ipc-0.0.10.dist-info → stinger_ipc-0.0.26.dist-info}/RECORD

@@ -1,57 +1,63 @@
-stinger_ipc-0.0.10.dist-info/licenses/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
+stinger_ipc-0.0.26.dist-info/licenses/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
 stingeripc/__init__.py,sha256=PTr5WfMfB-GL4vp3-XMU8IwGv3Q5RXQ24H7JuEo3hdk,133
 stingeripc/args.py,sha256=x3P8GRu9-jyiMl62t0FPqbWY18FbhMVN4eSa2UzUv6c,3960
-stingeripc/asyncapi.py,sha256=DJZuz_LiQEJjQGlnfRtgOToWVD55uLw5ZoiZ95-bxZc,23291
-stingeripc/components.py,sha256=B08bXGrhVy90i3S67uS1kXDC3jQb_2bQay_LbgzWhQ4,38426
+stingeripc/asyncapi.py,sha256=yyHDIM2Hm8stAPGmcuCostQ7Tk_YzVOqA2jAiqyp7j4,23445
+stingeripc/components.py,sha256=xPVgrnDZhHuG0wAswvT1Lx6gQiWDUIvrEkVgVGiE578,40830
 stingeripc/connection.py,sha256=DfBG9LKaEuGacmX5NPphDabJqJmO3tVUg8Oa-efCd7w,184
 stingeripc/exceptions.py,sha256=nX5Xl4KjPTfSRTVZIB9NkgM0g_6auXgr5fTyunCZy5Q,51
 stingeripc/interface.py,sha256=ypt4T7hTH7ePKLy3JCl1b1ggyH5T38m68Gt0m_5VOBM,1558
 stingeripc/lang_symb.py,sha256=MOIMj9_mj6_8IADXCJf-EvlZ5d7Y6yR4QWsCONcw-T8,3331
 stingeripc/topic.py,sha256=mIL6Abf3fcI0yeSGj_o9ulV6xFNIfyfwGZ5joEVXyzE,2404
+stingeripc/schema/schema.yaml,sha256=mck4f3zl0PuLlVJH7wS9JfsMySp_Diup43ytDje6sPk,4772
 stingeripc/templates/cpp/CMakeLists.txt.jinja2,sha256=jXlF2GOAt1mBsm6JqPZGaRr53NV5oJsfTd6nedeJ-GA,945
-stingeripc/templates/cpp/examples/client_main.cpp.jinja2,sha256=llUcuT4_R4SA5Nhpg6pRjs8nMogD5M21n6_aaewTJwE,2630
+stingeripc/templates/cpp/examples/client_main.cpp.jinja2,sha256=Xgn5DfHPCFJ0Pfbcd9PKXiAhG54PLhwr60twEp-0mjY,3625
 stingeripc/templates/cpp/examples/server_main.cpp.jinja2,sha256=AvkkZX_jbB3xYL7W04ZKna_rE4fL8l1PN8b5pq9WrCU,1523
-stingeripc/templates/cpp/include/broker.hpp.jinja2,sha256=5VQ2k3EXavBlXjBfSykjH0YqhwTA_upDcVz_aIptwho,5569
-stingeripc/templates/cpp/include/client.hpp.jinja2,sha256=ap5gCYpTicYHRa0a97Ta9X836UxHNwErE0jM5H4Nmjg,2714
+stingeripc/templates/cpp/include/broker.hpp.jinja2,sha256=-huaBDU-YHTbDdKNQ3tYKvtCZlW6mBBqC0rJ44_afkw,5467
+stingeripc/templates/cpp/include/client.hpp.jinja2,sha256=ksng3hCp3dusEVz5CfUskgDJthnK3d_8HY4N0dwngRM,6155
 stingeripc/templates/cpp/include/enums.hpp.jinja2,sha256=psTnV1KXr72RfL4ufdtX8BO0Ub_CJm9Uj5h8UUM_-uI,598
-stingeripc/templates/cpp/include/ibrokerconnection.hpp.jinja2,sha256=KH73Jk6FqZ4MovN2bKSzgjKN-tufm3AxGsFRkT9USc4,1829
-stingeripc/templates/cpp/include/property_structs.hpp.jinja2,sha256=ndEUE-1A5l0aMFvd8n1R_3_eCMYLh1FosEFMh2LKbao,263
+stingeripc/templates/cpp/include/ibrokerconnection.hpp.jinja2,sha256=yKPTaHHcs6yFpcI5hYMHCWBzZCKGXl_vz3IAm9n8LU4,2154
+stingeripc/templates/cpp/include/property_structs.hpp.jinja2,sha256=rqknyWgG9P7q8oYIqNnFofyJhxyJ839SkaWa1rxwnfg,1793
 stingeripc/templates/cpp/include/return_types.hpp.jinja2,sha256=qFBkvNG0m4XT7sCVCjuE0cDoROp5Fq4XXiWUt6DwEho,528
-stingeripc/templates/cpp/include/server.hpp.jinja2,sha256=LSLf-Og2R1atstOSOJFuiOzBCEqFfXorJbC1IT1TZNY,2033
-stingeripc/templates/cpp/include/structs.hpp.jinja2,sha256=DJAAq07DWJmYAEI9An5yxD2YHbA0Vwv11xR5MgcQdmM,507
-stingeripc/templates/cpp/src/broker.cpp.jinja2,sha256=32bfKFJIzHe8w4JKZKjJ-wv8vVrYtOULyRK8f2lF1ow,9345
-stingeripc/templates/cpp/src/client.cpp.jinja2,sha256=lfIbb-Usnru44-5EmrAGzjFiLqkoiSt-9VYkIrugXSI,9010
-stingeripc/templates/cpp/src/server.cpp.jinja2,sha256=hs27uqLCwYR_1cvhwZwGiXTpEnsoBiGlMJE0pbY5cPg,7765
-stingeripc/templates/html/app.js.jinja2,sha256=07USEiNgd1euaahPTz3tfcV-aFKEBX83NAVgYVbvr98,4110
-stingeripc/templates/html/index.html.jinja2,sha256=egY_0riMki6czNQLTldOMlRdapFKNMouDfwMIcnDtuo,2155
-stingeripc/templates/html/styles.css.jinja2,sha256=C0-ZZk4SIzG9dv9x9MrfhHrtkHBj7jRBFIQ98BFlrcg,3323
-stingeripc/templates/markdown/index.md.jinja2,sha256=yB1Jpawc1VdBAzmnCI0ikdvVlcjZXf-2xRs159XSnHg,6432
+stingeripc/templates/cpp/include/server.hpp.jinja2,sha256=Pg4LTkq2nS9W1naH6OpqH3TJwhIO47QaW9jFw9jLH5U,2004
+stingeripc/templates/cpp/include/structs.hpp.jinja2,sha256=Fzm2cUSCwSdAcGyzq258YPZaYxmjfZVyVWwXlrLc-js,639
+stingeripc/templates/cpp/partials/args.jinja2,sha256=jJYp_290Q21schBItazlf8bd60vbt42kjmW-VwgFATY,336
+stingeripc/templates/cpp/partials/deserialize.jinja2,sha256=VwmsnpdHEQAXG7hD_MrmaiVjV6HazwoIXsjeoMfSSNY,1492
+stingeripc/templates/cpp/partials/serialize.jinja2,sha256=iT1pNwT1m9ECb068HGn4U94CVVGBqgGpDPocpK0VuIA,826
+stingeripc/templates/cpp/src/broker.cpp.jinja2,sha256=bBSSLjnJXpHHWhghf-SljJ825nsrQaTOBoOIzoXLbp4,10368
+stingeripc/templates/cpp/src/client.cpp.jinja2,sha256=BQujzcyN9XnZZ-92U-psggkFNayj5NL6LZxsJeqQCdM,12368
+stingeripc/templates/cpp/src/property_structs.cpp.jinja2,sha256=e7K3tGhZZ9iekEYOJvcPmhWCAonOTVMKwCQI39tfyZ4,939
+stingeripc/templates/cpp/src/server.cpp.jinja2,sha256=c9XeBzfC2uIxpkpRGPmKHZV11tpSWmRX19ZGkMDO9lo,7001
+stingeripc/templates/cpp/src/structs.cpp.jinja2,sha256=w4DSPqWf7r01lhuwwCbyoVwmUr5W1GqC2G8x_G3O_Gk,493
+stingeripc/templates/html/app.js.jinja2,sha256=hbwXzV2JaSu8r-riDMp1eyw-xbG5_EjhH3gpblpvboI,8352
+stingeripc/templates/html/index.html.jinja2,sha256=uu3bCfQyPbcrJToPVq9W0zCrfmLeFeKPfHgv5upW2Vw,6004
+stingeripc/templates/html/styles.css.jinja2,sha256=kPasL4hXp8F9y7FtPgchDCl5qoZgfPsDIvkZPyE_Mog,6706
+stingeripc/templates/markdown/index.md.jinja2,sha256=Fbr6qvstccE4nFN8KIMrCRs7caWS2YU6eEJT5cEB8CY,11976
 stingeripc/templates/python/__init__.py.jinja2,sha256=jdZ07ogzJLOgzqqkHjj2_8hld9uBDnvB1DXPXnWkt98,22
 stingeripc/templates/python/client.py.jinja2,sha256=lUlnh-Z2ulDaomx-bR7RAgovmZ4QYLjck0c_885x8DY,16461
 stingeripc/templates/python/connection.py.jinja2,sha256=mTiiC_p4AEwIGH9mvyzYDdu_AKxpI_548LpapL5CM-4,7238
 stingeripc/templates/python/interface_types.py.jinja2,sha256=BcCD0uCzDn1TAn1IvWhHiOsai6MczIBu12Xg0snTHk8,1711
 stingeripc/templates/python/method_codes.py.jinja2,sha256=74i8iKk4Fu9_nE2SYTRrRK2G4mogfJx88ihbmjyfYVQ,1089
 stingeripc/templates/python/pyproject.toml.jinja2,sha256=R-rgSv6RTdgPINvhCwJ180Vzjy9-WkqtLbLgnCov3CI,195
-stingeripc/templates/python/server.py.jinja2,sha256=pxjzLPE7k3DG6zE-zXyK_I16ZF8k-xgbdh_182Fx_E8,11217
+stingeripc/templates/python/server.py.jinja2,sha256=oK5fy2YfkJXfpzM46zLann9sATRUzP_qJxuol5GGDWI,18253
 stingeripc/templates/rust/Cargo.toml.jinja2,sha256=teIu5y2AeqSkk0eUPT8CemvzmhRoblCUP5jdmonLfY4,70
 stingeripc/templates/rust/client/Cargo.toml.jinja2,sha256=oymbdtF3apgD4nVxt-fa9__hSZaUFsvjA0AxJarPMGw,858
 stingeripc/templates/rust/client/examples/client.rs.jinja2,sha256=pMLR-xyEJrK4289XUbFEB18HKe3kaRJDoeFBQ89SLU4,2075
-stingeripc/templates/rust/client/src/lib.rs.jinja2,sha256=7GGy_IBH-DBHIZUCvvBq1xbTTVVMczvx5W-i0qO_fvw,15451
+stingeripc/templates/rust/client/src/lib.rs.jinja2,sha256=S8aFZJ9EmErCXAFCY2MuQcnBK_y6_Brh-TlaRVs5sow,16950
 stingeripc/templates/rust/payloads/Cargo.toml.jinja2,sha256=t6WQ5BCBvjagCW8AgK4VYSNjW2OZCX30KQTXk27SGwI,739
 stingeripc/templates/rust/payloads/examples/pub_and_recv.rs.jinja2,sha256=cIbunwEwYGbkRO1lzi2nGNX2dGdFhAJ2ZZqFhphY7CY,1461
-stingeripc/templates/rust/payloads/src/handler.rs.jinja2,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 stingeripc/templates/rust/payloads/src/lib.rs.jinja2,sha256=3vBn2OGm_j7BoyHRHLcH1e0hKRBiqtbgHsz04rTaVMM,86
 stingeripc/templates/rust/payloads/src/payloads.rs.jinja2,sha256=1PUSzmHLMBYsVaCR8gOMdHWK8dmODmLM3WSu9iysN-c,4380
 stingeripc/templates/rust/server/Cargo.toml.jinja2,sha256=t2MIpoe34RYOtxvpS6ma7W0A9sLlMQBYblpALU805TQ,573
-stingeripc/templates/rust/server/examples/server.rs.jinja2,sha256=NVNR_kamR3t4FSpfYGfao0S9DpK1zXTQcOZR1WDPAaI,3624
-stingeripc/templates/rust/server/src/lib.rs.jinja2,sha256=OE9WxOUmKLc1iii8iXKn5BAwMpP9HXrIYcGdmZnQG7U,14973
+stingeripc/templates/rust/server/examples/server.rs.jinja2,sha256=L8Cgs1Wb1HFLyMqF0EARUtrgqoxXly6u4kaSElaNrHo,4851
+stingeripc/templates/rust/server/src/lib.rs.jinja2,sha256=rhackDGeDndEXoNXoldsc-jr7I-nP2uYKTZSnWXOaIU,15675
 stingeripc/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-stingeripc/tools/cli.py,sha256=oLfVQx4EqRgZ2AH9Xl7X6neXle-aJE55bSXTEvH7RDE,2303
+stingeripc/tools/cli.py,sha256=RqeL6FcoeUCvle86jmox-4A25SL4Br2CSZXPKbaJwlY,3372
+stingeripc/tools/cpp_generator.py,sha256=jYIRVjykI4corEI65CsA7q42psFxfkgskasYcSXSbqY,3111
 stingeripc/tools/markdown_generator.py,sha256=HVEWcMjAfVnuWY29kxfAW1mvSxQSF-rdYFA2kWdLOn0,1174
 stingeripc/tools/python_generator.py,sha256=GJwGI6DntkJPJjHN4xSeTD60KgY32gI43IvIByxWSsw,1845
-stingeripc/tools/rust_generator.py,sha256=9E7SMDM-iHE3O26QI3ieAHIInlrLepWMAFRnflKk3KI,2235
-stinger_ipc-0.0.10.dist-info/METADATA,sha256=IWuujmhLBXd10UkK5gE5TMYfPHdPY1JTzev_X75npgs,6038
-stinger_ipc-0.0.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-stinger_ipc-0.0.10.dist-info/entry_points.txt,sha256=bh8k8mvtAog4MKTd82ALSHqQkuD069VrZ-vNlde6XjE,204
-stinger_ipc-0.0.10.dist-info/top_level.txt,sha256=mSNwAf83_1qiTP_vu7XEPBrZu-fDusT1FFyQZzCrRcU,11
-stinger_ipc-0.0.10.dist-info/RECORD,,
+stingeripc/tools/rust_generator.py,sha256=Im0EdNifxkGDnZy2JCuvKzmn1h2suk6EJ_xtpGZazGk,2240
+stinger_ipc-0.0.26.dist-info/METADATA,sha256=dIRomA-GKMIZRvcna1tVp-6QoanVoZ4wfRUT6rbu2Yk,6079
+stinger_ipc-0.0.26.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+stinger_ipc-0.0.26.dist-info/entry_points.txt,sha256=bh8k8mvtAog4MKTd82ALSHqQkuD069VrZ-vNlde6XjE,204
+stinger_ipc-0.0.26.dist-info/top_level.txt,sha256=mSNwAf83_1qiTP_vu7XEPBrZu-fDusT1FFyQZzCrRcU,11
+stinger_ipc-0.0.26.dist-info/RECORD,,

stingeripc/asyncapi.py

@@ -571,6 +571,9 @@ class StingerToAsyncApi:
                     add_arg(arg_spec)
                     resp_msg_schema.add_value_dependency(arg_spec.name, "result", 0)
             elif method_spec.return_value is not None:
+                assert isinstance(
+                    method_spec.return_value, Arg
+                ), "Method return value must be a primitive or enum"
                 add_arg(method_spec.return_value)
                 resp_msg_schema.add_value_dependency(
                     method_spec.return_value_name, "result", 0

stingeripc/components.py

@@ -79,6 +79,10 @@ class Arg:
     def rust_local_type(self) -> str:
         return self.rust_type
 
+    @property
+    def cpp_type(self) -> str:
+        return stringmanip.upper_camel_case(self.name)
+
     @classmethod
     def new_arg_from_stinger(
         cls, arg_spec: YamlArg, stinger_spec: StingerSpec | None = None
@@ -107,32 +111,40 @@ class Arg:
         if arg_spec["type"] == "enum":
             if "enumName" not in arg_spec:
                 raise InvalidStingerStructure(f"Enum args need a 'enumName'")
+            if not isinstance(arg_spec["enumName"], str):
+                raise InvalidStingerStructure("'enumName' in arg structure must be a string")
             if arg_spec["enumName"] not in stinger_spec.enums:
                 raise InvalidStingerStructure(
                     f"Enum arg '{arg_spec['enumName']}' was not found in the list of stinger spec enums"
                 )
-            arg = ArgEnum(
+            enum_arg = ArgEnum(
                 arg_spec["name"], stinger_spec.get_interface_enum(arg_spec["enumName"])
             )
             if opt := arg_spec.get("optional", False):
-                arg.optional = opt
-            arg.try_set_description_from_spec(arg_spec)
-            return arg
+                if not isinstance(opt, bool):
+                    raise InvalidStingerStructure("'optional' in arg structure must be a boolean")
+                enum_arg.optional = opt
+            enum_arg.try_set_description_from_spec(arg_spec)
+            return enum_arg
 
         if arg_spec["type"] == "struct":
             if "structName" not in arg_spec:
                 raise InvalidStingerStructure("Struct args need a 'structName'")
+            if not isinstance(arg_spec["structName"], str):
+                raise InvalidStingerStructure("'structName' in arg structure must be a string")
             if arg_spec["structName"] not in stinger_spec.structs:
                 raise InvalidStingerStructure(
                     f"Struct arg '{arg_spec["structName"]}' was not found in the list of stinger spec structs"
                 )
-            arg = ArgStruct(
+            st_arg = ArgStruct(
                 arg_spec["name"], stinger_spec.structs[arg_spec["structName"]]
             )
             if opt := arg_spec.get("optional", False):
-                arg.optional = opt
-            arg.try_set_description_from_spec(arg_spec)
-            return arg
+                if not isinstance(opt, bool):
+                    raise InvalidStingerStructure("'optional' in arg structure must be a boolean")
+                st_arg.optional = opt
+            st_arg.try_set_description_from_spec(arg_spec)
+            return st_arg
         raise RuntimeError(f"unknown arg type: {arg_spec['type']}")
 
     @abstractmethod
@@ -240,6 +252,8 @@ class ArgPrimitive(Arg):
     @property
     def cpp_temp_type(self) -> str:
         if self._arg_type == ArgPrimitiveType.STRING:
+            if self.optional:
+                return "boost::optional<std::string>"
             return "std::string"
         else:
             return self.cpp_type
@@ -288,6 +302,10 @@ class ArgPrimitive(Arg):
             raise InvalidStingerStructure("No 'type' in arg structure")
         if "name" not in arg_spec:
             raise InvalidStingerStructure("No 'name' in arg structure")
+        if not isinstance(arg_spec["type"], str):
+            raise InvalidStingerStructure("'type' in arg structure must be a string")
+        if not isinstance(arg_spec["name"], str):
+            raise InvalidStingerStructure("'name' in arg structure must be a string")
 
         arg_primitive_type = ArgPrimitiveType.from_string(arg_spec["type"])
         arg: ArgPrimitive = cls(name=arg_spec["name"], arg_type=arg_primitive_type)
@@ -333,6 +351,10 @@ class ArgStruct(Arg):
     def markdown_type(self) -> str:
         return f"[Struct {self._interface_struct.class_name}](#enum-{self._interface_struct.class_name})"
 
+    @property
+    def cpp_rapidjson_type(self) -> str:
+        return "Object"
+
     def get_random_example_value(self, lang="python", seed: int = 2) -> str | None:
         example_list: dict[str, str] = {
             a.name: str(a.get_random_example_value(lang, seed=seed))
@@ -688,6 +710,8 @@ class Property(InterfaceComponent):
             prop_obj.add_arg(new_arg)
 
         if r_o := prop_spec.get("readOnly", False):
+            if not isinstance(r_o, bool):
+                raise InvalidStingerStructure("'readOnly' in property structure must be a boolean")
             prop_obj._read_only = r_o
 
         prop_obj.try_set_documentation_from_spec(prop_spec)
@@ -749,6 +773,11 @@ class InterfaceEnum:
     @property
     def values(self):
         return self._values
+    
+    def value_description(self, index: int) -> str | None:
+        if index < 0 or index >= len(self._value_descriptions):
+            return None
+        return self._value_descriptions[index]
 
     @classmethod
     def new_enum_from_stinger(cls, name, enum_spec: YamlIfaceEnum) -> InterfaceEnum:
@@ -756,7 +785,12 @@ class InterfaceEnum:
         for enum_obj in enum_spec.get("values", []):
             assert isinstance(enum_obj, dict), f"Enum values must be a dicts."
             if "name" in enum_obj and isinstance(enum_obj["name"], str):
-                ie.add_value(enum_obj["name"], enum_obj.get("description", None))
+                value_description = enum_obj.get("description", None)
+                if value_description is not None and not isinstance(value_description, str):
+                    raise InvalidStingerStructure(
+                        f"InterfaceEnum '{name}' item descriptions must be strings."
+                    )
+                ie.add_value(enum_obj["name"], description=value_description)
             else:
                 raise InvalidStingerStructure(
                     f"InterfaceEnum '{name}' items must have string names."
@@ -834,9 +868,14 @@ class InterfaceStruct:
     ) -> InterfaceStruct:
         istruct = cls(name)
         for memb in spec.get("members", []):
+            if not isinstance(memb, dict):
+                raise InvalidStingerStructure("Struct members must be dicts")
             arg = Arg.new_arg_from_stinger(memb, stinger_spec=stinger_spec)
             istruct.add_member(arg)
-        istruct._description = spec.get("description", None)
+        description = spec.get("description", None)
+        if description is not None and not isinstance(description, str):
+            raise InvalidStingerStructure("Struct description must be a string")
+        istruct._description = description
         return istruct
 
     def __str__(self) -> str:
@@ -948,6 +987,18 @@ class StingerSpec:
         }
         return (self._topic_creator.interface_info_topic(), info)
 
+    @property
+    def summary(self) -> str:
+        return self._summary or ""
+    
+    @property
+    def title(self) -> str:
+        return self._title or self._name or ""
+    
+    @property
+    def documentation(self) -> str:
+        return self._documentation or ""
+
     def add_broker(self, broker: Broker):
         assert broker is not None
         self._brokers[broker.name] = broker

stingeripc/schema/schema.yaml

@@ -0,0 +1,240 @@
+$id: "https://stingeripc.peargrove.com/stingeripc.schema.yaml"
+$schema: "http://json-schema.org/draft-07/schema#"
+description: |
+  This schema is used to validate StingerIPC stinger files.
+type: object
+
+properties:
+
+  stingeripc:
+    type: object
+    properties:
+      version:
+        type: string
+        const: "0.0.7"
+    required:
+      - version
+
+  interface:
+    type: object
+    parameters:
+      name:
+        type: string
+        pattern: "[a-zA-Z0-9_]+"
+        maxLength: 32
+        description: "A short token that will be used to create class names, folder names, filenames, etc."
+      title:
+        type: string
+        maxLength: 64
+        description: "A few words that are the title for the API.  Used at the top of documentation, etc.  The interface name is used if not provided."
+      summary:
+        type: string
+        description: "A one sentence description of the service."
+        maxLength: 128
+      version:
+        type: string
+        maxLength: 32
+      documentation:
+        $ref: "#/$defs/documentation"
+    required:
+      - name
+      - version
+  
+  brokers:
+    type: object
+    additionalProperties:
+      type: object
+      properties:
+        host:
+          type: string
+        port:
+          type: integer
+        protocol:
+          type: string
+          enum:
+            - tcp
+            - websockets
+          default: tcp
+        secure:
+          type: boolean
+          default: false
+        description:
+          type: string
+
+      dependentRequired:
+        host: ["port"]
+
+  enums:
+    type: object
+    additionalProperties:
+      type: object
+      properties:
+        values:
+          type: array
+          uniqueItems: true
+          items:
+            type: object
+            properties:
+              name:
+                type: string
+            required:
+              - name
+        documentation:
+          $ref: "#/$defs/documentation"
+        required:
+          - values
+
+  structures:
+    type: object
+    additionalProperties:
+      type: object
+      properties:
+        members:
+          $ref: "#/$defs/payload"
+        documentation:
+          $ref: "#/$defs/documentation"
+      required:
+        - members
+
+  signals:
+    type: object
+    additionalProperties:
+      $ref: "#/$defs/signal"
+
+  properties:
+    type: object
+    additionalProperties:
+      $ref: "#/$defs/property"
+
+  methods:
+    type: object
+    additionalProperties:
+      $ref: "#/$defs/method"
+
+required:
+  - stingeripc
+  - interface
+
+$defs:
+
+  documentation:
+    type: string
+
+  payload:
+    type: array
+    uniqueItems: true
+    items:
+      $ref: "#/$defs/arg"
+
+  genericArg:
+    type: object
+    required:
+      - "type"
+      - "name"
+    properties:
+      name:
+        type: string
+      optional:
+        type: boolean
+        default: false
+      description:
+        type: string
+      schema:
+        type: object
+        description: A JSON schema which further constrains the value.
+
+  primitiveArg:
+    properties:
+      type:
+        type: string
+        enum:
+          - float
+          - string
+          - integer
+          - boolean
+          - date
+          - time
+          - datetime
+          - duration
+          - binary
+
+  enumArg:
+    properties:
+      type:
+        type: string
+        const: "enum"
+      enumName:
+        type: string
+    required:
+      - enumName
+
+  structArg:
+    properties:
+      type:
+        type: string
+        const: "struct"
+      structName:
+        type: string
+    required:
+      - structName
+
+  listArg:
+    properties:
+      type:
+        type: string
+        const: "list"
+      itemType:
+        oneOf:
+          - $ref: "#/$defs/primitiveArg"
+          - $ref: "#/$defs/enumArg"
+          - $ref: "#/$defs/structArg"
+    required:
+      - itemType
+
+  arg:
+    oneOf:
+      - allOf:
+        - $ref: "#/$defs/genericArg"
+        - $ref: "#/$defs/primitiveArg"
+      - allOf:
+        - $ref: "#/$defs/genericArg"
+        - $ref: "#/$defs/enumArg"
+      - allOf:
+        - $ref: "#/$defs/genericArg"
+        - $ref: "#/$defs/structArg"
+      - allOf:
+        - $ref: "#/$defs/genericArg"
+        - $ref: "#/$defs/listArg"
+
+  signal:
+    type: object
+    properties:
+      documentation:
+        $ref: "#/$defs/documentation"
+      payload:
+        $ref: "#/$defs/payload"
+
+  property:
+    type: object
+    properties:
+      documentation:
+        $ref: "#/$defs/documentation"
+      values:
+        $ref: "#/$defs/payload"
+      readOnly:
+        type: boolean
+        default: false
+    required:
+      - values
+
+  method:
+    type: object
+    properties:
+      documentation:
+        $ref: "#/$defs/documentation"
+      arguments:
+        $ref: "#/$defs/payload"
+      returnValues:
+        $ref: "#/$defs/payload"
+    required:
+      - arguments

stingeripc/templates/cpp/examples/client_main.cpp.jinja2

@@ -1,3 +1,4 @@
+{% import 'partials/args.jinja2' as ar %}
 
 #include <iostream>
 #include <boost/chrono/chrono.hpp>
@@ -16,6 +17,23 @@ int main(int argc, char** argv) {
     });
     {%-endfor%}
 
+    {%- for prop_name, prop in stinger.properties.items() %}
+    client.register{{prop_name | UpperCamelCase}}PropertyCallback([]({{ar.methodParams(prop.arg_list)}}) {
+        std::cout << "Received update for {{prop_name}} property: " << {# #}
+                        {%-for arg in prop.arg_list-%}
+                        "{{arg.name}}=" << {%if arg.optional%} "None"{%else%}
+                            {%-if arg.arg_type.name.lower() == 'enum'%}
+                                {{arg.enum.name | camelCase }}Strings[static_cast<int>({{arg.name}})]
+                            {%elif arg.arg_type.name.lower() == 'struct'-%}
+                                "[{{arg.cpp_type}} object]"
+                            {%-else%}{{arg.name}}{%endif%}
+                            {%-endif%} <<
+                         {%-if not loop.last %} " | " << {%endif%}
+                        {%-endfor-%} 
+                        std::endl;
+    });
+    {%endfor%}
+
     {%-for method_name, method in stinger.methods.items() %}
     std::cout << "Calling {{method_name}}" << std::endl;
     auto {{method_name|camelCase}}ResultFuture = client.{{method_name | camelCase}}({%for arg in method.arg_list%}{{arg.get_random_example_value('c++')}}{%if not loop.last%}, {%endif%}{%endfor%});

stingeripc/templates/cpp/include/broker.hpp.jinja2

@@ -51,21 +51,24 @@ public:
             const std::string& payload, 
             unsigned qos, 
             bool retain, 
-            boost::optional<std::string> optCorrelationId, 
-            boost::optional<std::string> optResponseTopic,
-            boost::optional<MethodResultCode> optResultCode);
+            const MqttProperties& properties);
 
     /*! Subscribe to a topic.
      * \param topic the subscription topic.
      * \param qos an MQTT quality of service value between 0 and 2 inclusive.
+     * \return the MQTT subscription ID.
      */
-    virtual void Subscribe(const std::string& topic, int qos);
+    virtual int Subscribe(const std::string& topic, int qos);
 
     /*! Add a function that is called on the receipt of a message.
      * Many callbacks can be added, and each will be called in the order in which the callbacks were added.
      * \param cb the callback function.
      */
-    virtual void AddMessageCallback(const std::function<void(const std::string&, const std::string&, const boost::optional<std::string>, const boost::optional<std::string>, const boost::optional<MethodResultCode>)>& cb);
+    virtual void AddMessageCallback(const std::function<void(
+            const std::string&, 
+            const std::string&, 
+            const MqttProperties&
+        )>& cb);
 
     /*! Determines if a topic string matches a subscription topic.
      * \param topic a topic to match against a subscription.
@@ -99,20 +102,25 @@ private:
 
     struct MqttSubscription
     {
-        MqttSubscription(const std::string& topic, int qos) : _topic(topic), _qos(qos) {}
+        MqttSubscription(const std::string& topic, int qos, int subscriptionId) : topic(topic), qos(qos), subscriptionId(subscriptionId) {}
         ~MqttSubscription() = default;
-        std::string _topic;
-        int _qos;
-        int subscription_id;
+        std::string topic;
+        int qos;
+        int subscriptionId;
     };
 
     mosquitto *_mosq;
     std::string _host;
     int _port;
     std::string _clientId;
+    int _nextSubscriptionId = 1;
     std::queue<MqttSubscription> _subscriptions;
     boost::mutex _mutex;
-    std::vector<std::function<void(const std::string&, const std::string&, const boost::optional<std::string>, const boost::optional<std::string>, const boost::optional<MethodResultCode>)>> _messageCallbacks;
+    std::vector<std::function<void(
+            const std::string&, 
+            const std::string&, 
+            const MqttProperties&
+    )>> _messageCallbacks;
     std::queue<MqttMessage> _msgQueue;
     std::map<int, std::shared_ptr<boost::promise<bool>>> _sendMessages;
 };