.\" Man page generated from reStructuredText. . .TH "TSAPI TYPES" "3ts" "Mar 08, 2019" "7.1" "Apache Traffic Server" .SH NAME TSAPI Types \- TSTypes 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 \fP \fI#include \fP .SH DESCRIPTION .sp The Apache Traffic Server API provides large number of types. Many of them are specific to a particular API function or function group, but others are used more widely. Those are described on this page. .INDENT 0.0 .TP .B ink_hrtime .UNINDENT .INDENT 0.0 .TP .B TSAction .UNINDENT .INDENT 0.0 .TP .B TSCacheKey .UNINDENT .INDENT 0.0 .TP .B TSConfig .UNINDENT .INDENT 0.0 .TP .B TSConfigDestroyFunc .UNINDENT .INDENT 0.0 .TP .B TSCont An opaque type that represents a Traffic Server continuation\&. .UNINDENT .INDENT 0.0 .TP .B TSEventFunc .UNINDENT .INDENT 0.0 .TP .B TSFile .UNINDENT .INDENT 0.0 .TP .B TSHostLookupResult .UNINDENT .INDENT 0.0 .TP .B TSHRTime "High Resolution Time" .sp A 64 bit time value, measured in nanoseconds. .UNINDENT .INDENT 0.0 .TP .B TSHttpParser .UNINDENT .INDENT 0.0 .TP .B TSHttpSsn An opaque type that represents a Traffic SeUuirver session\&. .UNINDENT .INDENT 0.0 .TP .B TSHttpTxn An opaque type that represents a Traffic Server HTTP transaction\&. .UNINDENT .INDENT 0.0 .TP .B TSIOBuffer .UNINDENT .INDENT 0.0 .TP .B TSIOBufferBlock .UNINDENT .INDENT 0.0 .TP .B TSIOBufferReader .UNINDENT .INDENT 0.0 .TP .B TSIOBufferSizeIndex .UNINDENT .INDENT 0.0 .TP .B TSLifecycleHookID An enumeration that identifies a life cycle hook\&. .UNINDENT .INDENT 0.0 .TP .B TSMBuffer .UNINDENT .INDENT 0.0 .TP .B TSMgmtCounter .UNINDENT .INDENT 0.0 .TP .B TSMgmtFloat The type used internally for a floating point value. This corresponds to the value \fBTS_RECORDDATATYPE_FLOAT\fP for \fBTSRecordDataType\fP\&. .UNINDENT .INDENT 0.0 .TP .B TSMgmtInt The type used internally for an integer. This corresponds to the value \fBTS_RECORDDATATYPE_INT\fP for \fBTSRecordDataType\fP\&. .UNINDENT .INDENT 0.0 .TP .B TSMgmtString .UNINDENT .INDENT 0.0 .TP .B TSMimeParser .UNINDENT .INDENT 0.0 .TP .B TSMLoc .UNINDENT .INDENT 0.0 .TP .B \fI\%TSMLoc\fP TS_NULL_MLOC A predefined null valued \fI\%TSMLoc\fP used to indicate the absence of an \fI\%TSMLoc\fP\&. .UNINDENT .INDENT 0.0 .TP .B TSMutex .UNINDENT .INDENT 0.0 .TP .B TSPluginRegistrationInfo The following struct is used by \fBTSPluginRegister()\fP\&. .sp It stores registration information about the plugin. .UNINDENT .INDENT 0.0 .TP .B TSRemapInterface .UNINDENT .INDENT 0.0 .TP .B TSRemapRequestInfo .UNINDENT .INDENT 0.0 .TP .B TSTextLogObject This type represents a custom log file that you create with \fBTSTextLogObjectCreate()\fP\&. .sp Your plugin writes entries into this log file using \fBTSTextLogObjectWrite()\fP\&. .UNINDENT .INDENT 0.0 .TP .B TSThread .UNINDENT .INDENT 0.0 .TP .B TSThreadFunc .UNINDENT .INDENT 0.0 .TP .B TSUuidVersion A version value for at \fBTSUuid\fP\&. .INDENT 7.0 .TP .B TS_UUID_V4 A version 4 UUID. Currently only this value is used. .UNINDENT .UNINDENT .INDENT 0.0 .TP .B size_t TS_UUID_STRING_LEN Length of a UUID string. .UNINDENT .INDENT 0.0 .TP .B TSVConn A virtual connection. This is the basic mechanism for abstracting I/O operations in Traffic Server\&. .UNINDENT .INDENT 0.0 .TP .B TSNetVConnection A subtype of \fI\%TSVConn\fP that provides additional IP network information and operations. .UNINDENT .INDENT 0.0 .TP .B TSVIO .UNINDENT .INDENT 0.0 .TP .B ModuleVersion A module version. .UNINDENT .INDENT 0.0 .TP .B type ModuleVersion A module version. .UNINDENT .INDENT 0.0 .TP .B template class DLL An anchor for a double linked instrusive list of instance of \fIT\fP\&. .UNINDENT .INDENT 0.0 .TP .B TSAcceptor .UNINDENT .INDENT 0.0 .TP .B TSNextProtocolSet .UNINDENT .SH COPYRIGHT 2019, dev@trafficserver.apache.org .\" Generated by docutils manpage writer. .