.\" Man page generated from reStructuredText.
.
.TH "TSCACHEREAD" "3ts" "January 24, 2017" "7.0" "Apache Traffic Server"
.SH NAME
TSCacheRead \- 
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fI#include <ts/ts.h>\fP
.INDENT 0.0
.TP
.B TSAction TSCacheRead(TSCont\fI\ contp\fP, TSCacheKey\fI\ key\fP)
.UNINDENT
.SH DESCRIPTION
.sp
Asks the Traffic Server cache if the object corresponding to \fIkey\fP exists
in the cache and can be read.
.sp
If the object can be read, the Traffic Server cache calls the continuation
\fIcontp\fP back with the event \fBTS_EVENT_CACHE_OPEN_READ\fP\&. In this case,
the cache also passes \fIcontp\fP a cache vconnection and \fIcontp\fP can then
initiate a read operation on that vconnection using \fBTSVConnRead\fP\&.
.sp
If the object cannot be read, the cache calls \fIcontp\fP back with the event
\fBTS_EVENT_CACHE_OPEN_READ_FAILED\fP\&. The user (\fIcontp\fP) has the option to
cancel the action returned by \fI\%TSCacheRead\fP\&. Note that reentrant calls
are possible, i.e. the cache can call back the user (\fIcontp\fP) in the same
call.
.SH COPYRIGHT
2015, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.