Add more porting instructions to README #57
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
n9wxu
previously approved these changes
Jul 23, 2021
yourslab
previously approved these changes
Jul 23, 2021
archigup
previously approved these changes
Jul 23, 2021
aggarw13
reviewed
Jul 23, 2021
aggarw13
reviewed
Jul 23, 2021
README.md
Outdated
|
|
||
| | Function Pointer | Description | | ||
| | :-: | --- | | ||
| | `MQTTAgentMessageSend_t` | A function that sends `MQTTAgentCommand_t *` pointers to be received by `MQTTAgent_CommandLoop`. This can be implemented by pushing to a thread safe queue. | |
There was a problem hiding this comment.
Instead of providing the MQTTAgentCommand_t *, wouldn't it be easier for a reader to mention just generically that this function enables commands to be sent to a thread-safe queue. Similarly, for the MQTTAgentMessageRecv_t function, it can say that it enabled commands to be reach from a thread-safe queue
There was a problem hiding this comment.
I thought it's better to be more specific here since MQTTAgentCommand_t * is part of the function prototype, so they will be dealing with it when implementing the function.
muneebahmed10
dismissed stale reviews from archigup, yourslab, and n9wxu
via
d699d33
aggarw13
reviewed
Jul 23, 2021
README.md
Outdated
| | :-: | --- | | ||
| | `MQTTAgentMessageSend_t` | A function that sends `MQTTAgentCommand_t *` pointers to be received by `MQTTAgent_CommandLoop`. This can be implemented by pushing to a thread safe queue. | | ||
| | `MQTTAgentMessageRecv_t` | A function used by `MQTTAgent_CommandLoop` to receive `MQTTAgentCommand_t *` that were sent by API functions. This can be implemented by receiving from a thread safe queue. | | ||
| | `MQTTAgentCommandGet_t` | A function that returns a pointer to an allocated `MQTTAgentCommand_t` structure, to be used for information and arguments for a command to be executed by `MQTTAgent_CommandLoop()`. If using dynamic memory, this can be implemented using `malloc()`. | |
There was a problem hiding this comment.
Suggested change
| | `MQTTAgentCommandGet_t` | A function that returns a pointer to an allocated `MQTTAgentCommand_t` structure, to be used for information and arguments for a command to be executed by `MQTTAgent_CommandLoop()`. If using dynamic memory, this can be implemented using `malloc()`. | | |
| | `MQTTAgentCommandGet_t` | A function that returns a pointer to an allocated command object (of `MQTTAgentCommand_t` type) that is executed by the MQTT Agent command loop. If using dynamic memory, this can be implemented using `malloc()`. | |
aggarw13
approved these changes
Jul 23, 2021
n9wxu
approved these changes
Jul 23, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Adds a section to the README that describes the platform-dependent features needed when implementing the messaging interface.