Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func KeyAsString ¶
KeyAsString can be used by adapters to convert the cache key from uint64 to string.
Types ¶
type Adapter ¶
type Adapter interface { // Get retrieves the cached response by a given key. It also // returns true or false, whether it exists or not. Get(key uint64) ([]byte, bool) // Set caches a response for a given key until an expiration date. Set(key uint64, response []byte, expiration time.Time) error // Release frees cache for a given key. Release(key uint64) error }
Adapter interface for HTTP cache middleware client.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client data structure for HTTP cache middleware.
func NewClient ¶
func NewClient(opts ...ClientOption) (*Client, error)
NewClient initializes the cache HTTP middleware client with the given options.
func (*Client) Middleware ¶
func (client *Client) Middleware() echo.MiddlewareFunc
Middleware is the HTTP cache middleware handler.
type ClientOption ¶
ClientOption is used to set Client settings.
func ClientWithAdapter ¶
func ClientWithAdapter(a Adapter) ClientOption
ClientWithAdapter sets the adapter type for the HTTP cache middleware client.
func ClientWithMethods ¶
func ClientWithMethods(methods []string) ClientOption
ClientWithMethods sets the acceptable HTTP methods to be cached. Optional setting. If not set, default is "GET".
func ClientWithPaths ¶
func ClientWithPaths(values []Path) ClientOption
ClientWithPaths sets the custom timeouts for particular endpoints. Optional setting.
func ClientWithRefreshKey ¶
func ClientWithRefreshKey(refreshKey string) ClientOption
ClientWithRefreshKey sets the parameter key used to free a request cached response. Optional setting.
type Response ¶
type Response struct { // Value is the cached response value. Value []byte // Header is the cached response header. Header http.Header // Expiration is the cached response expiration date. Expiration time.Time // LastAccess is the last date a cached response was accessed. // Used by LRU and MRU algorithms. LastAccess time.Time // Frequency is the count of times a cached response is accessed. // Used for LFU and MFU algorithms. Frequency int }
Response is the cached response data structure.
func BytesToResponse ¶
BytesToResponse converts bytes array into Response data structure.