docs(app-sdk): Add background publisher API detail #229
Conversation
|
Please note - this is a draft PR for the hanoi release, linked to edgexfoundry/app-functions-sdk-go#466 |
| defer close(done) | ||
|
|
||
| //pass the publisher to your jobs | ||
| for _, j := range jobs { |
There was a problem hiding this comment.
I think it would be helpful to show example of Job using the publisher to send the data to complete the picture. Also jobs isn't define in sample so might want to change comment to pass the publisher to your jobs (defined elsewhere) .
There was a problem hiding this comment.
I like this idea to show a more detailed example, I'll just code a simple loop to use it inline.
There was a problem hiding this comment.
I left the actual message construction as an exercise for the user, but added a simple method demonstrating usage of the publisher to the doc. Tried not to make the code sample too much longer so I left out logging calls etc...
There is a drop down when you create the PR where you can select |
| if err != nil { | ||
| continue | ||
| } | ||
| pub.Publish(, fmt.Sprintf("background=%d", time.Now().UnixNano()), clients.ContentTypeJSON) |
There was a problem hiding this comment.
Missing payload as first parameter.
Also recommend set correlationId = uuid.New().String() and passing it to Publish so it is more explicit and uses standard UUID used else where for correlation ID.
There was a problem hiding this comment.
Doh should be good now
Adds a simple paragraph and code example for using background publisher API References: #462 Signed-off-by: Alex Ullrich <[email protected]>
lenny-goodell
added
hanoi
lenny-goodell
removed
the
hold
Signed-off-by: edgex-jenkins <[email protected]>
Adds a simple paragraph and code example for using background publisher
API
References: #462
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number:
462
What has been updated?
Are there any specific instructions or things that should be known prior to reviewing?
Other information