.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "TSHTTPTXNCLIENTREQGET" "3ts" "Jan 06, 2024" "9.2" "Apache Traffic Server"
.SH NAME
TSHttpTxnClientReqGet \- TSHttpTxnClientReqGet API function
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <ts/ts.h>
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \fI\%TSReturnCode\fP TSHttpTxnClientReqGet(\fI\%TSHttpTxn\fP txnp, \fI\%TSMBuffer\fP *bufp, \fI\%TSMLoc\fP *offset) 
.UNINDENT
.SH DESCRIPTION
.sp
Get the client request. The \fItxnp\fP must be passed in and the values in \fIbufp\fP and
\fIoffset\fP are updated to refer to the client request in the transaction. A typical use case
would look like
.INDENT 0.0
.INDENT 3.5
.sp
.EX
int
CB_Read_Req_Hdr_Hook(TSCont contp, TSEvent event, void* data) {
   auto txnp = reinterpret_cast<TSHttpTxn>(data);
   TSMBuffer creq_buff;
   TSMLoc creq_loc;
   if (TS_SUCCESS == TSHttpTxnClientReqGet(txnp, &creq_buff, &creq_loc)) {
      // use the client request
   } // else values in creq_buff, creq_loc are garbage.
   TSHttpTxnReenable(txnp);
   return 0;
}
.EE
.UNINDENT
.UNINDENT
.sp
The values placed in \fIbufp\fP and \fIoffset\fP are stable for the transaction and need only be
retrieved once per transaction. Note these values are valid only if this function returns
\fBTS_SUCCESS\fP\&.
.SH COPYRIGHT
2024, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.