Skip to content

Commit

Permalink
Add more explicit documentation to Tick field in CoordinatedActivityH…
Browse files Browse the repository at this point in the history
…andler

Docs were taken from Scott’s reply here:
sclasen#25 (comment)
  • Loading branch information
Ryan Walls committed Jul 1, 2016
1 parent 4d4b402 commit 24ca1d1
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions activity/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ type CoordinatedActivityHandler struct {
Start CoordinatedActivityHandlerStartFunc

// Tick is called regularly to process a running activity.
// Tick that returns false, nil, nil just expresses that the job is still running.
// Tick that returns false, &SomeStruct{}, nil will express that the job is still running and also send an 'ActivityUpdated' signal back to the FSM with SomeStruct{} as the Input.
// Tick that returns true, &SomeStruct{}, nil, expresses that the job/activity is done and send SomeStruct{} back as the result. as well as stops heartbeating.
// Tick that returns true, nil, nil, expresses that the job is done and send no result back, as well as stops heartbeating.
// Tick that returns false, nil, err expresses that the job/activity failed and sends back err as the reason. as well as stops heartbeating.
Tick CoordinatedActivityHandlerTickFunc

// Cancel is called when a running activity receives a request to cancel
Expand Down

0 comments on commit 24ca1d1

Please sign in to comment.