This is an automated email from the ASF dual-hosted git repository.
pnoltes pushed a commit to branch feature/pubsub_custom_serializers
in repository https://gitbox.apache.org/repos/asf/celix.git
The following commit(s) were added to
refs/heads/feature/pubsub_custom_serializers by this push:
new fe1cfb0 updates some documentation typos
fe1cfb0 is described below
commit fe1cfb08eb8550b247464993689ee1483b1437d7
Author: Pepijn Noltes <[email protected]>
AuthorDate: Thu Apr 30 19:40:52 2020 +0200
updates some documentation typos
---
.../gtest/src/PubSubJsonSerializationProviderTestSuite.cc | 7 ++++---
.../pubsub_utils/include/pubsub_serialization_provider.h | 15 ++++++++++-----
2 files changed, 14 insertions(+), 8 deletions(-)
diff --git
a/bundles/pubsub/pubsub_serializer_json/gtest/src/PubSubJsonSerializationProviderTestSuite.cc
b/bundles/pubsub/pubsub_serializer_json/gtest/src/PubSubJsonSerializationProviderTestSuite.cc
index 1a635e5..9b6a67b 100644
---
a/bundles/pubsub/pubsub_serializer_json/gtest/src/PubSubJsonSerializationProviderTestSuite.cc
+++
b/bundles/pubsub/pubsub_serializer_json/gtest/src/PubSubJsonSerializationProviderTestSuite.cc
@@ -87,9 +87,10 @@ TEST_F(PubSubJsonSerializationProviderTestSuite,
SerializeTest) {
opts.use = [](void *handle, void *svc) {
//auto *poi = static_cast<poi1*>(handle);
auto* ser = static_cast<pubsub_message_serialization_service_t*>(svc);
- struct iovec* outVec;
- size_t outSize;
- ser->serialize(ser->handle, handle, &outVec, &outSize);
+ struct iovec* outVec = NULL;
+ size_t outSize = 0;
+ int rc = ser->serialize(ser->handle, handle, &outVec, &outSize);
+ EXPECT_EQ(0, rc);
EXPECT_TRUE(strstr(static_cast<char*>(outVec->iov_base), "\"lat\":42")
!= NULL);
ser->freeSerializedMsg(ser->handle, outVec, outSize);
};
diff --git
a/bundles/pubsub/pubsub_utils/include/pubsub_serialization_provider.h
b/bundles/pubsub/pubsub_utils/include/pubsub_serialization_provider.h
index 5dec0f5..1da3464 100644
--- a/bundles/pubsub/pubsub_utils/include/pubsub_serialization_provider.h
+++ b/bundles/pubsub/pubsub_utils/include/pubsub_serialization_provider.h
@@ -56,19 +56,24 @@ typedef struct {
*
* The provider monitors bundles and creates pubsub message serialization
services for every unique descriptor found.
*
- * Descriptors can be DFI descriptors or AVPR descriptors (FIXE #158).
+ * Descriptors can be DFI descriptors or AVPR descriptors (FIXME #158).
*
* The provider will look for descriptors in META-INF/descriptors directory of
every installed bundle.
* If a framework config CELIX_FRAMEWORK_EXTENDER_PATH is set, this path will
also be used to search for descriptor files.
*
- * For every unique and valid descriptor found a
pubsub_message_serialization_service will be registered for the 'json'
serialization type.
- * The provider will also register a single pubsub_serialization_marker
service which 'marks' the existing of the a json serialization support.
+ * For every unique and valid descriptor found a
pubsub_message_serialization_service will be registered for the serialization
type (e.g. 'json')
+ * The provider will also register a single pubsub_serialization_marker
service which 'marks' the existing of the a serialization type serialization
support.
*
* Lastly a celix command shell will be register with the command name
'celix::<serialization_type>_message_serialization' which can be used to
interactively
* query the provided serialization services.
*
- * @param ctx The bundle context.
- * @return A JSON Serialization Provider.
+ * @param ctx The bundle context
+ * @param serializationType The serialization type (e.g. 'json')
+ * @param serialize The serialize function to use
+ * @param freeSerializeMsg The freeSerializeMsg function to use
+ * @param deserialize The deserialize function to use
+ * @param freeDeserializeMsg The freeDesrializeMsg function to use
+ * @return A pubsub serialization provided for the
requested serialization type using the provided serialization functions.
*/
pubsub_serialization_provider_t *pubsub_serializationProvider_create(
celix_bundle_context_t *ctx,
