.\" Man page generated from reStructuredText. . .TH "TSAPI TYPES" "3ts" "Jan 04, 2023" "8.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 type ink_hrtime .UNINDENT .INDENT 0.0 .TP .B type INK_MD5 Buffer type sufficient to contain an MD5 hash value. .UNINDENT .INDENT 0.0 .TP .B class INK_MD5 See \fI\%INK_MD5\fP\&. .UNINDENT .INDENT 0.0 .TP .B class RecRawStatBlock A data block intended to contain Traffic Server statistics. .UNINDENT .INDENT 0.0 .TP .B type TSAction .UNINDENT .INDENT 0.0 .TP .B type TSCacheKey .UNINDENT .INDENT 0.0 .TP .B type TSConfig .UNINDENT .INDENT 0.0 .TP .B type TSConfigDestroyFunc .UNINDENT .INDENT 0.0 .TP .B type TSCont An opaque type that represents a Traffic Server continuation\&. .UNINDENT .INDENT 0.0 .TP .B type TSEventFunc .UNINDENT .INDENT 0.0 .TP .B type TSFile .UNINDENT .INDENT 0.0 .TP .B type TSHostLookupResult A type representing the result of a call to \fBTSHostLookup()\fP\&. Use with \fBTSHostLookupResultAddrGet()\fP\&. .UNINDENT .INDENT 0.0 .TP .B type TSHRTime "High Resolution Time" .sp A 64 bit time value, measured in nanoseconds. .UNINDENT .INDENT 0.0 .TP .B type TSHttpParser .UNINDENT .INDENT 0.0 .TP .B type TSHttpSsn An opaque type that represents a Traffic SeUuirver session\&. .UNINDENT .INDENT 0.0 .TP .B type TSHttpTxn An opaque type that represents a Traffic Server HTTP transaction\&. .UNINDENT .INDENT 0.0 .TP .B type TSIOBuffer .UNINDENT .INDENT 0.0 .TP .B type TSIOBufferBlock .UNINDENT .INDENT 0.0 .TP .B type TSIOBufferReader .UNINDENT .INDENT 0.0 .TP .B type TSIOBufferSizeIndex .UNINDENT .INDENT 0.0 .TP .B type TSLifecycleHookID An enumeration that identifies a life cycle hook\&. .UNINDENT .INDENT 0.0 .TP .B type TSMBuffer .UNINDENT .INDENT 0.0 .TP .B type TSMgmtCounter .UNINDENT .INDENT 0.0 .TP .B type 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 type 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 type TSMgmtString .UNINDENT .INDENT 0.0 .TP .B type TSMimeParser .UNINDENT .INDENT 0.0 .TP .B type 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 type TSMutex .UNINDENT .INDENT 0.0 .TP .B type TSPluginRegistrationInfo The following struct is used by \fBTSPluginRegister()\fP\&. .sp It stores registration information about the plugin. .UNINDENT .INDENT 0.0 .TP .B type TSRemapInterface .UNINDENT .INDENT 0.0 .TP .B type TSRemapRequestInfo .UNINDENT .INDENT 0.0 .TP .B type TSSslX509 This type represents the \fBX509\fP object created from an SSL certificate. .UNINDENT .INDENT 0.0 .TP .B type 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 type TSThread .UNINDENT .INDENT 0.0 .TP .B type TSThreadFunc .UNINDENT .INDENT 0.0 .TP .B type 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 type TSVConn A virtual connection. This is the basic mechanism for abstracting I/O operations in Traffic Server\&. .UNINDENT .INDENT 0.0 .TP .B type TSNetVConnection A subtype of \fI\%TSVConn\fP that provides additional IP network information and operations. .UNINDENT .INDENT 0.0 .TP .B type TSVIO .UNINDENT .INDENT 0.0 .TP .B type 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 template class Queue .UNINDENT .INDENT 0.0 .TP .B type TSAcceptor .UNINDENT .INDENT 0.0 .TP .B type TSNextProtocolSet .UNINDENT .INDENT 0.0 .TP .B template class LINK .UNINDENT .INDENT 0.0 .TP .B class VersionNumber A two part version number, defined in \fI\%include/tscore/I_Version.h\fP\&. .INDENT 7.0 .TP .B short int ink_major Major version number. .UNINDENT .INDENT 7.0 .TP .B short int ink_minor Minor version number. .UNINDENT .UNINDENT .SH COPYRIGHT 2023, dev@trafficserver.apache.org .\" Generated by docutils manpage writer. .