utils

Documentation

Overview

Copyright 2014-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at

http://aws.amazon.com/apache2.0/

or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func AddJitter(duration time.Duration, jitter time.Duration) time.Duration
• func CompleteJsonUnmarshal(b []byte, iface interface{}) error
• func DefaultIfBlank(str string, default_value string) string
• func ExtractVersion(input string) string
• func JsonKeys(b []byte) ([]string, error)
• func NewMultiError(errs ...error) error
• func ParseBool(str string, default_ bool) bool
• func RandHex() string
• func RetryNWithBackoff(backoff Backoff, n int, fn func() error) error
• func RetryNWithBackoffCtx(ctx context.Context, backoff Backoff, n int, fn func() error) error
• func RetryWithBackoff(backoff Backoff, fn func() error) error
• func RetryWithBackoffCtx(ctx context.Context, backoff Backoff, fn func() error) error
• func SignHTTPRequest(req *http.Request, region, service string, creds *credentials.Credentials, ...)
• func SlicesDeepEqual(slice1, slice2 interface{}) bool
• func StrSliceEqual(s1, s2 []string) bool
• func Strptr(s string) *string
• func Uint16SliceToStringSlice(slice []uint16) []*string
• func ZeroOrNil(obj interface{}) bool
• type AttributeError
  • func NewAttributeError(err string) AttributeError
  • func (e AttributeError) Error() string
• type Backoff
• type ChanSemaphore
  • func (s *ChanSemaphore) Post()
  • func (s *ChanSemaphore) Wait()
• type DefaultRetriable
  • func (dr DefaultRetriable) Retry() bool
• type DefaultRetriableError
• type LicenseProvider
  • func NewLicenseProvider() LicenseProvider
• type MultiErr
  • func (me MultiErr) Error() string
• type Retriable
  • func NewRetriable(retry bool) Retriable
• type RetriableError
  • func NewRetriableError(retriable Retriable, err error) RetriableError
• type Semaphore
  • func NewSemaphore(count int) Semaphore
• type SimpleBackoff
  • func NewSimpleBackoff(min, max time.Duration, jitterMultiple, multiple float64) *SimpleBackoff
  • func (sb *SimpleBackoff) Duration() time.Duration
  • func (sb *SimpleBackoff) Reset()
• type Version
  • func (lhs Version) Matches(selector string) (bool, error)

Functions

func AddJitter

func AddJitter(duration time.Duration, jitter time.Duration) time.Duration

AddJitter adds an amount of jitter between 0 and the given jitter to the given duration

func CompleteJsonUnmarshal

func CompleteJsonUnmarshal(b []byte, iface interface{}) error

CompleteJsonUnmarshal determines if a given struct has members corresponding to every key of a json object (passed as the json string). By default, Go ignores fields in an object which have no corresponding struct member and this can be used to determine if this ignoring has occurred Errors will result in "false" as a return value

func DefaultIfBlank

func DefaultIfBlank(str string, default_value string) string

func ExtractVersion

func ExtractVersion(input string) string

ExtractVersion extracts a matching version from the version number string

func JsonKeys

func JsonKeys(b []byte) ([]string, error)

JsonKeys takes an arbitrary byte array representing a json stringified object and returns all the keys of that object.

func NewMultiError

func NewMultiError(errs ...error) error

NewMultiError creates a new MultErr object

func ParseBool

func ParseBool(str string, default_ bool) bool

func RandHex

func RandHex() string

func RetryNWithBackoff

func RetryNWithBackoff(backoff Backoff, n int, fn func() error) error

RetryNWithBackoff takes a Backoff, a maximum number of tries 'n', and a function that returns an error. The function is called until either it does not return an error or the maximum tries have been reached. If the error returned is Retriable, the Retriability of it will be respected. If the number of tries is exhausted, the last error will be returned.

func RetryNWithBackoffCtx

func RetryNWithBackoffCtx(ctx context.Context, backoff Backoff, n int, fn func() error) error

RetryNWithBackoffCtx takes a context, a Backoff, a maximum number of tries 'n', and a function that returns an error. The function is called until it does not return an error, the context is done, or the maximum tries have been reached. If the error returned is Retriable, the Retriability of it will be respected. If the number of tries is exhausted, the last error will be returned.

func RetryWithBackoff

func RetryWithBackoff(backoff Backoff, fn func() error) error

RetryWithBackoff takes a Backoff and a function to call that returns an error If the error is nil then the function will no longer be called If the error is Retriable then that will be used to determine if it should be retried

func RetryWithBackoffCtx

