TSAPI Types

Synopsis

#include <ts/ts.h>
#include <ts/remap.h>

Description

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.

TSCont

An opaque type that represents a Traffic Server continuation.

TSHttpHookID

An enumeration that identifies a specific type of hook for HTTP transactions.

TSHttpSsn

An opaque type that represents a Traffic Server session.

TSHRTime

“High Resolution Time”

A 64 bit time value, measured in nanoseconds.

TSHttpTxn

An opaque type that represents a Traffic Server HTTP transaction.

TSLifecycleHookID

An enumeration that identifies a life cycle hook.

TSReturnCode

An indicator of the results of an API call. A value of TS_SUCCESS means the call was successful. Any other value indicates a failure and is specific to the API call.

TSRecordDataType

An enumeration that specifies the type of a value in an internal data structure that is accessible via the API.

TSMgmtInt

The type used internally for an integer. This corresponds to the value TS_RECORDDATATYPE_INT for TSRecordDataType.

TSMgmtFloat

The type used internally for a floating point value. This corresponds to the value TS_RECORDDATATYPE_FLOAT for TSRecordDataType.