time

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

Index

• Constants
• Variables
• func BackOffUntilWithContext(ctx context.Context, f func(ctx context.Context) error, backoff Backoff, ...) (err error)
• func BeginningOfDay(days int) time.Time
• func BeginningOfDayString(days int, layout string) string
• func CallWithTimeout(ctx context.Context, timeout time.Duration, f func(ctx context.Context) error) error
• func EndOfDay(days int) time.Time
• func EndOfDayString(days int, layout string) string
• func JitterUntilWithContext(ctx context.Context, f func(ctx context.Context) error, period time.Duration)
• func Now() time.Time
• func NowString(layout string) string
• func RetryWithContext(ctx context.Context, f func(ctx context.Context) error, period time.Duration, ...) error
• func TruncateToUTC(t time.Time, d time.Duration) time.Time
• func TruncateToUTCString(t time.Time, d time.Duration, layout string) string
• func UntilWithContxt(ctx context.Context, f func(ctx context.Context) error, period time.Duration)
• type Backoff
• type EmptyExponentialBackOffOption
• type ExponentialBackOff
  • func NewExponentialBackOff(opts ...ExponentialBackOffOption) *ExponentialBackOff
  • func (o *ExponentialBackOff) ApplyOptions(options ...ExponentialBackOffOption) *ExponentialBackOff
  • func (b *ExponentialBackOff) GetCurrentInterval() time.Duration
  • func (b *ExponentialBackOff) GetElapsedTime() time.Duration
  • func (b *ExponentialBackOff) MaxElapsedTime() time.Duration
  • func (b *ExponentialBackOff) NextBackOff() (time.Duration, bool)
  • func (b *ExponentialBackOff) PreBackOff() (time.Duration, bool)
  • func (b *ExponentialBackOff) Reset()
  • func (b *ExponentialBackOff) ResetWithInterval(initialInterval time.Duration)
• type ExponentialBackOffMap
  • func (m *ExponentialBackOffMap) Delete(key string)
  • func (m *ExponentialBackOffMap) Load(key string) (ExponentialBackOff, bool)
  • func (m *ExponentialBackOffMap) LoadAndDelete(key string) (value ExponentialBackOff, loaded bool)
  • func (m *ExponentialBackOffMap) LoadOrStore(key string, value ExponentialBackOff) (ExponentialBackOff, bool)
  • func (m *ExponentialBackOffMap) Range(f func(key string, value ExponentialBackOff) bool)
  • func (m *ExponentialBackOffMap) Store(key string, value ExponentialBackOff)
• type ExponentialBackOffOption
  • func WithExponentialBackOffOptionInitialInterval(initialInterval time.Duration) ExponentialBackOffOption
  • func WithExponentialBackOffOptionMaxElapsedCount(maxElapsedCount int) ExponentialBackOffOption
  • func WithExponentialBackOffOptionMaxElapsedTime(maxElapsedTime time.Duration) ExponentialBackOffOption
  • func WithExponentialBackOffOptionMaxInterval(maxInterval time.Duration) ExponentialBackOffOption
  • func WithExponentialBackOffOptionMinInterval(minInterval time.Duration) ExponentialBackOffOption
  • func WithExponentialBackOffOptionMultiplier(multiplier float64) ExponentialBackOffOption
  • func WithExponentialBackOffOptionRandomizationFactor(randomizationFactor float64) ExponentialBackOffOption
• type ExponentialBackOffOptionFunc
• type TimeCounter
  • func New(effect bool) *TimeCounter
  • func (t *TimeCounter) Elapse() time.Duration
  • func (t *TimeCounter) Reset()
  • func (t *TimeCounter) String() string
  • func (t *TimeCounter) Summary(f func(idx int, msg string, cost time.Duration, at time.Time))
  • func (t *TimeCounter) Tick(msg string)

Constants

const (
	DefaultInitialInterval     = 500 * time.Millisecond
	DefaultRandomizationFactor = 0.5
	// The default multiplier value used for increment current interval
	DefaultMultiplier      = 1.5
	DefaultMaxInterval     = 60 * time.Second
	DefaultMinInterval     = DefaultInitialInterval
	DefaultMaxElapsedTime  = 15 * time.Minute
	DefaultMaxElapsedCount = -1
)

