Add macros to API for compile time topic generation #38
Conversation
This file contains 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
…mpile-time-job-generation
muneebahmed10
previously approved these changes
Feb 11, 2021
source/include/jobs.h
Outdated
| @@ -192,6 +292,13 @@ typedef enum | |||
| * | |||
| * @note The thingName parameter does not need a NUL terminator. | |||
| * | |||
| * @note The AWS IoT Jobs service does not require clients to subscribe | |||
| * to the "/accepted" and "/rejected" response topics for the APIs that | |||
| * accept PUBLISH requests. The Jobs service will send responses to requests | |||
There was a problem hiding this comment.
Could change wording here, "publish requests" sounds like a request for a publish instead of a request delivered via publish
Suggested change
| * accept PUBLISH requests. The Jobs service will send responses to requests | |
| * accept published requests. The Jobs service will send responses to requests |
There was a problem hiding this comment.
I have reworded to address the readability concern.
dan4thewin
reviewed
Feb 11, 2021
Comment on lines
+193
to
+194
| * This macro should be used when the thing name and jobID are known at the | ||
| * compile time. If next pending job is being queried, use $next as job ID. |
There was a problem hiding this comment.
Is job ID ever known at compile time?
There was a problem hiding this comment.
This macro's main utility would be for using the $next job ID. If you think that we should provide macros only for that case, I can limit the macro to generate topics only for the next job ID.
muneebahmed10
approved these changes
Feb 12, 2021
dan4thewin
approved these changes
Feb 12, 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.
This PR makes the following changes:
Add macros to API to allow generation of topics at compile time if thing name and job ID (for topics that need job ID) are known to application at compile time.
Add documentation to function APIs about the AWS IoT Jobs service not needing subsciption to response topics of DescribeJobExecution, UpdateJobExecution, GetPendingJobExecutions and StartNextPendingJobExecution APIs