func RetryWithBackoffCtx(ctx context.Context, backoff Backoff, fn func() error) error

RetryWithBackoffCtx takes a context, a Backoff, and a function to call that returns an error If the context is done, nil will be returned If the error is nil then the function will no longer be called If the error is Retriable then that will be used to determine if it should be retried

func SignHTTPRequest

func SignHTTPRequest(req *http.Request, region, service string, creds *credentials.Credentials, body io.ReadSeeker)

SignHTTPRequest signs an http.Request struct with authv4 using the given region, service, and credentials.

func SlicesDeepEqual

func SlicesDeepEqual(slice1, slice2 interface{}) bool

SlicesDeepEqual checks if slice1 and slice2 are equal, disregarding order.

func StrSliceEqual

func StrSliceEqual(s1, s2 []string) bool

func Strptr

func Strptr(s string) *string

func Uint16SliceToStringSlice

func Uint16SliceToStringSlice(slice []uint16) []*string

Uint16SliceToStringSlice converts a slice of type uint16 to a slice of type *string. It uses strconv.Itoa on each element

func ZeroOrNil

func ZeroOrNil(obj interface{}) bool

Types

type AttributeError

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

AttributeError defines an error type to indicate an error with an ECS attribute

func NewAttributeError

func NewAttributeError(err string) AttributeError

NewAttributeError creates a new AttributeError object

func (AttributeError) Error

func (e AttributeError) Error() string

Error returns the error string for AttributeError

type Backoff

type Backoff interface {
	Reset()
	Duration() time.Duration
}

type ChanSemaphore

type ChanSemaphore struct {
	Count int // Public for introspection; should not be written to
	// contains filtered or unexported fields
}

Implements semaphore

func (*ChanSemaphore) Post

func (s *ChanSemaphore) Post()

func (*ChanSemaphore) Wait

func (s *ChanSemaphore) Wait()

type DefaultRetriable

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

DefaultRetriable implements the Retriable interface with a boolean to indicate if retry should occur

func (DefaultRetriable) Retry

func (dr DefaultRetriable) Retry() bool

Retry returns true if the operation can be retried

type DefaultRetriableError

type DefaultRetriableError struct {
	Retriable
	// contains filtered or unexported fields
}

DefaultRetriableError is used to wrap a retriable error

type LicenseProvider

type LicenseProvider interface {
	GetText() (string, error)
}

func NewLicenseProvider

func NewLicenseProvider() LicenseProvider

type MultiErr

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

MultiErr wraps multiple errors

func (MultiErr) Error

func (me MultiErr) Error() string

Error returns the error string for MultiErr

type Retriable

type Retriable interface {
	// Retry returns true if the operation can be retried
	Retry() bool
}

Retriable defines an interface for retriable methods

func NewRetriable

func NewRetriable(retry bool) Retriable

NewRetriable creates a new DefaultRetriable object

type RetriableError

type RetriableError interface {
	Retriable
	error
}

RetriableError defines an interface for a retriable error

func NewRetriableError

func NewRetriableError(retriable Retriable, err error) RetriableError

NewRetriableError creates a new DefaultRetriableError object

type Semaphore

type Semaphore interface {
	Post()
	Wait()
}

func NewSemaphore

func NewSemaphore(count int) Semaphore

type SimpleBackoff

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

func NewSimpleBackoff

func NewSimpleBackoff(min, max time.Duration, jitterMultiple, multiple float64) *SimpleBackoff

NewSimpleBackoff creates a Backoff which ranges from min to max increasing by multiple each time. It also adds (and yes, the jitter is always added, never subtracted) a random amount of jitter up to jitterMultiple percent (that is, jitterMultiple = 0.0 is no jitter, 0.15 is 15% added jitter). The total time may exceed "max" when accounting for jitter, such that the absolute max is max + max * jiterMultiple

func (*SimpleBackoff) Duration

func (sb *SimpleBackoff) Duration() time.Duration

func (*SimpleBackoff) Reset

func (sb *SimpleBackoff) Reset()

type Version

type Version string

func (Version) Matches

func (lhs Version) Matches(selector string) (bool, error)

Matches returns whether or not a version matches a given selector. The selector can be any of the following:

* x.y.z -- Matches a version exactly the same as the selector version * >=x.y.z -- Matches a version greater than or equal to the selector version * >x.y.z -- Matches a version greater than the selector version * <=x.y.z -- Matches a version less than or equal to the selector version * <x.y.z -- Matches a version less than the selector version * x.y.z,a.b.c -- Matches if the version matches either of the two selector versions