go.uber.org/cadence@v1.2.9/internal/internal_time.go (about)

     1  // Copyright (c) 2017 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package internal
    22  
    23  import (
    24  	"time"
    25  )
    26  
    27  // All code in this file is private to the package.
    28  
    29  type (
    30  	timerInfo struct {
    31  		timerID string
    32  	}
    33  
    34  	// workflowTimerClient wraps the async workflow timer functionality.
    35  	workflowTimerClient interface {
    36  
    37  		// Now - Current time when the decision task is started or replayed.
    38  		// the workflow need to use this for wall clock to make the flow logic deterministic.
    39  		Now() time.Time
    40  
    41  		// NewTimer - Creates a new timer that will fire callback after d(resolution is in seconds).
    42  		// The callback indicates the error(TimerCanceledError) if the timer is cancelled.
    43  		NewTimer(d time.Duration, callback resultHandler) *timerInfo
    44  
    45  		// RequestCancelTimer - Requests cancel of a timer, this one doesn't wait for cancellation request
    46  		// to complete, instead invokes the resultHandler with TimerCanceledError
    47  		// If the timer is not started then it is a no-operation.
    48  		RequestCancelTimer(timerID string)
    49  	}
    50  )