rbulter commented on a change in pull request #172: Refactor TcpAdmin and add
interfacing for VectorIoSerialisation
URL: https://github.com/apache/celix/pull/172#discussion_r400888391
##########
File path: bundles/pubsub/pubsub_spi/include/pubsub_protocol.h
##########
@@ -28,39 +28,77 @@
typedef struct pubsub_protocol_header pubsub_protocol_header_t;
+/**
+ * The protocol header structure, contains the information about the message
payload and metadata
+ */
struct pubsub_protocol_header {
- unsigned int msgId;
- unsigned short msgMajorVersion;
- unsigned short msgMinorVersion;
-
- unsigned int payloadSize;
- unsigned int metadataSize;
+ /** message payload identification attributes */
+ unsigned int msgId; /*!< Message id of the payload */
+ unsigned short msgMajorVersion; /*!< Message Major version of the payload
*/
+ unsigned short msgMinorVersion; /*!< Message Minor version of the payload
*/
+
+ /** Payload and metadata sizes attributes */
+ unsigned int payloadSize; /*!< Size of the payload (Can be used for
payload buffer allocation by the receiver) */
+ unsigned int metadataSize; /*!< Size of the metadata (Can be used for
metadata buffer allocation by the receiver) */
+
+ /** message segmentation attributes */
Review comment:
I have updated the documentation
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
