DOKK / manpages / debian 12 / trafficserver-dev / TSTypes.3ts.en
TSAPI TYPES(3ts) Apache Traffic Server TSAPI TYPES(3ts)

TSAPI Types - TSTypes API function

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


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.


Buffer type sufficient to contain an MD5 hash value.

See INK_MD5.

A data block intended to contain Traffic Server statistics.




An opaque type that represents a Traffic Server continuation.



A type representing the result of a call to TSHostLookup(). Use with TSHostLookupResultAddrGet().

"High Resolution Time"

A 64 bit time value, measured in nanoseconds.


A type that encapsulates options passed into the TSHttpConnectPlugin() function.
The type of data represented in the struct.

Network address of the target of the connection.

Tag that is passed through to the HTTP state machine.

Numeric identifier passed through to the HTTP state machine.

A numeric buffer size index used to derive actual sizes used when constructing IOBuffers; see TSIOBufferSizeIndex.

A numeric value specifying the minimum number of bytes that must be written to an IOBuffer before any continuation is called back to read from the buffer. See the TSIOBufferWaterMarkGet() and TSIOBufferWaterMarkSet() functions for further detail.


Enumeration that specifies the type of data within a TSHttpConnectOptions structure.


An opaque type that represents a Traffic Server session.

An opaque type that represents a Traffic Server HTTP transaction.





An enumeration that contains valid watermark values, currently only defaults.

An enumeration that identifies a life cycle hook.

Internally, data for a transaction is stored in one or more header heaps. These are storage local to the transaction, and generally each HTTP header is stored in a separate one. This type is a handle to a header heap, and is provided or required by functions that locate HTTP header related data.


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

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



This is a memory location relative to a header heap represented by a TSMBuffer and must always be used in conjunction with that TSMBuffer instance. It identifies a specific object in the TSMBuffer. This indirection is needed so that the TSMBuffer can reallocate space as needed. Therefore a raw address obtained from a TSMLoc should be considered volatile that may become invalid across any API call.

A predefined null valued TSMLoc used to indicate the absence of an TSMLoc.


The following struct is used by TSPluginRegister().

It stores registration information about the plugin.


Data passed to a remap plugin via TSRemapInit().
The size of the structure in bytes, including this member.

The API version of the C API. The lower 16 bits are the minor version, and the upper bits the major version.


Data passed to a remap plugin during the invocation of a remap rule.
The client request. All of the other TSMLoc values use this as the base buffer.

The client request.

The match URL in the remap rule.

The target URL in the remap rule.

The current request URL. The remap rule and plugins listed earlier in the remap rule can modify this from the client request URL. Remap plugins are expected to modify this value to perform the remapping of the request. Note this is the same TSMLoc as would be obtained by calling TSHttpTxnClientReqGet().

Flag for using the remapped URL as an explicit redirection. This can be set by the remap plugin.


Contains the data for a TLS certificate and key.
The TLS certificate name.

The length of the TLS certificate name.

The name of the TLS key.

The length of the name of the TLS key.


This type represents the X509 object created from an SSL certificate.

This type represents a custom log file that you create with TSTextLogObjectCreate().

Your plugin writes entries into this log file using TSTextLogObjectWrite().


This represents an internal Traffic Server thread, created by the Traffic Server core. It is an opaque type which can be used only to check for equality / inequality, and passed to API functions. An instance that refers to the current thread can be obtained with TSThreadSelf().

This type represents an event thread. It is an opaque which is used to specify a particular event processing thread in Traffic Server. If plugin code is executing in an event thread (which will be true if called from a hook or a scheduled event) then the current event thread can be obtained via TSEventThreadSelf().

A TSEventThread is also a TSThread and can be passed as an argument to any parameter of type TSThread.



An enum for the supported types of user arguments.

A version value for at TSUuid.
A version 4 UUID. Currently only this value is used.


Length of a UUID string.

A virtual connection. This is the basic mechanism for abstracting I/O operations in Traffic Server.

A subtype of TSVConn that provides additional IP network information and operations.


A module version.

A module version.

An anchor for a double linked intrusive list of instance of T.




A two part version number, defined in include/tscore/I_Version.h.
Major version number.

Minor version number.





The abstract type of the various HTTP priority implementations.
The reference to the concrete HTTP priority implementation. This will be a value from TSHttpPriorityType

The space allocated for the concrete priority implementation.

Note that this has to take padding into account. There is a static_assert in InkAPI.cc to verify that TSHttpPriority is at least as large as TSHttp2Priority. As other structures are added that are represented by TSHttpPriority add more static_asserts to verify that TSHttpPriority is as large as it needs to be.



A structure for HTTP/2 priority. For an explanation of these terms with respect to HTTP/2, see RFC 7540, section 5.3.
HTTP_PROTOCOL_TYPE_HTTP_2


The stream dependency. Per spec, see RFC 7540 section 6.2, this is 31 bits. We use a signed 32 bit structure to store either a valid dependency or -1 if the stream has no dependency.


2023, dev@trafficserver.apache.org

November 2, 2023 9.2