Skip to content

Commit

Permalink
Add a little detail on when heartbeat is seen from the activity side (#…
Browse files Browse the repository at this point in the history
…650)

Fixes #638
  • Loading branch information
cretz authored Dec 3, 2021
1 parent 6c694d5 commit 7125db9
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion workflow/workflow.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,9 @@ type (
// *ApplicationError, *TimeoutError, *CanceledError, or *PanicError.
//
// You can cancel the pending activity using context(workflow.WithCancel(ctx)) and that will fail the activity with
// *CanceledError set as cause for *ActivityError.
// *CanceledError set as cause for *ActivityError. The context in the activity only becomes aware of the cancellation
// when a heartbeat is sent to the server. Since heartbeats may be batched internally, this could take up to the
// HeartbeatTimeout to appear or several minutes by default if that value is not set.
//
// ExecuteActivity immediately returns a Future that can be used to block waiting for activity result or failure.
func ExecuteActivity(ctx Context, activity interface{}, args ...interface{}) Future {
Expand Down

0 comments on commit 7125db9

Please sign in to comment.