.\" Man page generated from reStructuredText.
.
.TH "TSHTTPTXNINFOINTGET" "3ts" "Mar 08, 2019" "7.1" "Apache Traffic Server"
.SH NAME
TSHttpTxnInfoIntGet \- TSHttpTxnInfoIntGet API function
.
.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 TSReturnCode TSHttpTxnInfoIntGet(TSHttpTxn\fI\ txnp\fP, \fI\%TSHttpTxnInfoKey\fP\fI\ key\fP, TSMgmtInt *\fI\ value\fP)
.UNINDENT
.SH DESCRIPTION
.sp
\fI\%TSHttpTxnInfoIntGet()\fP returns arbitrary integer\-typed info about a transaction as defined in
\fI\%TSHttpTxnInfoKey\fP\&. The API will be part of a generic API umbrella that can support returning
arbitrary info about a transaction using custom log tags. It works on multiple hooks depending on the
requested info. For example, cache related info may be available only at or after \fBTS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK\fP hook.
.sp
The \fI\%TSHttpTxnInfoKey\fP currently supports the below integer\-based info about a transaction
.INDENT 0.0
.TP
.B TSHttpTxnInfoKey
.INDENT 7.0
.TP
.B TS_TXN_INFO_CACHE_HIT_RAM
This info is available at or after \fBTS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK\fP hook. A value of \fB1\fP indicates that the response
is returned from RAM cache. A value of \fB0\fP indicates otherwise.
.UNINDENT
.INDENT 7.0
.TP
.B TS_TXN_INFO_CACHE_COMPRESSED_IN_RAM
This info is available at or after \fBTS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK\fP hook. A value of 1 indicates that the response
is returned from RAM cache and is compressed. A value of 0 indicates otherwise.
.UNINDENT
.INDENT 7.0
.TP
.B TS_TXN_INFO_CACHE_HIT_RWW
This info is available at or after \fBTS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK\fP hook. A value of 1 indicates that the response
is returned via Read\-While\-Writer functionality. A value of 0 indicates otherwise.
.UNINDENT
.INDENT 7.0
.TP
.B TS_TXN_INFO_CACHE_OPEN_READ_TRIES
This info is available at or after \fBTS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK\fP hook. The value indicates the number of cache open
read reattempts made by the transaction on cache open read failure.
.UNINDENT
.INDENT 7.0
.TP
.B TS_TXN_INFO_CACHE_OPEN_WRITE_TRIES
This info is available at or after \fBTS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK\fP hook. The value indicates the number of cache open
write reattempts made by the transaction on cache open write failure.
.UNINDENT
.INDENT 7.0
.TP
.B TS_TXN_INFO_CACHE_VOLUME
This info is available at or after \fBTS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK\fP hook. The value indicates the cache volume ID used
for the cache object associated with the transaction.
.UNINDENT
.UNINDENT
.SH RETURN VALUES
.sp
The API returns \fBTS_SUCCESS\fP, if the requested info is supported, \fBTS_ERROR\fP otherwise.
.SH COPYRIGHT
2019, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.