Default values for ExponentialBackOff.

const (
	DayFormat             = "20060102"
	TimeMillFormat        = "20060102150405.000"
	ShortTimeFormat       = "20060102150405"
	ShortDashTimeFormat   = "2006-01-02-15:04:05"
	DefaultTimeFormat     = "2006-01-02 15:04:05"
	DefaultTimeMillFormat = "2006-01-02 15:04:05.000"
)

Variables

var ErrTimeout = errors.New("timeout error")

Functions

func BackOffUntilWithContext

func BackOffUntilWithContext(
	ctx context.Context,
	f func(ctx context.Context) error,
	backoff Backoff,
	sliding bool,
	loop bool,
) (err error)

loop true -> BackOffUntilWithContext return until time expired loop false -> BackOffUntilWithContext return if f return nil, or time expired

func BeginningOfDay

func BeginningOfDay(days int) time.Time

func BeginningOfDayString

func BeginningOfDayString(days int, layout string) string

func CallWithTimeout

func CallWithTimeout(ctx context.Context, timeout time.Duration, f func(ctx context.Context) error) error

func EndOfDay

func EndOfDay(days int) time.Time

func EndOfDayString

func EndOfDayString(days int, layout string) string

func JitterUntilWithContext

func JitterUntilWithContext(
	ctx context.Context,
	f func(ctx context.Context) error,
	period time.Duration,
)

func Now

func Now() time.Time

func NowString

func NowString(layout string) string

func RetryWithContext

func RetryWithContext(
	ctx context.Context,
	f func(ctx context.Context) error,
	period time.Duration,
	retryTimes int,
) error

RetryWithContext retryTime is not include the first call

func TruncateToUTC

func TruncateToUTC(t time.Time, d time.Duration) time.Time

Truncate only happens in UTC semantics, apparently. observed values for truncating given time with 86400 secs:

before truncation: 2018/06/01 03:54:54 2018-06-01T03:18:00+09:00 after truncation: 2018/06/01 03:54:54 2018-05-31T09:00:00+09:00

This is really annoying when we want to truncate in local time so we hack: we take the apparent local time in the local zone, and pretend that it's in UTC. do our math, and put it back to the local zone

func TruncateToUTCString

func TruncateToUTCString(t time.Time, d time.Duration, layout string) string

func UntilWithContxt

func UntilWithContxt(
	ctx context.Context,
	f func(ctx context.Context) error, period time.Duration)

Until loops until context timout, running f every period. Until is syntactic sugar on top of JitterUntil with zero jitter factor and with sliding = true (which means the timer for period starts after the f completes).

Types

type Backoff

type Backoff interface {
	NextBackOff() (time.Duration, bool)
	Reset()
}

type EmptyExponentialBackOffOption

type EmptyExponentialBackOffOption struct{}

EmptyExponentialBackOffUrlOption does not alter the ExponentialBackOffuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type ExponentialBackOff

type ExponentialBackOff struct {
	// contains filtered or unexported fields
}

func NewExponentialBackOff

func NewExponentialBackOff(opts ...ExponentialBackOffOption) *ExponentialBackOff

func (*ExponentialBackOff) ApplyOptions

func (o *ExponentialBackOff) ApplyOptions(options ...ExponentialBackOffOption) *ExponentialBackOff

func (*ExponentialBackOff) GetCurrentInterval

func (b *ExponentialBackOff) GetCurrentInterval() time.Duration

func (*ExponentialBackOff) GetElapsedTime

func (b *ExponentialBackOff) GetElapsedTime() time.Duration

func (*ExponentialBackOff) MaxElapsedTime

func (b *ExponentialBackOff) MaxElapsedTime() time.Duration

func (*ExponentialBackOff) NextBackOff

func (b *ExponentialBackOff) NextBackOff() (time.Duration, bool)

NextBackOff is get next time duration

func (*ExponentialBackOff) PreBackOff

func (b *ExponentialBackOff) PreBackOff() (time.Duration, bool)

PreBackOff is get previos time duration false : have gone over the maximu elapsed time true : return remaining time

