.\" Man page generated from reStructuredText. . .TH "TSAPI TYPES" "3ts" "January 24, 2017" "7.0" "Apache Traffic Server" .SH NAME TSAPI Types \- . .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 \fIcontinuation\fP\&. .UNINDENT .INDENT 0.0 .TP .B TSEvent \fBTSEvents\fP are sent to continuations when they are called back. .sp The \fBTSEvent\fP provides the continuation\(aqs handler function with information about the callback. Based on the event it receives, the handler function can decide what to do. .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 TSHttpHookID An enumeration that identifies a specific type of hook for HTTP transactions. .UNINDENT .INDENT 0.0 .TP .B TSHttpParser .UNINDENT .INDENT 0.0 .TP .B TSHttpSsn An opaque type that represents a Traffic Server \fIsession\fP\&. .UNINDENT .INDENT 0.0 .TP .B TSHttpStatus This set of enums represents possible return values from \fBTSHttpHdrStatusGet()\fP, which retrieves the status code from an HTTP response header (\fBTSHttpHdrStatusGet()\fP retrieves status codes only from headers of type \fBTS_HTTP_TYPE_RESPONSE\fP). .sp You can also set the \fBTSHttpStatus\fP of a response header using \fBTSHttpHdrStatusSet()\fP\&. .UNINDENT .INDENT 0.0 .TP .B TSHttpTxn An opaque type that represents a Traffic Server HTTP \fItransaction\fP\&. .UNINDENT .INDENT 0.0 .TP .B TSHttpType This set of enums represents the possible HTTP types that can be assigned to an HTTP header. .sp When a header is created with \fBTSHttpHdrCreate()\fP, it is automatically assigned a type of \fBTS_HTTP_TYPE_UNKNOWN\fP\&. You can modify the HTTP type ONCE after it the header is created, using \fBTSHttpHdrTypeSet()\fP\&. After setting the HTTP type once, you cannot set it again. Use \fBTSHttpHdrTypeGet()\fP to obtain the \fBTSHttpType\fP of an HTTP header. .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 \fIlife cycle hook\fP\&. .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 TSMutex .UNINDENT .INDENT 0.0 .TP .B TSParseResult This set of enums are possible values returned by \fBTSHttpHdrParseReq()\fP and \fBTSHttpHdrParseResp()\fP\&. .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 TSRecordDataType An enumeration that specifies the type of a value in an internal data structure that is accessible via the API. .UNINDENT .INDENT 0.0 .TP .B TSRemapInterface .UNINDENT .INDENT 0.0 .TP .B TSRemapRequestInfo .UNINDENT .INDENT 0.0 .TP .B TSRemapStatus .UNINDENT .INDENT 0.0 .TP .B TSReturnCode An indicator of the results of an API call. A value of \fBTS_SUCCESS\fP means the call was successful. Any other value indicates a failure and is specific to the API call. .UNINDENT .INDENT 0.0 .TP .B TSSDKVersion Starting 2.0, SDK now follows same versioning as Traffic Server. .UNINDENT .INDENT 0.0 .TP .B TSServerState .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 TSThreadPool .UNINDENT .INDENT 0.0 .TP .B TSVConn .UNINDENT .INDENT 0.0 .TP .B TSVIO .UNINDENT .SH COPYRIGHT 2015, dev@trafficserver.apache.org .\" Generated by docutils manpage writer. .