.\" 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 "TSHTTPTXNCLIENTSTREAMPRIORITYGET" "3ts" "Apr 16, 2024" "9.2" "Apache Traffic Server"
.SH NAME
TSHttpTxnClientStreamPriorityGet \- TSHttpTxnClientStreamPriorityGet 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 TSHttpTxnClientStreamPriorityGet(\fI\%TSHttpTxn\fP txnp, \fI\%TSHttpPriority\fP *priority) 
.UNINDENT
.SH DESCRIPTION
.sp
Retrieve the priority information for the HTTP stream associated with the
provided transaction.  The resultant priority information is populated in the
\fBpriority\fP output variable. The \fBTSHttpPriority\fP type is designed to be
agnostic of the various HTTP protocol versions that support HTTP streams. The
user should pass a pointer casted to \fBTSHttpPriority\fP from a previously
allocated \fBTSHttp2Priority\fP structure. This design anticipates future support
for HTTP versions that support streams, such as HTTP/3.
.sp
The \fBTSHttp2Priority\fP structure has the following declaration:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
typedef struct {
  uint8_t priority_type; /** HTTP_PROTOCOL_TYPE_HTTP_2 */
  int32_t stream_dependency;
  uint8_t weight;
} TSHttp2Priority;
.EE
.UNINDENT
.UNINDENT
.sp
In a call to \fBTSHttpTxnClientStreamPriorityGet\fP, the dependency and weight
will be populated in the \fBstream_dependency\fP and \fBweight\fP members,
respectively.  If the stream associated with the given transaction has no
dependency, then the \fBstream_dependency\fP output parameter will be populated
with \fB\-1\fP and the value of \fBweight\fP will be meaningless. See \fI\%RFC 7540\fP
section 5.3 for details concerning HTTP/2 stream priority.
.sp
This API returns an error if the provided transaction is not an HTTP/2
transaction.
.SH SEE ALSO
.sp
\fI\%TSHttpTxnClientStreamIdGet\fP
.SH COPYRIGHT
2024, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.