func (*ExponentialBackOff) Reset

func (b *ExponentialBackOff) Reset()

func (*ExponentialBackOff) ResetWithInterval

func (b *ExponentialBackOff) ResetWithInterval(initialInterval time.Duration)

type ExponentialBackOffMap

type ExponentialBackOffMap sync.Map

func (*ExponentialBackOffMap) Delete

func (m *ExponentialBackOffMap) Delete(key string)

Delete deletes the value for a key.

func (*ExponentialBackOffMap) Load

func (m *ExponentialBackOffMap) Load(key string) (ExponentialBackOff, bool)

Load returns the value stored in the map for a key, or nil if no value is present. The ok result indicates whether value was found in the map.

func (*ExponentialBackOffMap) LoadAndDelete

func (m *ExponentialBackOffMap) LoadAndDelete(key string) (value ExponentialBackOff, loaded bool)

LoadAndDelete deletes the value for a key, returning the previous value if any. The loaded result reports whether the key was present.

func (*ExponentialBackOffMap) LoadOrStore

func (m *ExponentialBackOffMap) LoadOrStore(key string, value ExponentialBackOff) (ExponentialBackOff, bool)

LoadOrStore returns the existing value for the key if present. Otherwise, it stores and returns the given value. The loaded result is true if the value was loaded, false if stored.

func (*ExponentialBackOffMap) Range

func (m *ExponentialBackOffMap) Range(f func(key string, value ExponentialBackOff) bool)

Range calls f sequentially for each key and value present in the map. If f returns false, range stops the iteration.

Range does not necessarily correspond to any consistent snapshot of the Map's contents: no key will be visited more than once, but if the value for any key is stored or deleted concurrently, Range may reflect any mapping for that key from any point during the Range call.

Range may be O(N) with the number of elements in the map even if f returns false after a constant number of calls.

func (*ExponentialBackOffMap) Store

func (m *ExponentialBackOffMap) Store(key string, value ExponentialBackOff)

Store sets the value for a key.

type ExponentialBackOffOption

type ExponentialBackOffOption interface {
	// contains filtered or unexported methods
}

A ExponentialBackOffOption sets options.

func WithExponentialBackOffOptionInitialInterval

func WithExponentialBackOffOptionInitialInterval(initialInterval time.Duration) ExponentialBackOffOption

func WithExponentialBackOffOptionMaxElapsedCount

func WithExponentialBackOffOptionMaxElapsedCount(maxElapsedCount int) ExponentialBackOffOption

func WithExponentialBackOffOptionMaxElapsedTime

func WithExponentialBackOffOptionMaxElapsedTime(maxElapsedTime time.Duration) ExponentialBackOffOption

func WithExponentialBackOffOptionMaxInterval

func WithExponentialBackOffOptionMaxInterval(maxInterval time.Duration) ExponentialBackOffOption

func WithExponentialBackOffOptionMinInterval

func WithExponentialBackOffOptionMinInterval(minInterval time.Duration) ExponentialBackOffOption

func WithExponentialBackOffOptionMultiplier

func WithExponentialBackOffOptionMultiplier(multiplier float64) ExponentialBackOffOption

func WithExponentialBackOffOptionRandomizationFactor

func WithExponentialBackOffOptionRandomizationFactor(randomizationFactor float64) ExponentialBackOffOption

type ExponentialBackOffOptionFunc

type ExponentialBackOffOptionFunc func(*ExponentialBackOff)

ExponentialBackOffOptionFunc wraps a function that modifies ExponentialBackOff into an implementation of the ExponentialBackOffOption interface.

type TimeCounter

type TimeCounter struct {
	// contains filtered or unexported fields
}

func New

func New(effect bool) *TimeCounter

func (*TimeCounter) Elapse

func (t *TimeCounter) Elapse() time.Duration

func (*TimeCounter) Reset

func (t *TimeCounter) Reset()

func (*TimeCounter) String

func (t *TimeCounter) String() string

func (*TimeCounter) Summary

func (t *TimeCounter) Summary(f func(idx int, msg string, cost time.Duration, at time.Time))

func (*TimeCounter) Tick

func (t *TimeCounter) Tick(msg string)