go.temporal.io/server@v1.23.0/common/tasks/task.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package tasks
    26  
    27  import (
    28  	"go.temporal.io/server/common/backoff"
    29  )
    30  
    31  //go:generate mockgen -copyright_file ../../LICENSE -package $GOPACKAGE -source $GOFILE -destination task_mock.go
    32  type (
    33  	// Task is the interface for tasks which should be executed sequentially
    34  	Task interface {
    35  		// Execute process this task
    36  		Execute() error
    37  		// HandleErr handle the error returned by Execute
    38  		HandleErr(err error) error
    39  		// IsRetryableError check whether to retry after HandleErr(Execute())
    40  		IsRetryableError(err error) bool
    41  		// RetryPolicy returns the retry policy for task processing
    42  		RetryPolicy() backoff.RetryPolicy
    43  		// Abort marks the task as aborted, usually means task executor shutdown
    44  		Abort()
    45  		// Cancel marks the task as cancelled, usually by the task submitter
    46  		Cancel()
    47  		// Ack marks the task as successful completed
    48  		Ack()
    49  		// Nack marks the task as unsuccessful completed
    50  		Nack(err error)
    51  		// Reschedule marks the task for retry
    52  		Reschedule()
    53  		// State returns the current task state
    54  		State() State
    55  	}
    56  )