aurestcaching

Documentation

Index

• func Instrument(client aurestclientapi.Client, ...)
• func New(wrapped aurestclientapi.Client, ...) aurestclientapi.Client
• type CacheEntry
• type CachingImpl
  • func (c *CachingImpl) Perform(ctx context.Context, method string, requestUrl string, requestBody interface{}, ...) error

Functions

func Instrument

func Instrument(
	client aurestclientapi.Client,
	cacheHitMetricsCallback aurestclientapi.MetricsCallbackFunction,
	cacheMissMetricsCallback aurestclientapi.MetricsCallbackFunction,
	cacheInvalidMetricsCallback aurestclientapi.MetricsCallbackFunction,
)

Instrument adds instrumentation to a http client.

Either of the callbacks may be nil.

func New

func New(
	wrapped aurestclientapi.Client,
	useCacheCondition aurestclientapi.CacheConditionCallback,
	storeResponseInCacheCondition aurestclientapi.CacheResponseConditionCallback,
	cacheKeyFunction aurestclientapi.CacheKeyFunction,
	retentionTime time.Duration,
	cacheSize int,
) aurestclientapi.Client

Types

type CacheEntry

type CacheEntry struct {
	Recorded           time.Time
	ResponseHeaderJson []byte
	ResponseBodyJson   []byte
	ResponseStatus     int
}

type CachingImpl

type CachingImpl struct {
	Wrapped aurestclientapi.Client

	UseCacheCondition             aurestclientapi.CacheConditionCallback
	StoreResponseInCacheCondition aurestclientapi.CacheResponseConditionCallback
	CacheKeyFunction              aurestclientapi.CacheKeyFunction
	RetentionTime                 time.Duration
	Cache                         *tinylru.LRU

	CacheHitMetricsCallback     aurestclientapi.MetricsCallbackFunction
	CacheMissMetricsCallback    aurestclientapi.MetricsCallbackFunction
	CacheInvalidMetricsCallback aurestclientapi.MetricsCallbackFunction

	// Now is exposed so tests can fixate the time by overwriting this field
	Now func() time.Time
}

func (*CachingImpl) Perform

func (c *CachingImpl) Perform(ctx context.Context, method string, requestUrl string, requestBody interface{}, response *aurestclientapi.ParsedResponse) error