entry

Documentation

Index

• type Entry
  • func (e *Entry) Response() *Response
• type Pool
  • func NewPool() *Pool
  • func (c *Pool) Acquire(lifeDuration time.Duration, r *Response, onExpire func()) *Entry
  • func (c *Pool) Release(e *Entry)
• type Response
  • func NewResponse(statusCode int, headers http.Header, body []byte) *Response
  • func (r *Response) Body() []byte
  • func (r *Response) Bytes() []byte
  • func (r *Response) Headers() http.Header
  • func (r *Response) Read(b []byte) (int, error)
  • func (r *Response) SetBody(body []byte)
  • func (r *Response) SetHeaders(h http.Header)
  • func (r *Response) SetStatusCode(statusCode int)
  • func (r *Response) StatusCode() int
• type Store
  • func NewMemStore() Store

Types

type Entry

type Entry struct {

	// when `Reset` this value is reseting to time.Now(),
	// it's used to send the "Last-Modified" header,
	// some clients may need it.
	LastModified time.Time
	// contains filtered or unexported fields
}

Entry is the cache entry contains the expiration datetime and the response

func (*Entry) Response

func (e *Entry) Response() *Response

Response returns the cached response as it's.

type Pool

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

Pool is the context pool, it's used inside router and the framework by itself.

func NewPool

func NewPool() *Pool

NewPool creates and returns a new context pool.

func (*Pool) Acquire

func (c *Pool) Acquire(lifeDuration time.Duration, r *Response, onExpire func()) *Entry

Acquire returns an Entry from pool. See Release.

func (*Pool) Release

func (c *Pool) Release(e *Entry)

Release can be called by custom stores to release an entry.

type Response

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

Response is the cached response will be send to the clients its fields set at runtime on each of the non-cached executions non-cached executions = first execution, and each time after cache expiration datetime passed.

func NewResponse

func NewResponse(statusCode int, headers http.Header, body []byte) *Response

NewResponse returns a new cached Response.

func (*Response) Body

func (r *Response) Body() []byte

Body returns contents will be served by the cache handler.

func (*Response) Bytes

func (r *Response) Bytes() []byte

Bytes returns a copy of the cached response body.

func (*Response) Headers

func (r *Response) Headers() http.Header

Headers returns the total headers of the cached response.

func (*Response) Read

func (r *Response) Read(b []byte) (int, error)

Read implements the io.Reader interface.

func (*Response) SetBody

func (r *Response) SetBody(body []byte)

SetBody consumes "b" and sets the body of the cached response.

func (*Response) SetHeaders

func (r *Response) SetHeaders(h http.Header)

SetHeaders sets a clone of headers of the cached response.

func (*Response) SetStatusCode

func (r *Response) SetStatusCode(statusCode int)

SetStatusCode sets a valid status code.

func (*Response) StatusCode

func (r *Response) StatusCode() int

StatusCode returns a valid status code.

type Store

type Store interface {
	// Get returns an entry based on its key.
	Get(key string) *Entry
	// Set sets an entry based on its key.
	Set(key string, e *Entry)
	// Delete deletes an entry based on its key.
	Delete(key string)
}

Store is the interface which is responsible to store the cache entries.

func NewMemStore

func NewMemStore() Store

NewMemStore returns a new in-memory store for the cache entries.