TSAPI TYPES(3ts)

NAME
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.

    ink_hrtime

    TSAction

    TSCacheKey

    TSConfig

    TSConfigDestroyFunc

    TSCont
        An opaque type that represents a Traffic Server continuation.

    TSEvent
        TSEvents are sent to continuations when they are called back.

        The TSEvent provides the continuation's handler function with information about the callback. Based on the event it receives, the handler function can decide what to do.

    TSEventFunc

    TSFile

    TSHostLookupResult

    TSHRTime
        "High Resolution Time"

        A 64 bit time value, measured in nanoseconds.

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

    TSHttpParser

    TSHttpSsn
        An opaque type that represents a Traffic Server session.

    TSHttpStatus
        This set of enums represents possible return values from TSHttpHdrStatusGet(), which retrieves the status code from an HTTP response header (TSHttpHdrStatusGet() retrieves status codes only from headers of type TS_HTTP_TYPE_RESPONSE).

        You can also set the TSHttpStatus of a response header using TSHttpHdrStatusSet().

    TSHttpTxn
        An opaque type that represents a Traffic Server HTTP transaction.

    TSHttpType
        This set of enums represents the possible HTTP types that can be assigned to an HTTP header.

        When a header is created with TSHttpHdrCreate(), it is automatically assigned a type of TS_HTTP_TYPE_UNKNOWN. You can modify the HTTP type ONCE after it the header is created, using TSHttpHdrTypeSet(). After setting the HTTP type once, you cannot set it again. Use TSHttpHdrTypeGet() to obtain the TSHttpType of an HTTP header.

    TSIOBuffer

    TSIOBufferBlock

    TSIOBufferReader

    TSIOBufferSizeIndex

    TSLifecycleHookID
        An enumeration that identifies a life cycle hook.

    TSMBuffer

    TSMgmtCounter

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

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

    TSMgmtString

    TSMimeParser

    TSMLoc

    TSMutex

    TSParseResult
        This set of enums are possible values returned by TSHttpHdrParseReq() and TSHttpHdrParseResp().

    TSPluginRegistrationInfo
        The following struct is used by TSPluginRegister().

        It stores registration information about the plugin.

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

    TSRemapInterface

    TSRemapRequestInfo

    TSRemapStatus

    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.

    TSSDKVersion
        Starting 2.0, SDK now follows same versioning as Traffic Server.

    TSServerState

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

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

    TSThread

    TSThreadFunc

    TSThreadPool

    TSVConn

    TSVIO

COPYRIGHT
2014, dev@trafficserver.apache.org