TSCacheRead

Synopsis

#include <ts/ts.h>

TSAction TSCacheRead(TSCont contp, TSCacheKey key)

Description

Asks the Traffic Server cache if the object corresponding to :arg:`key` exists in the cache and can be read.

If the object can be read, the Traffic Server cache calls the continuation :arg:`contp` back with the event TS_EVENT_CACHE_OPEN_READ. In this case, the cache also passes :arg:`contp` a cache vconnection and :arg:`contp` can then initiate a read operation on that vconnection using TSVConnRead.

If the object cannot be read, the cache calls :arg:`contp` back with the event TS_EVENT_CACHE_OPEN_READ_FAILED. The user (:arg:`contp`) has the option to cancel the action returned by TSCacheRead. Note that reentrant calls are possible, i.e. the cache can call back the user (:arg:`contp`) in the same call.