rproxymod

type BaseModule struct{}

type Cache interface {
	// Set a cache value, potentially with a TTL
	Set(key []byte, value []byte, ttl time.Duration) error

	// Get the value of a key
	Get(key []byte) (value []byte, err error)

	// Get a value and fetch it in case of cache miss.
	GetAndStore(key []byte, fetcher CacheFetcher) (value []byte, err error)

	// Delete a key from the cache
	Delete(key []byte)

	// Clear the cache
	Clear()

	// Close the cache
	Close() error

	// Get statistics about cache usage.
	GetCacheStats() (stats *CacheStats)
}

type CacheFetcher interface {
	Fetch(key []byte) (value []byte, ttl time.Duration, err error)
}

type CacheStats struct {
	CacheHitsCount   int64
	CacheMissesCount int64
	CacheErrorCount  int64
}

type ProxyModule interface {

	// ProcessRequest is called in sequence for each proxy module. If it returns (nil,nil) the
	// request (proxyReq) is passed down the chain to the next module until pushed to the HTTP Transport
	// Otherwise the http.Response is returned - or, if nil and err is non-nil: 500 Internal server error
	// inReq is provided for information containing the original request before module modification
	// reqCtx contains cross module context, a logger and a proxy global cache.
	ProcessRequest(reqCtx *RequestContext, inReq *http.Request, proxyReq *http.Request) (*http.Response, error)

	// ModifyResponse allows you to modify the response from the backend.
	// It's called in reverse module order.
	ModifyResponse(reqCtx *RequestContext, inReq *http.Request, resp *http.Response) error

	// Deinitilize Module, cleanup operations like close DB handles
	// Could be used to cleanup older connection during graceful configuration reloads
	Deinit() error
}

type RequestContext struct {

	// CtxCache provides cross-request caching
	CtxCache Cache

	// Log will attach request session id to all log output
	Log *log.Logger
	// contains filtered or unexported fields
}