This header file defines common types that can be shared between internal code and TS APIs. More...

#include <stdint.h>
#include <sys/types.h>
#include <sys/socket.h>

Include dependency graph for apidefs.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	TSPluginRegistrationInfo
	The following struct is used by TSPluginRegister(). More...
union	TSRecordData
struct	TSFetchEvent
struct	TSFetchUrlParams
Defines
#define	tsapi
#define	TS_PRINTFLIKE(fmt, arg)
#define	TS_NORETURN
#define	TS_VERSION_STRING "5.2.0"
#define	TS_VERSION_NUMBER 5002000
#define	TS_VERSION_MAJOR 5
#define	TS_VERSION_MINOR 2
#define	TS_VERSION_MICRO 0
#define	TS_HTTP_VERSION(a, b) ((((a) & 0xFFFF) << 16) \| ((b) & 0xFFFF))
#define	TS_HTTP_MINOR(v) ((v) & 0xFFFF)
#define	TS_HTTP_MAJOR(v) (((v) >> 16) & 0xFFFF)
#define	__TS_RES_PATH(x) #x
#define	_TS_RES_PATH(x) __TS_RES_PATH (x)
#define	TS_RES_PATH(x) x __FILE__ ":" _TS_RES_PATH (__LINE__)
#define	TS_RES_MEM_PATH TS_RES_PATH ("memory/")
#define	TS_MAX_USER_NAME_LEN 256
#define	TS_DEPRECATED __attribute__ ((deprecated))
#define	TS_HTTP_READ_REQUEST_PRE_REMAP_HOOK TS_HTTP_PRE_REMAP_HOOK
#define	TS_EVENT_HTTP_READ_REQUEST_PRE_REMAP TS_EVENT_HTTP_PRE_REMAP
#define	_HTTP_PROXY_API_ENUMS_H_
Typedefs
typedef int64_t	TSHRTime
typedef int64_t	TSMgmtInt
typedef int64_t	TSMgmtCounter
typedef float	TSMgmtFloat
typedef char *	TSMgmtString
typedef struct tsapi_file *	TSFile
typedef struct tsapi_mloc *	TSMLoc
typedef struct tsapi_mbuffer *	TSMBuffer
typedef struct tsapi_httpssn *	TSHttpSsn
typedef struct tsapi_httptxn *	TSHttpTxn
typedef struct tsapi_httpaltinfo *	TSHttpAltInfo
typedef struct tsapi_mimeparser *	TSMimeParser
typedef struct tsapi_httpparser *	TSHttpParser
typedef struct tsapi_cachekey *	TSCacheKey
typedef struct tsapi_cachehttpinfo *	TSCacheHttpInfo
typedef struct tsapi_cachetxn *	TSCacheTxn
typedef struct tsapi_port *	TSPortDescriptor
typedef struct tsapi_vio *	TSVIO
typedef struct tsapi_thread *	TSThread
typedef struct tsapi_mutex *	TSMutex
typedef struct tsapi_config *	TSConfig
typedef struct tsapi_cont *	TSCont
typedef struct tsapi_cont *	TSVConn
typedef struct tsapi_action *	TSAction
typedef struct tsapi_iobuffer *	TSIOBuffer
typedef struct tsapi_iobufferdata *	TSIOBufferData
typedef struct tsapi_bufferblock *	TSIOBufferBlock
typedef struct tsapi_bufferreader *	TSIOBufferReader
typedef struct tsapi_hostlookupresult *	TSHostLookupResult
typedef struct tsapi_aiocallback *	TSAIOCallback
typedef void (	TSThreadFunc )(void *data)
typedef int(*	TSEventFunc )(TSCont contp, TSEvent event, void *edata)
typedef void(*	TSConfigDestroyFunc )(void *data)
typedef struct TSFetchUrlParams	TSFetchUrlParams_t
Enumerations
enum	TSParseResult { TS_PARSE_ERROR = -1, TS_PARSE_DONE = 0, TS_PARSE_OK = 1, TS_PARSE_CONT = 2 }
	This set of enums are possible values returned by TSHttpHdrParseReq() and TSHttpHdrParseResp(). More...
enum	TSHttpType { TS_HTTP_TYPE_UNKNOWN, TS_HTTP_TYPE_REQUEST, TS_HTTP_TYPE_RESPONSE }
	This set of enums represents the possible HTTP types that can be assigned to an HTTP header. More...
enum	TSHttpStatus { TS_HTTP_STATUS_NONE = 0, TS_HTTP_STATUS_CONTINUE = 100, TS_HTTP_STATUS_SWITCHING_PROTOCOL = 101, TS_HTTP_STATUS_OK = 200, TS_HTTP_STATUS_CREATED = 201, TS_HTTP_STATUS_ACCEPTED = 202, TS_HTTP_STATUS_NON_AUTHORITATIVE_INFORMATION = 203, TS_HTTP_STATUS_NO_CONTENT = 204, TS_HTTP_STATUS_RESET_CONTENT = 205, TS_HTTP_STATUS_PARTIAL_CONTENT = 206, TS_HTTP_STATUS_MULTI_STATUS = 207, TS_HTTP_STATUS_ALREADY_REPORTED = 208, TS_HTTP_STATUS_IM_USED = 211, TS_HTTP_STATUS_MULTIPLE_CHOICES = 300, TS_HTTP_STATUS_MOVED_PERMANENTLY = 301, TS_HTTP_STATUS_MOVED_TEMPORARILY = 302, TS_HTTP_STATUS_SEE_OTHER = 303, TS_HTTP_STATUS_NOT_MODIFIED = 304, TS_HTTP_STATUS_USE_PROXY = 305, TS_HTTP_STATUS_TEMPORARY_REDIRECT = 307, TS_HTTP_STATUS_PERMANENT_REDIRECT = 308, TS_HTTP_STATUS_BAD_REQUEST = 400, TS_HTTP_STATUS_UNAUTHORIZED = 401, TS_HTTP_STATUS_PAYMENT_REQUIRED = 402, TS_HTTP_STATUS_FORBIDDEN = 403, TS_HTTP_STATUS_NOT_FOUND = 404, TS_HTTP_STATUS_METHOD_NOT_ALLOWED = 405, TS_HTTP_STATUS_NOT_ACCEPTABLE = 406, TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED = 407, TS_HTTP_STATUS_REQUEST_TIMEOUT = 408, TS_HTTP_STATUS_CONFLICT = 409, TS_HTTP_STATUS_GONE = 410, TS_HTTP_STATUS_LENGTH_REQUIRED = 411, TS_HTTP_STATUS_PRECONDITION_FAILED = 412, TS_HTTP_STATUS_REQUEST_ENTITY_TOO_LARGE = 413, TS_HTTP_STATUS_REQUEST_URI_TOO_LONG = 414, TS_HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE = 415, TS_HTTP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE = 416, TS_HTTP_STATUS_EXPECTATION_FAILED = 417, TS_HTTP_STATUS_UNPROCESSABLE_ENTITY = 422, TS_HTTP_STATUS_LOCKED = 423, TS_HTTP_STATUS_FAILED_DEPENDENCY = 424, TS_HTTP_STATUS_UPGRADE_REQUIRED = 426, TS_HTTP_STATUS_PRECONDITION_REQUIRED = 428, TS_HTTP_STATUS_TOO_MANY_REQUESTS = 429, TS_HTTP_STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE = 431, TS_HTTP_STATUS_INTERNAL_SERVER_ERROR = 500, TS_HTTP_STATUS_NOT_IMPLEMENTED = 501, TS_HTTP_STATUS_BAD_GATEWAY = 502, TS_HTTP_STATUS_SERVICE_UNAVAILABLE = 503, TS_HTTP_STATUS_GATEWAY_TIMEOUT = 504, TS_HTTP_STATUS_HTTPVER_NOT_SUPPORTED = 505, TS_HTTP_STATUS_VARIANT_ALSO_NEGOTIATES = 506, TS_HTTP_STATUS_INSUFFICIENT_STORAGE = 507, TS_HTTP_STATUS_LOOP_DETECTED = 508, TS_HTTP_STATUS_NOT_EXTENDED = 510, TS_HTTP_STATUS_NETWORK_AUTHENTICATION_REQUIRED = 511 }
	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). More...
enum	TSHttpHookID { TS_HTTP_READ_REQUEST_HDR_HOOK, TS_HTTP_OS_DNS_HOOK, TS_HTTP_SEND_REQUEST_HDR_HOOK, TS_HTTP_READ_CACHE_HDR_HOOK, TS_HTTP_READ_RESPONSE_HDR_HOOK, TS_HTTP_SEND_RESPONSE_HDR_HOOK, TS_HTTP_REQUEST_TRANSFORM_HOOK, TS_HTTP_RESPONSE_TRANSFORM_HOOK, TS_HTTP_SELECT_ALT_HOOK, TS_HTTP_TXN_START_HOOK, TS_HTTP_TXN_CLOSE_HOOK, TS_HTTP_SSN_START_HOOK, TS_HTTP_SSN_CLOSE_HOOK, TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK, TS_HTTP_PRE_REMAP_HOOK, TS_HTTP_POST_REMAP_HOOK, TS_HTTP_RESPONSE_CLIENT_HOOK, TS_HTTP_LAST_HOOK }
	This set of enums represents the possible hooks where you can set up continuation callbacks. More...
enum	TSLifecycleHookID { TS_LIFECYCLE_PORTS_INITIALIZED_HOOK, TS_LIFECYCLE_PORTS_READY_HOOK, TS_LIFECYCLE_CACHE_READY_HOOK, TS_LIFECYCLE_SERVER_SSL_CTX_INITIALIZED_HOOK, TS_LIFECYCLE_CLIENT_SSL_CTX_INITIALIZED_HOOK, TS_LIFECYCLE_LAST_HOOK }
	Plugin lifecycle hooks. More...
enum	TSEvent { TS_EVENT_NONE = 0, TS_EVENT_IMMEDIATE = 1, TS_EVENT_TIMEOUT = 2, TS_EVENT_ERROR = 3, TS_EVENT_CONTINUE = 4, TS_EVENT_VCONN_READ_READY = 100, TS_EVENT_VCONN_WRITE_READY = 101, TS_EVENT_VCONN_READ_COMPLETE = 102, TS_EVENT_VCONN_WRITE_COMPLETE = 103, TS_EVENT_VCONN_EOS = 104, TS_EVENT_VCONN_INACTIVITY_TIMEOUT = 105, TS_EVENT_NET_CONNECT = 200, TS_EVENT_NET_CONNECT_FAILED = 201, TS_EVENT_NET_ACCEPT = 202, TS_EVENT_NET_ACCEPT_FAILED = 204, TS_EVENT_INTERNAL_206 = 206, TS_EVENT_INTERNAL_207 = 207, TS_EVENT_INTERNAL_208 = 208, TS_EVENT_INTERNAL_209 = 209, TS_EVENT_INTERNAL_210 = 210, TS_EVENT_INTERNAL_211 = 211, TS_EVENT_INTERNAL_212 = 212, TS_EVENT_HOST_LOOKUP = 500, TS_EVENT_CACHE_OPEN_READ = 1102, TS_EVENT_CACHE_OPEN_READ_FAILED = 1103, TS_EVENT_CACHE_OPEN_WRITE = 1108, TS_EVENT_CACHE_OPEN_WRITE_FAILED = 1109, TS_EVENT_CACHE_REMOVE = 1112, TS_EVENT_CACHE_REMOVE_FAILED = 1113, TS_EVENT_CACHE_SCAN = 1120, TS_EVENT_CACHE_SCAN_FAILED = 1121, TS_EVENT_CACHE_SCAN_OBJECT = 1122, TS_EVENT_CACHE_SCAN_OPERATION_BLOCKED = 1123, TS_EVENT_CACHE_SCAN_OPERATION_FAILED = 1124, TS_EVENT_CACHE_SCAN_DONE = 1125, TS_EVENT_CACHE_LOOKUP = 1126, TS_EVENT_CACHE_READ = 1127, TS_EVENT_CACHE_DELETE = 1128, TS_EVENT_CACHE_WRITE = 1129, TS_EVENT_CACHE_WRITE_HEADER = 1130, TS_EVENT_CACHE_CLOSE = 1131, TS_EVENT_CACHE_LOOKUP_READY = 1132, TS_EVENT_CACHE_LOOKUP_COMPLETE = 1133, TS_EVENT_CACHE_READ_READY = 1134, TS_EVENT_CACHE_READ_COMPLETE = 1135, TS_EVENT_INTERNAL_1200 = 1200, TS_AIO_EVENT_DONE = 3900, TS_EVENT_HTTP_CONTINUE = 60000, TS_EVENT_HTTP_ERROR = 60001, TS_EVENT_HTTP_READ_REQUEST_HDR = 60002, TS_EVENT_HTTP_OS_DNS = 60003, TS_EVENT_HTTP_SEND_REQUEST_HDR = 60004, TS_EVENT_HTTP_READ_CACHE_HDR = 60005, TS_EVENT_HTTP_READ_RESPONSE_HDR = 60006, TS_EVENT_HTTP_SEND_RESPONSE_HDR = 60007, TS_EVENT_HTTP_REQUEST_TRANSFORM = 60008, TS_EVENT_HTTP_RESPONSE_TRANSFORM = 60009, TS_EVENT_HTTP_SELECT_ALT = 60010, TS_EVENT_HTTP_TXN_START = 60011, TS_EVENT_HTTP_TXN_CLOSE = 60012, TS_EVENT_HTTP_SSN_START = 60013, TS_EVENT_HTTP_SSN_CLOSE = 60014, TS_EVENT_HTTP_CACHE_LOOKUP_COMPLETE = 60015, TS_EVENT_HTTP_PRE_REMAP = 60016, TS_EVENT_HTTP_POST_REMAP = 60017, TS_EVENT_LIFECYCLE_PORTS_INITIALIZED = 60018, TS_EVENT_LIFECYCLE_PORTS_READY = 60019, TS_EVENT_LIFECYCLE_CACHE_READY = 60020, TS_EVENT_LIFECYCLE_SERVER_SSL_CTX_INITIALIZED = 60021, TS_EVENT_LIFECYCLE_CLIENT_SSL_CTX_INITIALIZED = 60022, TS_EVENT_MGMT_UPDATE = 60100, TS_EVENT_INTERNAL_60200 = 60200, TS_EVENT_INTERNAL_60201 = 60201, TS_EVENT_INTERNAL_60202 = 60202 }
	TSEvents are sent to continuations when they are called back. More...
enum	TSServerState { TS_SRVSTATE_STATE_UNDEFINED = 0, TS_SRVSTATE_ACTIVE_TIMEOUT, TS_SRVSTATE_BAD_INCOMING_RESPONSE, TS_SRVSTATE_CONNECTION_ALIVE, TS_SRVSTATE_CONNECTION_CLOSED, TS_SRVSTATE_CONNECTION_ERROR, TS_SRVSTATE_INACTIVE_TIMEOUT, TS_SRVSTATE_OPEN_RAW_ERROR, TS_SRVSTATE_PARSE_ERROR, TS_SRVSTATE_TRANSACTION_COMPLETE, TS_SRVSTATE_CONGEST_CONTROL_CONGESTED_ON_F, TS_SRVSTATE_CONGEST_CONTROL_CONGESTED_ON_M }
enum	TSLookingUpType { TS_LOOKUP_UNDEFINED_LOOKUP, TS_LOOKUP_ICP_SUGGESTED_HOST, TS_LOOKUP_PARENT_PROXY, TS_LOOKUP_ORIGIN_SERVER, TS_LOOKUP_INCOMING_ROUTER, TS_LOOKUP_HOST_NONE }
enum	TSCacheLookupResult { TS_CACHE_LOOKUP_MISS, TS_CACHE_LOOKUP_HIT_STALE, TS_CACHE_LOOKUP_HIT_FRESH, TS_CACHE_LOOKUP_SKIPPED }
enum	TSCacheDataType { TS_CACHE_DATA_TYPE_NONE, TS_CACHE_DATA_TYPE_HTTP, TS_CACHE_DATA_TYPE_OTHER }
enum	TSCacheError { TS_CACHE_ERROR_NO_DOC = -20400, TS_CACHE_ERROR_DOC_BUSY = -20401, TS_CACHE_ERROR_NOT_READY = -20407 }
enum	TSCacheScanResult { TS_CACHE_SCAN_RESULT_DONE = 0, TS_CACHE_SCAN_RESULT_CONTINUE = 1, TS_CACHE_SCAN_RESULT_DELETE = 10, TS_CACHE_SCAN_RESULT_DELETE_ALL_ALTERNATES, TS_CACHE_SCAN_RESULT_UPDATE, TS_CACHE_SCAN_RESULT_RETRY }
enum	TSVConnCloseFlags { TS_VC_CLOSE_ABORT = -1, TS_VC_CLOSE_NORMAL = 1 }
enum	TSIOBufferSizeIndex { TS_IOBUFFER_SIZE_INDEX_128 = 0, TS_IOBUFFER_SIZE_INDEX_256 = 1, TS_IOBUFFER_SIZE_INDEX_512 = 2, TS_IOBUFFER_SIZE_INDEX_1K = 3, TS_IOBUFFER_SIZE_INDEX_2K = 4, TS_IOBUFFER_SIZE_INDEX_4K = 5, TS_IOBUFFER_SIZE_INDEX_8K = 6, TS_IOBUFFER_SIZE_INDEX_16K = 7, TS_IOBUFFER_SIZE_INDEX_32K = 8 }
enum	TSSDKVersion { TS_SDK_VERSION_2_0 = 0, TS_SDK_VERSION_3_0 }
	Starting 2.0, SDK now follows same versioning as Traffic Server. More...
enum	TSReturnCode { TS_ERROR = -1, TS_SUCCESS = 0 }
enum	TSFetchWakeUpOptions { NO_CALLBACK = 0, AFTER_HEADER, AFTER_BODY }
enum	TSServerSessionSharingMatchType { TS_SERVER_SESSION_SHARING_MATCH_NONE, TS_SERVER_SESSION_SHARING_MATCH_BOTH, TS_SERVER_SESSION_SHARING_MATCH_IP, TS_SERVER_SESSION_SHARING_MATCH_HOST, TS_SERVER_SESSION_SHARING_MATCH_NONE, TS_SERVER_SESSION_SHARING_MATCH_BOTH, TS_SERVER_SESSION_SHARING_MATCH_IP, TS_SERVER_SESSION_SHARING_MATCH_HOST }
	Server session sharing values - match Must be identical to definition in HttpProxyAPIEnums.h. More...
enum	TSServerSessionSharingPoolType { TS_SERVER_SESSION_SHARING_POOL_GLOBAL, TS_SERVER_SESSION_SHARING_POOL_THREAD, TS_SERVER_SESSION_SHARING_POOL_GLOBAL, TS_SERVER_SESSION_SHARING_POOL_THREAD }
	Server session sharing values - pool Must be identical to definition in HttpProxyAPIEnums.h. More...
enum	TSRecordType { TS_RECORDTYPE_NULL = 0x00, TS_RECORDTYPE_CONFIG = 0x01, TS_RECORDTYPE_PROCESS = 0x02, TS_RECORDTYPE_NODE = 0x04, TS_RECORDTYPE_CLUSTER = 0x08, TS_RECORDTYPE_LOCAL = 0x10, TS_RECORDTYPE_PLUGIN = 0x20, TS_RECORDTYPE_ALL = 0x3F }
enum	TSRecordDataType { TS_RECORDDATATYPE_NULL = 0, TS_RECORDDATATYPE_INT, TS_RECORDDATATYPE_FLOAT, TS_RECORDDATATYPE_STRING, TS_RECORDDATATYPE_COUNTER, TS_RECORDDATATYPE_STAT_CONST, TS_RECORDDATATYPE_STAT_FX, TS_RECORDDATATYPE_MAX }
enum	TSRecordPersistType { TS_RECORDP_NULL, TS_RECORDP_PERSISTENT, TS_RECORDP_NON_PERSISTENT }
enum	TSRecordUpdateType { TS_RECORDUPDATE_NULL, TS_RECORDUPDATE_DYNAMIC, TS_RECORDUPDATE_RESTART_TS, TS_RECORDUPDATE_RESTART_TM, TS_RECORDUPDATE_RESTART_TC }
enum	TSRecordCheckType { TS_RECORDCHECK_NULL, TS_RECORDCHECK_STR, TS_RECORDCHECK_INT, TS_RECORDCHECK_IP }
enum	TSRecordModeType { TS_RECORDMODE_NULL, TS_RECORDMODE_CLIENT, TS_RECORDMODE_SERVER, TS_RECORDMODE_STAND_ALONE }
enum	TSRecordAccessType { TS_RECORDACCESS_NULL, TS_RECORDACCESS_NO_ACCESS, TS_RECORDACCESS_READ_ONLY }
enum	TSOverridableConfigKey { TS_CONFIG_NULL = -1, TS_CONFIG_URL_REMAP_PRISTINE_HOST_HDR, TS_CONFIG_HTTP_CHUNKING_ENABLED, TS_CONFIG_HTTP_NEGATIVE_CACHING_ENABLED, TS_CONFIG_HTTP_NEGATIVE_CACHING_LIFETIME, TS_CONFIG_HTTP_CACHE_WHEN_TO_REVALIDATE, TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_IN, TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_OUT, TS_CONFIG_HTTP_KEEP_ALIVE_POST_OUT, TS_CONFIG_HTTP_SHARE_SERVER_SESSIONS, TS_CONFIG_HTTP_SERVER_SESSION_SHARING_POOL, TS_CONFIG_HTTP_SERVER_SESSION_SHARING_MATCH, TS_CONFIG_NET_SOCK_RECV_BUFFER_SIZE_OUT, TS_CONFIG_NET_SOCK_SEND_BUFFER_SIZE_OUT, TS_CONFIG_NET_SOCK_OPTION_FLAG_OUT, TS_CONFIG_HTTP_FORWARD_PROXY_AUTH_TO_PARENT, TS_CONFIG_HTTP_ANONYMIZE_REMOVE_FROM, TS_CONFIG_HTTP_ANONYMIZE_REMOVE_REFERER, TS_CONFIG_HTTP_ANONYMIZE_REMOVE_USER_AGENT, TS_CONFIG_HTTP_ANONYMIZE_REMOVE_COOKIE, TS_CONFIG_HTTP_ANONYMIZE_REMOVE_CLIENT_IP, TS_CONFIG_HTTP_ANONYMIZE_INSERT_CLIENT_IP, TS_CONFIG_HTTP_RESPONSE_SERVER_ENABLED, TS_CONFIG_HTTP_INSERT_SQUID_X_FORWARDED_FOR, TS_CONFIG_HTTP_SERVER_TCP_INIT_CWND, TS_CONFIG_HTTP_SEND_HTTP11_REQUESTS, TS_CONFIG_HTTP_CACHE_HTTP, TS_CONFIG_HTTP_CACHE_CLUSTER_CACHE_LOCAL, TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_NO_CACHE, TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_CC_MAX_AGE, TS_CONFIG_HTTP_CACHE_IMS_ON_CLIENT_NO_CACHE, TS_CONFIG_HTTP_CACHE_IGNORE_SERVER_NO_CACHE, TS_CONFIG_HTTP_CACHE_CACHE_RESPONSES_TO_COOKIES, TS_CONFIG_HTTP_CACHE_IGNORE_AUTHENTICATION, TS_CONFIG_HTTP_CACHE_CACHE_URLS_THAT_LOOK_DYNAMIC, TS_CONFIG_HTTP_CACHE_REQUIRED_HEADERS, TS_CONFIG_HTTP_INSERT_REQUEST_VIA_STR, TS_CONFIG_HTTP_INSERT_RESPONSE_VIA_STR, TS_CONFIG_HTTP_CACHE_HEURISTIC_MIN_LIFETIME, TS_CONFIG_HTTP_CACHE_HEURISTIC_MAX_LIFETIME, TS_CONFIG_HTTP_CACHE_GUARANTEED_MIN_LIFETIME, TS_CONFIG_HTTP_CACHE_GUARANTEED_MAX_LIFETIME, TS_CONFIG_HTTP_CACHE_MAX_STALE_AGE, TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_IN, TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_OUT, TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_IN, TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_OUT, TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_OUT, TS_CONFIG_HTTP_ORIGIN_MAX_CONNECTIONS, TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES, TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES_DEAD_SERVER, TS_CONFIG_HTTP_CONNECT_ATTEMPTS_RR_RETRIES, TS_CONFIG_HTTP_CONNECT_ATTEMPTS_TIMEOUT, TS_CONFIG_HTTP_POST_CONNECT_ATTEMPTS_TIMEOUT, TS_CONFIG_HTTP_DOWN_SERVER_CACHE_TIME, TS_CONFIG_HTTP_DOWN_SERVER_ABORT_THRESHOLD, TS_CONFIG_HTTP_CACHE_FUZZ_TIME, TS_CONFIG_HTTP_CACHE_FUZZ_MIN_TIME, TS_CONFIG_HTTP_DOC_IN_CACHE_SKIP_DNS, TS_CONFIG_HTTP_BACKGROUND_FILL_ACTIVE_TIMEOUT, TS_CONFIG_HTTP_RESPONSE_SERVER_STR, TS_CONFIG_HTTP_CACHE_HEURISTIC_LM_FACTOR, TS_CONFIG_HTTP_CACHE_FUZZ_PROBABILITY, TS_CONFIG_HTTP_BACKGROUND_FILL_COMPLETED_THRESHOLD, TS_CONFIG_NET_SOCK_PACKET_MARK_OUT, TS_CONFIG_NET_SOCK_PACKET_TOS_OUT, TS_CONFIG_HTTP_INSERT_AGE_IN_RESPONSE, TS_CONFIG_HTTP_CHUNKING_SIZE, TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED, TS_CONFIG_HTTP_FLOW_CONTROL_LOW_WATER_MARK, TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER_MARK, TS_CONFIG_HTTP_CACHE_RANGE_LOOKUP, TS_CONFIG_HTTP_NORMALIZE_AE_GZIP, TS_CONFIG_HTTP_DEFAULT_BUFFER_SIZE, TS_CONFIG_HTTP_DEFAULT_BUFFER_WATER_MARK, TS_CONFIG_HTTP_REQUEST_HEADER_MAX_SIZE, TS_CONFIG_HTTP_RESPONSE_HEADER_MAX_SIZE, TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_ENABLED, TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_LIFETIME, TS_CONFIG_HTTP_ACCEPT_ENCODING_FILTER_ENABLED, TS_CONFIG_SSL_HSTS_MAX_AGE, TS_CONFIG_SSL_HSTS_INCLUDE_SUBDOMAINS, TS_CONFIG_HTTP_CACHE_OPEN_READ_RETRY_TIME, TS_CONFIG_HTTP_CACHE_MAX_OPEN_READ_RETRIES, TS_CONFIG_HTTP_CACHE_RANGE_WRITE, TS_CONFIG_HTTP_POST_CHECK_CONTENT_LENGTH_ENABLED, TS_CONFIG_HTTP_GLOBAL_USER_AGENT_HEADER, TS_CONFIG_LAST_ENTRY }
enum	TSThreadPool { TS_THREAD_POOL_DEFAULT = -1, TS_THREAD_POOL_NET, TS_THREAD_POOL_TASK, TS_THREAD_POOL_SSL, TS_THREAD_POOL_DNS, TS_THREAD_POOL_REMAP, TS_THREAD_POOL_CLUSTER, TS_THREAD_POOL_UDP }
enum	TSMilestonesType { TS_MILESTONE_NULL = -1, TS_MILESTONE_UA_BEGIN, TS_MILESTONE_UA_READ_HEADER_DONE, TS_MILESTONE_UA_BEGIN_WRITE, TS_MILESTONE_UA_CLOSE, TS_MILESTONE_SERVER_FIRST_CONNECT, TS_MILESTONE_SERVER_CONNECT, TS_MILESTONE_SERVER_CONNECT_END, TS_MILESTONE_SERVER_BEGIN_WRITE, TS_MILESTONE_SERVER_FIRST_READ, TS_MILESTONE_SERVER_READ_HEADER_DONE, TS_MILESTONE_SERVER_CLOSE, TS_MILESTONE_CACHE_OPEN_READ_BEGIN, TS_MILESTONE_CACHE_OPEN_READ_END, TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN, TS_MILESTONE_CACHE_OPEN_WRITE_END, TS_MILESTONE_DNS_LOOKUP_BEGIN, TS_MILESTONE_DNS_LOOKUP_END, TS_MILESTONE_SM_START, TS_MILESTONE_SM_FINISH, TS_MILESTONE_LAST_ENTRY }
Functions
tsapi void	TSPluginInit (int argc, const char *argv[])
	This function must be defined by all plugins.
Variables
tsapi const char *	TS_URL_SCHEME_FILE
tsapi const char *	TS_URL_SCHEME_FTP
tsapi const char *	TS_URL_SCHEME_GOPHER
tsapi const char *	TS_URL_SCHEME_HTTP
tsapi const char *	TS_URL_SCHEME_HTTPS
tsapi const char *	TS_URL_SCHEME_MAILTO
tsapi const char *	TS_URL_SCHEME_NEWS
tsapi const char *	TS_URL_SCHEME_NNTP
tsapi const char *	TS_URL_SCHEME_PROSPERO
tsapi const char *	TS_URL_SCHEME_TELNET
tsapi const char *	TS_URL_SCHEME_TUNNEL
tsapi const char *	TS_URL_SCHEME_WAIS
tsapi const char *	TS_URL_SCHEME_PNM
tsapi const char *	TS_URL_SCHEME_RTSP
tsapi const char *	TS_URL_SCHEME_RTSPU
tsapi const char *	TS_URL_SCHEME_MMS
tsapi const char *	TS_URL_SCHEME_MMSU
tsapi const char *	TS_URL_SCHEME_MMST
tsapi int	TS_URL_LEN_FILE
tsapi int	TS_URL_LEN_FTP
tsapi int	TS_URL_LEN_GOPHER
tsapi int	TS_URL_LEN_HTTP
tsapi int	TS_URL_LEN_HTTPS
tsapi int	TS_URL_LEN_MAILTO
tsapi int	TS_URL_LEN_NEWS
tsapi int	TS_URL_LEN_NNTP
tsapi int	TS_URL_LEN_PROSPERO
tsapi int	TS_URL_LEN_TELNET
tsapi int	TS_URL_LEN_WAIS
tsapi const char *	TS_MIME_FIELD_ACCEPT
tsapi const char *	TS_MIME_FIELD_ACCEPT_CHARSET
tsapi const char *	TS_MIME_FIELD_ACCEPT_ENCODING
tsapi const char *	TS_MIME_FIELD_ACCEPT_LANGUAGE
tsapi const char *	TS_MIME_FIELD_ACCEPT_RANGES
tsapi const char *	TS_MIME_FIELD_AGE
tsapi const char *	TS_MIME_FIELD_ALLOW
tsapi const char *	TS_MIME_FIELD_APPROVED
tsapi const char *	TS_MIME_FIELD_AUTHORIZATION
tsapi const char *	TS_MIME_FIELD_BYTES
tsapi const char *	TS_MIME_FIELD_CACHE_CONTROL
tsapi const char *	TS_MIME_FIELD_CLIENT_IP
tsapi const char *	TS_MIME_FIELD_CONNECTION
tsapi const char *	TS_MIME_FIELD_CONTENT_BASE
tsapi const char *	TS_MIME_FIELD_CONTENT_ENCODING
tsapi const char *	TS_MIME_FIELD_CONTENT_LANGUAGE
tsapi const char *	TS_MIME_FIELD_CONTENT_LENGTH
tsapi const char *	TS_MIME_FIELD_CONTENT_LOCATION
tsapi const char *	TS_MIME_FIELD_CONTENT_MD5
tsapi const char *	TS_MIME_FIELD_CONTENT_RANGE
tsapi const char *	TS_MIME_FIELD_CONTENT_TYPE
tsapi const char *	TS_MIME_FIELD_CONTROL
tsapi const char *	TS_MIME_FIELD_COOKIE
tsapi const char *	TS_MIME_FIELD_DATE
tsapi const char *	TS_MIME_FIELD_DISTRIBUTION
tsapi const char *	TS_MIME_FIELD_ETAG
tsapi const char *	TS_MIME_FIELD_EXPECT
tsapi const char *	TS_MIME_FIELD_EXPIRES
tsapi const char *	TS_MIME_FIELD_FOLLOWUP_TO
tsapi const char *	TS_MIME_FIELD_FROM
tsapi const char *	TS_MIME_FIELD_HOST
tsapi const char *	TS_MIME_FIELD_IF_MATCH
tsapi const char *	TS_MIME_FIELD_IF_MODIFIED_SINCE
tsapi const char *	TS_MIME_FIELD_IF_NONE_MATCH
tsapi const char *	TS_MIME_FIELD_IF_RANGE
tsapi const char *	TS_MIME_FIELD_IF_UNMODIFIED_SINCE
tsapi const char *	TS_MIME_FIELD_KEEP_ALIVE
tsapi const char *	TS_MIME_FIELD_KEYWORDS
tsapi const char *	TS_MIME_FIELD_LAST_MODIFIED
tsapi const char *	TS_MIME_FIELD_LINES
tsapi const char *	TS_MIME_FIELD_LOCATION
tsapi const char *	TS_MIME_FIELD_MAX_FORWARDS
tsapi const char *	TS_MIME_FIELD_MESSAGE_ID
tsapi const char *	TS_MIME_FIELD_NEWSGROUPS
tsapi const char *	TS_MIME_FIELD_ORGANIZATION
tsapi const char *	TS_MIME_FIELD_PATH
tsapi const char *	TS_MIME_FIELD_PRAGMA
tsapi const char *	TS_MIME_FIELD_PROXY_AUTHENTICATE
tsapi const char *	TS_MIME_FIELD_PROXY_AUTHORIZATION
tsapi const char *	TS_MIME_FIELD_PROXY_CONNECTION
tsapi const char *	TS_MIME_FIELD_PUBLIC
tsapi const char *	TS_MIME_FIELD_RANGE
tsapi const char *	TS_MIME_FIELD_REFERENCES
tsapi const char *	TS_MIME_FIELD_REFERER
tsapi const char *	TS_MIME_FIELD_REPLY_TO
tsapi const char *	TS_MIME_FIELD_RETRY_AFTER
tsapi const char *	TS_MIME_FIELD_SENDER
tsapi const char *	TS_MIME_FIELD_SERVER
tsapi const char *	TS_MIME_FIELD_SET_COOKIE
tsapi const char *	TS_MIME_FIELD_STRICT_TRANSPORT_SECURITY
tsapi const char *	TS_MIME_FIELD_SUBJECT
tsapi const char *	TS_MIME_FIELD_SUMMARY
tsapi const char *	TS_MIME_FIELD_TE
tsapi const char *	TS_MIME_FIELD_TRANSFER_ENCODING
tsapi const char *	TS_MIME_FIELD_UPGRADE
tsapi const char *	TS_MIME_FIELD_USER_AGENT
tsapi const char *	TS_MIME_FIELD_VARY
tsapi const char *	TS_MIME_FIELD_VIA
tsapi const char *	TS_MIME_FIELD_WARNING
tsapi const char *	TS_MIME_FIELD_WWW_AUTHENTICATE
tsapi const char *	TS_MIME_FIELD_XREF
tsapi const char *	TS_MIME_FIELD_X_FORWARDED_FOR
tsapi int	TS_MIME_LEN_ACCEPT
tsapi int	TS_MIME_LEN_ACCEPT_CHARSET
tsapi int	TS_MIME_LEN_ACCEPT_ENCODING
tsapi int	TS_MIME_LEN_ACCEPT_LANGUAGE
tsapi int	TS_MIME_LEN_ACCEPT_RANGES
tsapi int	TS_MIME_LEN_AGE
tsapi int	TS_MIME_LEN_ALLOW
tsapi int	TS_MIME_LEN_APPROVED
tsapi int	TS_MIME_LEN_AUTHORIZATION
tsapi int	TS_MIME_LEN_BYTES
tsapi int	TS_MIME_LEN_CACHE_CONTROL
tsapi int	TS_MIME_LEN_CLIENT_IP
tsapi int	TS_MIME_LEN_CONNECTION
tsapi int	TS_MIME_LEN_CONTENT_BASE
tsapi int	TS_MIME_LEN_CONTENT_ENCODING
tsapi int	TS_MIME_LEN_CONTENT_LANGUAGE
tsapi int	TS_MIME_LEN_CONTENT_LENGTH
tsapi int	TS_MIME_LEN_CONTENT_LOCATION
tsapi int	TS_MIME_LEN_CONTENT_MD5
tsapi int	TS_MIME_LEN_CONTENT_RANGE
tsapi int	TS_MIME_LEN_CONTENT_TYPE
tsapi int	TS_MIME_LEN_CONTROL
tsapi int	TS_MIME_LEN_COOKIE
tsapi int	TS_MIME_LEN_DATE
tsapi int	TS_MIME_LEN_DISTRIBUTION
tsapi int	TS_MIME_LEN_ETAG
tsapi int	TS_MIME_LEN_EXPECT
tsapi int	TS_MIME_LEN_EXPIRES
tsapi int	TS_MIME_LEN_FOLLOWUP_TO
tsapi int	TS_MIME_LEN_FROM
tsapi int	TS_MIME_LEN_HOST
tsapi int	TS_MIME_LEN_IF_MATCH
tsapi int	TS_MIME_LEN_IF_MODIFIED_SINCE
tsapi int	TS_MIME_LEN_IF_NONE_MATCH
tsapi int	TS_MIME_LEN_IF_RANGE
tsapi int	TS_MIME_LEN_IF_UNMODIFIED_SINCE
tsapi int	TS_MIME_LEN_KEEP_ALIVE
tsapi int	TS_MIME_LEN_KEYWORDS
tsapi int	TS_MIME_LEN_LAST_MODIFIED
tsapi int	TS_MIME_LEN_LINES
tsapi int	TS_MIME_LEN_LOCATION
tsapi int	TS_MIME_LEN_MAX_FORWARDS
tsapi int	TS_MIME_LEN_MESSAGE_ID
tsapi int	TS_MIME_LEN_NEWSGROUPS
tsapi int	TS_MIME_LEN_ORGANIZATION
tsapi int	TS_MIME_LEN_PATH
tsapi int	TS_MIME_LEN_PRAGMA
tsapi int	TS_MIME_LEN_PROXY_AUTHENTICATE
tsapi int	TS_MIME_LEN_PROXY_AUTHORIZATION
tsapi int	TS_MIME_LEN_PROXY_CONNECTION
tsapi int	TS_MIME_LEN_PUBLIC
tsapi int	TS_MIME_LEN_RANGE
tsapi int	TS_MIME_LEN_REFERENCES
tsapi int	TS_MIME_LEN_REFERER
tsapi int	TS_MIME_LEN_REPLY_TO
tsapi int	TS_MIME_LEN_RETRY_AFTER
tsapi int	TS_MIME_LEN_SENDER
tsapi int	TS_MIME_LEN_SERVER
tsapi int	TS_MIME_LEN_SET_COOKIE
tsapi int	TS_MIME_LEN_STRICT_TRANSPORT_SECURITY
tsapi int	TS_MIME_LEN_SUBJECT
tsapi int	TS_MIME_LEN_SUMMARY
tsapi int	TS_MIME_LEN_TE
tsapi int	TS_MIME_LEN_TRANSFER_ENCODING
tsapi int	TS_MIME_LEN_UPGRADE
tsapi int	TS_MIME_LEN_USER_AGENT
tsapi int	TS_MIME_LEN_VARY
tsapi int	TS_MIME_LEN_VIA
tsapi int	TS_MIME_LEN_WARNING
tsapi int	TS_MIME_LEN_WWW_AUTHENTICATE
tsapi int	TS_MIME_LEN_XREF
tsapi int	TS_MIME_LEN_X_FORWARDED_FOR
tsapi const char *	TS_HTTP_VALUE_BYTES
tsapi const char *	TS_HTTP_VALUE_CHUNKED
tsapi const char *	TS_HTTP_VALUE_CLOSE
tsapi const char *	TS_HTTP_VALUE_COMPRESS
tsapi const char *	TS_HTTP_VALUE_DEFLATE
tsapi const char *	TS_HTTP_VALUE_GZIP
tsapi const char *	TS_HTTP_VALUE_IDENTITY
tsapi const char *	TS_HTTP_VALUE_KEEP_ALIVE
tsapi const char *	TS_HTTP_VALUE_MAX_AGE
tsapi const char *	TS_HTTP_VALUE_MAX_STALE
tsapi const char *	TS_HTTP_VALUE_MIN_FRESH
tsapi const char *	TS_HTTP_VALUE_MUST_REVALIDATE
tsapi const char *	TS_HTTP_VALUE_NONE
tsapi const char *	TS_HTTP_VALUE_NO_CACHE
tsapi const char *	TS_HTTP_VALUE_NO_STORE
tsapi const char *	TS_HTTP_VALUE_NO_TRANSFORM
tsapi const char *	TS_HTTP_VALUE_ONLY_IF_CACHED
tsapi const char *	TS_HTTP_VALUE_PRIVATE
tsapi const char *	TS_HTTP_VALUE_PROXY_REVALIDATE
tsapi const char *	TS_HTTP_VALUE_PUBLIC
tsapi int	TS_HTTP_LEN_BYTES
tsapi int	TS_HTTP_LEN_CHUNKED
tsapi int	TS_HTTP_LEN_CLOSE
tsapi int	TS_HTTP_LEN_COMPRESS
tsapi int	TS_HTTP_LEN_DEFLATE
tsapi int	TS_HTTP_LEN_GZIP
tsapi int	TS_HTTP_LEN_IDENTITY
tsapi int	TS_HTTP_LEN_KEEP_ALIVE
tsapi int	TS_HTTP_LEN_MAX_AGE
tsapi int	TS_HTTP_LEN_MAX_STALE
tsapi int	TS_HTTP_LEN_MIN_FRESH
tsapi int	TS_HTTP_LEN_MUST_REVALIDATE
tsapi int	TS_HTTP_LEN_NONE
tsapi int	TS_HTTP_LEN_NO_CACHE
tsapi int	TS_HTTP_LEN_NO_STORE
tsapi int	TS_HTTP_LEN_NO_TRANSFORM
tsapi int	TS_HTTP_LEN_ONLY_IF_CACHED
tsapi int	TS_HTTP_LEN_PRIVATE
tsapi int	TS_HTTP_LEN_PROXY_REVALIDATE
tsapi int	TS_HTTP_LEN_PUBLIC
tsapi const char *	TS_HTTP_METHOD_CONNECT
tsapi const char *	TS_HTTP_METHOD_DELETE
tsapi const char *	TS_HTTP_METHOD_GET
tsapi const char *	TS_HTTP_METHOD_HEAD
tsapi const char *	TS_HTTP_METHOD_ICP_QUERY
tsapi const char *	TS_HTTP_METHOD_OPTIONS
tsapi const char *	TS_HTTP_METHOD_POST
tsapi const char *	TS_HTTP_METHOD_PURGE
tsapi const char *	TS_HTTP_METHOD_PUT
tsapi const char *	TS_HTTP_METHOD_TRACE
tsapi const char *	TS_HTTP_METHOD_PUSH
tsapi int	TS_HTTP_LEN_CONNECT
tsapi int	TS_HTTP_LEN_DELETE
tsapi int	TS_HTTP_LEN_GET
tsapi int	TS_HTTP_LEN_HEAD
tsapi int	TS_HTTP_LEN_ICP_QUERY
tsapi int	TS_HTTP_LEN_OPTIONS
tsapi int	TS_HTTP_LEN_POST
tsapi int	TS_HTTP_LEN_PURGE
tsapi int	TS_HTTP_LEN_PUT
tsapi int	TS_HTTP_LEN_TRACE
tsapi int	TS_HTTP_LEN_PUSH
tsapi const char *const	TS_NPN_PROTOCOL_HTTP_0_9
tsapi const char *const	TS_NPN_PROTOCOL_HTTP_1_0
tsapi const char *const	TS_NPN_PROTOCOL_HTTP_1_1
tsapi const char *const	TS_NPN_PROTOCOL_HTTP_2_0
tsapi const char *const	TS_NPN_PROTOCOL_SPDY_1
tsapi const char *const	TS_NPN_PROTOCOL_SPDY_2
tsapi const char *const	TS_NPN_PROTOCOL_SPDY_3
tsapi const char *const	TS_NPN_PROTOCOL_SPDY_3_1
tsapi int	TS_NPN_PROTOCOL_INDEX_HTTP_0_9
tsapi int	TS_NPN_PROTOCOL_INDEX_HTTP_1_0
tsapi int	TS_NPN_PROTOCOL_INDEX_HTTP_1_1
tsapi int	TS_NPN_PROTOCOL_INDEX_SPDY_1
tsapi int	TS_NPN_PROTOCOL_INDEX_SPDY_2
tsapi int	TS_NPN_PROTOCOL_INDEX_SPDY_3
tsapi int	TS_NPN_PROTOCOL_INDEX_SPDY_3_1
tsapi int	TS_NPN_PROTOCOL_INDEX_HTTP_2_0
tsapi const char *const	TS_NPN_PROTOCOL_GROUP_HTTP
tsapi const char *const	TS_NPN_PROTOCOL_GROUP_HTTP2
tsapi const char *const	TS_NPN_PROTOCOL_GROUP_SPDY
tsapi const TSMLoc	TS_NULL_MLOC
	Use TS_NULL_MLOC as the parent in calls that require a parent when an TSMLoc does not have a parent TSMLoc.

Detailed Description

This header file defines common types that can be shared between internal code and TS APIs.

License

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Developers

Developers, when adding a new element to an enum, append it. DO NOT insert it. Otherwise, binary compatibility of plugins will be broken!

Definition in file apidefs.h.

Define Documentation

#define __TS_RES_PATH ( x ) #x

Definition at line 86 of file apidefs.h.

#define _HTTP_PROXY_API_ENUMS_H_

Definition at line 548 of file apidefs.h.

#define _TS_RES_PATH ( x ) __TS_RES_PATH (x)

Definition at line 87 of file apidefs.h.

#define TS_DEPRECATED __attribute__ ((deprecated))

Definition at line 93 of file apidefs.h.

#define TS_EVENT_HTTP_READ_REQUEST_PRE_REMAP TS_EVENT_HTTP_PRE_REMAP

Definition at line 447 of file apidefs.h.

#define TS_HTTP_MAJOR ( v ) (((v) >> 16) & 0xFFFF)

Definition at line 85 of file apidefs.h.

Referenced by SDK_API_TSHttpHdr(), and SpdyNV::SpdyNV().

#define TS_HTTP_MINOR ( v ) ((v) & 0xFFFF)

Definition at line 84 of file apidefs.h.

Referenced by SDK_API_TSHttpHdr(), and SpdyNV::SpdyNV().

#define TS_HTTP_READ_REQUEST_PRE_REMAP_HOOK TS_HTTP_PRE_REMAP_HOOK

Definition at line 283 of file apidefs.h.

#define TS_HTTP_VERSION	(	a,
		b
	)		((((a) & 0xFFFF) << 16) \| ((b) & 0xFFFF))

Definition at line 83 of file apidefs.h.

Referenced by SDK_API_TSHttpHdr().

#define TS_MAX_USER_NAME_LEN 256

Definition at line 90 of file apidefs.h.

void void void void void void void TS_NORETURN

Definition at line 66 of file apidefs.h.

#define TS_PRINTFLIKE	(	fmt,
		arg
	)

Definition at line 58 of file apidefs.h.

#define TS_RES_MEM_PATH TS_RES_PATH ("memory/")

Definition at line 89 of file apidefs.h.

#define TS_RES_PATH ( x ) x __FILE__ ":" _TS_RES_PATH (__LINE__)

Definition at line 88 of file apidefs.h.

#define TS_VERSION_MAJOR 5

Definition at line 79 of file apidefs.h.

#define TS_VERSION_MICRO 0

Definition at line 81 of file apidefs.h.

#define TS_VERSION_MINOR 2

Definition at line 80 of file apidefs.h.

#define TS_VERSION_NUMBER 5002000

Definition at line 78 of file apidefs.h.

#define TS_VERSION_STRING "5.2.0"

Definition at line 77 of file apidefs.h.

#define tsapi

Definition at line 51 of file apidefs.h.

Typedef Documentation

typedef struct tsapi_action* TSAction

Definition at line 813 of file apidefs.h.

typedef struct tsapi_aiocallback* TSAIOCallback

Definition at line 819 of file apidefs.h.

typedef struct tsapi_cachehttpinfo* TSCacheHttpInfo

Definition at line 803 of file apidefs.h.

typedef struct tsapi_cachekey* TSCacheKey

Definition at line 802 of file apidefs.h.

typedef struct tsapi_cachetxn* TSCacheTxn

Definition at line 804 of file apidefs.h.

typedef struct tsapi_config* TSConfig

Definition at line 810 of file apidefs.h.

typedef void(* TSConfigDestroyFunc)(void *data)

Definition at line 823 of file apidefs.h.

typedef struct tsapi_cont* TSCont

Definition at line 811 of file apidefs.h.

typedef int(* TSEventFunc)(TSCont contp, TSEvent event, void *edata)

Definition at line 822 of file apidefs.h.

typedef struct TSFetchUrlParams TSFetchUrlParams_t

typedef struct tsapi_file* TSFile

Definition at line 793 of file apidefs.h.

typedef struct tsapi_hostlookupresult* TSHostLookupResult

Definition at line 818 of file apidefs.h.

typedef int64_t TSHRTime

Definition at line 755 of file apidefs.h.

typedef struct tsapi_httpaltinfo* TSHttpAltInfo

Definition at line 799 of file apidefs.h.

typedef struct tsapi_httpparser* TSHttpParser

Definition at line 801 of file apidefs.h.

typedef struct tsapi_httpssn* TSHttpSsn

Definition at line 797 of file apidefs.h.

typedef struct tsapi_httptxn* TSHttpTxn

Definition at line 798 of file apidefs.h.

typedef struct tsapi_iobuffer* TSIOBuffer

Definition at line 814 of file apidefs.h.

typedef struct tsapi_bufferblock* TSIOBufferBlock

Definition at line 816 of file apidefs.h.

typedef struct tsapi_iobufferdata* TSIOBufferData

Definition at line 815 of file apidefs.h.

typedef struct tsapi_bufferreader* TSIOBufferReader

Definition at line 817 of file apidefs.h.

typedef struct tsapi_mbuffer* TSMBuffer

Definition at line 796 of file apidefs.h.

typedef int64_t TSMgmtCounter

Definition at line 789 of file apidefs.h.

typedef float TSMgmtFloat

Definition at line 790 of file apidefs.h.

typedef int64_t TSMgmtInt

Definition at line 788 of file apidefs.h.

typedef char* TSMgmtString

Definition at line 791 of file apidefs.h.

typedef struct tsapi_mimeparser* TSMimeParser

Definition at line 800 of file apidefs.h.

typedef struct tsapi_mloc* TSMLoc

Definition at line 795 of file apidefs.h.

typedef struct tsapi_mutex* TSMutex

Definition at line 809 of file apidefs.h.

typedef struct tsapi_port* TSPortDescriptor

Definition at line 806 of file apidefs.h.

typedef struct tsapi_thread* TSThread

Definition at line 808 of file apidefs.h.

typedef void*(* TSThreadFunc)(void *data)

Definition at line 821 of file apidefs.h.

typedef struct tsapi_cont* TSVConn

Definition at line 812 of file apidefs.h.

typedef struct tsapi_vio* TSVIO

Definition at line 807 of file apidefs.h.

Enumeration Type Documentation

enum TSCacheDataType

Enumerator:

TS_CACHE_DATA_TYPE_NONE
TS_CACHE_DATA_TYPE_HTTP
TS_CACHE_DATA_TYPE_OTHER

Definition at line 482 of file apidefs.h.

enum TSCacheError

Enumerator:

TS_CACHE_ERROR_NO_DOC
TS_CACHE_ERROR_DOC_BUSY
TS_CACHE_ERROR_NOT_READY

Definition at line 489 of file apidefs.h.

enum TSCacheLookupResult

Enumerator:

TS_CACHE_LOOKUP_MISS
TS_CACHE_LOOKUP_HIT_STALE
TS_CACHE_LOOKUP_HIT_FRESH
TS_CACHE_LOOKUP_SKIPPED

Definition at line 474 of file apidefs.h.

enum TSCacheScanResult

Enumerator:

TS_CACHE_SCAN_RESULT_DONE
TS_CACHE_SCAN_RESULT_CONTINUE
TS_CACHE_SCAN_RESULT_DELETE
TS_CACHE_SCAN_RESULT_DELETE_ALL_ALTERNATES
TS_CACHE_SCAN_RESULT_UPDATE
TS_CACHE_SCAN_RESULT_RETRY

Definition at line 496 of file apidefs.h.

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

Enumerator:

TS_EVENT_NONE
TS_EVENT_IMMEDIATE
TS_EVENT_TIMEOUT
TS_EVENT_ERROR
TS_EVENT_CONTINUE
TS_EVENT_VCONN_READ_READY
TS_EVENT_VCONN_WRITE_READY
TS_EVENT_VCONN_READ_COMPLETE
TS_EVENT_VCONN_WRITE_COMPLETE
TS_EVENT_VCONN_EOS
TS_EVENT_VCONN_INACTIVITY_TIMEOUT
TS_EVENT_NET_CONNECT
TS_EVENT_NET_CONNECT_FAILED
TS_EVENT_NET_ACCEPT
TS_EVENT_NET_ACCEPT_FAILED
TS_EVENT_INTERNAL_206
TS_EVENT_INTERNAL_207
TS_EVENT_INTERNAL_208
TS_EVENT_INTERNAL_209
TS_EVENT_INTERNAL_210
TS_EVENT_INTERNAL_211
TS_EVENT_INTERNAL_212
TS_EVENT_HOST_LOOKUP
TS_EVENT_CACHE_OPEN_READ
TS_EVENT_CACHE_OPEN_READ_FAILED
TS_EVENT_CACHE_OPEN_WRITE
TS_EVENT_CACHE_OPEN_WRITE_FAILED
TS_EVENT_CACHE_REMOVE
TS_EVENT_CACHE_REMOVE_FAILED
TS_EVENT_CACHE_SCAN
TS_EVENT_CACHE_SCAN_FAILED
TS_EVENT_CACHE_SCAN_OBJECT
TS_EVENT_CACHE_SCAN_OPERATION_BLOCKED
TS_EVENT_CACHE_SCAN_OPERATION_FAILED
TS_EVENT_CACHE_SCAN_DONE
TS_EVENT_CACHE_LOOKUP
TS_EVENT_CACHE_READ
TS_EVENT_CACHE_DELETE
TS_EVENT_CACHE_WRITE
TS_EVENT_CACHE_WRITE_HEADER
TS_EVENT_CACHE_CLOSE
TS_EVENT_CACHE_LOOKUP_READY
TS_EVENT_CACHE_LOOKUP_COMPLETE
TS_EVENT_CACHE_READ_READY
TS_EVENT_CACHE_READ_COMPLETE
TS_EVENT_INTERNAL_1200
TS_AIO_EVENT_DONE
TS_EVENT_HTTP_CONTINUE
TS_EVENT_HTTP_ERROR
TS_EVENT_HTTP_READ_REQUEST_HDR
TS_EVENT_HTTP_OS_DNS
TS_EVENT_HTTP_SEND_REQUEST_HDR
TS_EVENT_HTTP_READ_CACHE_HDR
TS_EVENT_HTTP_READ_RESPONSE_HDR
TS_EVENT_HTTP_SEND_RESPONSE_HDR
TS_EVENT_HTTP_REQUEST_TRANSFORM
TS_EVENT_HTTP_RESPONSE_TRANSFORM
TS_EVENT_HTTP_SELECT_ALT
TS_EVENT_HTTP_TXN_START
TS_EVENT_HTTP_TXN_CLOSE
TS_EVENT_HTTP_SSN_START
TS_EVENT_HTTP_SSN_CLOSE
TS_EVENT_HTTP_CACHE_LOOKUP_COMPLETE
TS_EVENT_HTTP_PRE_REMAP
TS_EVENT_HTTP_POST_REMAP
TS_EVENT_LIFECYCLE_PORTS_INITIALIZED
TS_EVENT_LIFECYCLE_PORTS_READY
TS_EVENT_LIFECYCLE_CACHE_READY
TS_EVENT_LIFECYCLE_SERVER_SSL_CTX_INITIALIZED
TS_EVENT_LIFECYCLE_CLIENT_SSL_CTX_INITIALIZED
TS_EVENT_MGMT_UPDATE
TS_EVENT_INTERNAL_60200
TS_EVENT_INTERNAL_60201
TS_EVENT_INTERNAL_60202

Definition at line 357 of file apidefs.h.

enum TSFetchWakeUpOptions

Enumerator:

NO_CALLBACK
AFTER_HEADER
AFTER_BODY

Definition at line 540 of file apidefs.h.

enum TSHttpHookID

This set of enums represents the possible hooks where you can set up continuation callbacks.

The functions used to register a continuation for a particular hook are:

TSHttpHookAdd: adds a global hook. You can globally add any hook except for

TS_HTTP_REQUEST_TRANSFORM_HOOK
TS_HTTP_RESPONSE_TRANSFORM_HOOK
TS_HTTP_RESPONSE_CLIENT_HOOK

The following hooks can ONLY be added globally:

TS_HTTP_SELECT_ALT_HOOK
TS_HTTP_SSN_START_HOOK
TS_HTTP_SSN_CLOSE_HOOK

TSHttpSsnHookAdd: adds a transaction hook to each transaction within a session. You can only use transaction hooks with this call:

TS_HTTP_READ_REQUEST_HDR_HOOK
TS_HTTP_OS_DNS_HOOK
TS_HTTP_SEND_REQUEST_HDR_HOOK
TS_HTTP_READ_CACHE_HDR_HOOK
TS_HTTP_READ_RESPONSE_HDR_HOOK
TS_HTTP_SEND_RESPONSE_HDR_HOOK
TS_HTTP_REQUEST_TRANSFORM_HOOK
TS_HTTP_RESPONSE_TRANSFORM_HOOK
TS_HTTP_RESPONSE_CLIENT_HOOK
TS_HTTP_TXN_START_HOOK
TS_HTTP_TXN_CLOSE_HOOK

TSHttpTxnHookAdd: adds a callback at a specific point within an HTTP transaction. The following hooks can be used with this function:

TS_HTTP_READ_REQUEST_HDR_HOOK
TS_HTTP_OS_DNS_HOOK
TS_HTTP_SEND_REQUEST_HDR_HOOK
TS_HTTP_READ_CACHE_HDR_HOOK
TS_HTTP_READ_RESPONSE_HDR_HOOK
TS_HTTP_SEND_RESPONSE_HDR_HOOK
TS_HTTP_REQUEST_TRANSFORM_HOOK
TS_HTTP_RESPONSE_TRANSFORM_HOOK
TS_HTTP_TXN_CLOSE_HOOK

The two transform hooks can ONLY be added as transaction hooks.

TS_HTTP_LAST_HOOK _must_ be the last element. Only right place to insert a new element is just before TS_HTTP_LAST_HOOK.

Enumerator:

TS_HTTP_READ_REQUEST_HDR_HOOK
TS_HTTP_OS_DNS_HOOK
TS_HTTP_SEND_REQUEST_HDR_HOOK
TS_HTTP_READ_CACHE_HDR_HOOK
TS_HTTP_READ_RESPONSE_HDR_HOOK
TS_HTTP_SEND_RESPONSE_HDR_HOOK
TS_HTTP_REQUEST_TRANSFORM_HOOK
TS_HTTP_RESPONSE_TRANSFORM_HOOK
TS_HTTP_SELECT_ALT_HOOK
TS_HTTP_TXN_START_HOOK
TS_HTTP_TXN_CLOSE_HOOK
TS_HTTP_SSN_START_HOOK
TS_HTTP_SSN_CLOSE_HOOK
TS_HTTP_CACHE_LOOKUP_COMPLETE_HOOK
TS_HTTP_PRE_REMAP_HOOK
TS_HTTP_POST_REMAP_HOOK
TS_HTTP_RESPONSE_CLIENT_HOOK
TS_HTTP_LAST_HOOK

Definition at line 262 of file apidefs.h.

enum 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().

Enumerator:

TS_HTTP_STATUS_NONE
TS_HTTP_STATUS_CONTINUE
TS_HTTP_STATUS_SWITCHING_PROTOCOL
TS_HTTP_STATUS_OK
TS_HTTP_STATUS_CREATED
TS_HTTP_STATUS_ACCEPTED
TS_HTTP_STATUS_NON_AUTHORITATIVE_INFORMATION
TS_HTTP_STATUS_NO_CONTENT
TS_HTTP_STATUS_RESET_CONTENT
TS_HTTP_STATUS_PARTIAL_CONTENT
TS_HTTP_STATUS_MULTI_STATUS
TS_HTTP_STATUS_ALREADY_REPORTED
TS_HTTP_STATUS_IM_USED
TS_HTTP_STATUS_MULTIPLE_CHOICES
TS_HTTP_STATUS_MOVED_PERMANENTLY
TS_HTTP_STATUS_MOVED_TEMPORARILY
TS_HTTP_STATUS_SEE_OTHER
TS_HTTP_STATUS_NOT_MODIFIED
TS_HTTP_STATUS_USE_PROXY
TS_HTTP_STATUS_TEMPORARY_REDIRECT
TS_HTTP_STATUS_PERMANENT_REDIRECT
TS_HTTP_STATUS_BAD_REQUEST
TS_HTTP_STATUS_UNAUTHORIZED
TS_HTTP_STATUS_PAYMENT_REQUIRED
TS_HTTP_STATUS_FORBIDDEN
TS_HTTP_STATUS_NOT_FOUND
TS_HTTP_STATUS_METHOD_NOT_ALLOWED
TS_HTTP_STATUS_NOT_ACCEPTABLE
TS_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED
TS_HTTP_STATUS_REQUEST_TIMEOUT
TS_HTTP_STATUS_CONFLICT
TS_HTTP_STATUS_GONE
TS_HTTP_STATUS_LENGTH_REQUIRED
TS_HTTP_STATUS_PRECONDITION_FAILED
TS_HTTP_STATUS_REQUEST_ENTITY_TOO_LARGE
TS_HTTP_STATUS_REQUEST_URI_TOO_LONG
TS_HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE
TS_HTTP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE
TS_HTTP_STATUS_EXPECTATION_FAILED
TS_HTTP_STATUS_UNPROCESSABLE_ENTITY
TS_HTTP_STATUS_LOCKED
TS_HTTP_STATUS_FAILED_DEPENDENCY
TS_HTTP_STATUS_UPGRADE_REQUIRED
TS_HTTP_STATUS_PRECONDITION_REQUIRED
TS_HTTP_STATUS_TOO_MANY_REQUESTS
TS_HTTP_STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE
TS_HTTP_STATUS_INTERNAL_SERVER_ERROR
TS_HTTP_STATUS_NOT_IMPLEMENTED
TS_HTTP_STATUS_BAD_GATEWAY
TS_HTTP_STATUS_SERVICE_UNAVAILABLE
TS_HTTP_STATUS_GATEWAY_TIMEOUT
TS_HTTP_STATUS_HTTPVER_NOT_SUPPORTED
TS_HTTP_STATUS_VARIANT_ALSO_NEGOTIATES
TS_HTTP_STATUS_INSUFFICIENT_STORAGE
TS_HTTP_STATUS_LOOP_DETECTED
TS_HTTP_STATUS_NOT_EXTENDED
TS_HTTP_STATUS_NETWORK_AUTHENTICATION_REQUIRED

Definition at line 146 of file apidefs.h.

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

Enumerator:

TS_HTTP_TYPE_UNKNOWN
TS_HTTP_TYPE_REQUEST
TS_HTTP_TYPE_RESPONSE

Definition at line 131 of file apidefs.h.

enum TSIOBufferSizeIndex

Enumerator:

TS_IOBUFFER_SIZE_INDEX_128
TS_IOBUFFER_SIZE_INDEX_256
TS_IOBUFFER_SIZE_INDEX_512
TS_IOBUFFER_SIZE_INDEX_1K
TS_IOBUFFER_SIZE_INDEX_2K
TS_IOBUFFER_SIZE_INDEX_4K
TS_IOBUFFER_SIZE_INDEX_8K
TS_IOBUFFER_SIZE_INDEX_16K
TS_IOBUFFER_SIZE_INDEX_32K

Definition at line 512 of file apidefs.h.

enum TSLifecycleHookID

Plugin lifecycle hooks.

These are called during lifecycle events of a plugin. They should be set in the plugin initialization function. The continuation is invoked with an event ID specified for each hook and NULL for the event data.

TS_LIFECYCLE_PORTS_INITIALIZED_HOOK

called once, after the HTTP proxy port data structures have been initialized. In particular, SSL related calls that depend on accept endpoints may be invoked. After this hook is finished, the proxy port sockets are opened and connections are accepted.

Event: TS_EVENT_LIFECYCLE_PORTS_INITIALIZED

TS_LIFECYCLE_PORTS_READY_HOOK

called once, after the sockets have been opened and the accept threads have been started. That is, the ports are ready to accept connections. This is *not* guaranteed to be called before the first connection is accepted.

Event: TS_EVENT_LIFECYCLE_PORTS_READY_HOOK

TS_LIFECYCLE_CACHE_READY_HOOK

called once, after the cache has finished its initialization. It is either online or has failed when this hook is called.

Event: TS_EVENT_LIFECYCLE_CACHE_READY

TS_LIFECYCLE_SERVER_SSL_CTX_INITIALIZED_HOOK

called every time after a server SSL_CTX has finished the initialization. It exposes the initialized SSL_CTX pointer.

Event: TS_EVENT_LIFECYCLE_SERVER_SSL_CTX_INITIALIZED

TS_LIFECYCLE_CLIENT_SSL_CTX_INITIALIZED_HOOK

called once, after the client SSL_CTX has finished the initialization. It exposes the initialized SSL_CTX pointer.

Event: TS_EVENT_LIFECYCLE_CLIENT_SSL_CTX_INITIALIZED

Ordering guarantees:

TS_LIFECYCLE_PORTS_INITIALIZED_HOOK before TS_LIFECYCLE_PORTS_READY_HOOK.

NOTE! ONLY the orderings EXPLICITLY mentioned above are guaranteed.

Enumerator:

TS_LIFECYCLE_PORTS_INITIALIZED_HOOK
TS_LIFECYCLE_PORTS_READY_HOOK
TS_LIFECYCLE_CACHE_READY_HOOK
TS_LIFECYCLE_SERVER_SSL_CTX_INITIALIZED_HOOK
TS_LIFECYCLE_CLIENT_SSL_CTX_INITIALIZED_HOOK
TS_LIFECYCLE_LAST_HOOK

Definition at line 340 of file apidefs.h.

enum TSLookingUpType

Enumerator:

TS_LOOKUP_UNDEFINED_LOOKUP
TS_LOOKUP_ICP_SUGGESTED_HOST
TS_LOOKUP_PARENT_PROXY
TS_LOOKUP_ORIGIN_SERVER
TS_LOOKUP_INCOMING_ROUTER
TS_LOOKUP_HOST_NONE

Definition at line 464 of file apidefs.h.

enum TSMilestonesType

Enumerator:

TS_MILESTONE_NULL
TS_MILESTONE_UA_BEGIN
TS_MILESTONE_UA_READ_HEADER_DONE
TS_MILESTONE_UA_BEGIN_WRITE
TS_MILESTONE_UA_CLOSE
TS_MILESTONE_SERVER_FIRST_CONNECT
TS_MILESTONE_SERVER_CONNECT
TS_MILESTONE_SERVER_CONNECT_END
TS_MILESTONE_SERVER_BEGIN_WRITE
TS_MILESTONE_SERVER_FIRST_READ
TS_MILESTONE_SERVER_READ_HEADER_DONE
TS_MILESTONE_SERVER_CLOSE
TS_MILESTONE_CACHE_OPEN_READ_BEGIN
TS_MILESTONE_CACHE_OPEN_READ_END
TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN
TS_MILESTONE_CACHE_OPEN_WRITE_END
TS_MILESTONE_DNS_LOOKUP_BEGIN
TS_MILESTONE_DNS_LOOKUP_END
TS_MILESTONE_SM_START
TS_MILESTONE_SM_FINISH
TS_MILESTONE_LAST_ENTRY

Definition at line 759 of file apidefs.h.

enum TSOverridableConfigKey

Enumerator:

TS_CONFIG_NULL
TS_CONFIG_URL_REMAP_PRISTINE_HOST_HDR
TS_CONFIG_HTTP_CHUNKING_ENABLED
TS_CONFIG_HTTP_NEGATIVE_CACHING_ENABLED
TS_CONFIG_HTTP_NEGATIVE_CACHING_LIFETIME
TS_CONFIG_HTTP_CACHE_WHEN_TO_REVALIDATE
TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_IN
TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_OUT
TS_CONFIG_HTTP_KEEP_ALIVE_POST_OUT
TS_CONFIG_HTTP_SHARE_SERVER_SESSIONS
TS_CONFIG_HTTP_SERVER_SESSION_SHARING_POOL
TS_CONFIG_HTTP_SERVER_SESSION_SHARING_MATCH
TS_CONFIG_NET_SOCK_RECV_BUFFER_SIZE_OUT
TS_CONFIG_NET_SOCK_SEND_BUFFER_SIZE_OUT
TS_CONFIG_NET_SOCK_OPTION_FLAG_OUT
TS_CONFIG_HTTP_FORWARD_PROXY_AUTH_TO_PARENT
TS_CONFIG_HTTP_ANONYMIZE_REMOVE_FROM
TS_CONFIG_HTTP_ANONYMIZE_REMOVE_REFERER
TS_CONFIG_HTTP_ANONYMIZE_REMOVE_USER_AGENT
TS_CONFIG_HTTP_ANONYMIZE_REMOVE_COOKIE
TS_CONFIG_HTTP_ANONYMIZE_REMOVE_CLIENT_IP
TS_CONFIG_HTTP_ANONYMIZE_INSERT_CLIENT_IP
TS_CONFIG_HTTP_RESPONSE_SERVER_ENABLED
TS_CONFIG_HTTP_INSERT_SQUID_X_FORWARDED_FOR
TS_CONFIG_HTTP_SERVER_TCP_INIT_CWND
TS_CONFIG_HTTP_SEND_HTTP11_REQUESTS
TS_CONFIG_HTTP_CACHE_HTTP
TS_CONFIG_HTTP_CACHE_CLUSTER_CACHE_LOCAL
TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_NO_CACHE
TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_CC_MAX_AGE
TS_CONFIG_HTTP_CACHE_IMS_ON_CLIENT_NO_CACHE
TS_CONFIG_HTTP_CACHE_IGNORE_SERVER_NO_CACHE
TS_CONFIG_HTTP_CACHE_CACHE_RESPONSES_TO_COOKIES
TS_CONFIG_HTTP_CACHE_IGNORE_AUTHENTICATION
TS_CONFIG_HTTP_CACHE_CACHE_URLS_THAT_LOOK_DYNAMIC
TS_CONFIG_HTTP_CACHE_REQUIRED_HEADERS
TS_CONFIG_HTTP_INSERT_REQUEST_VIA_STR
TS_CONFIG_HTTP_INSERT_RESPONSE_VIA_STR
TS_CONFIG_HTTP_CACHE_HEURISTIC_MIN_LIFETIME
TS_CONFIG_HTTP_CACHE_HEURISTIC_MAX_LIFETIME
TS_CONFIG_HTTP_CACHE_GUARANTEED_MIN_LIFETIME
TS_CONFIG_HTTP_CACHE_GUARANTEED_MAX_LIFETIME
TS_CONFIG_HTTP_CACHE_MAX_STALE_AGE
TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_IN
TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_OUT
TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_IN
TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_OUT
TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_OUT
TS_CONFIG_HTTP_ORIGIN_MAX_CONNECTIONS
TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES
TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES_DEAD_SERVER
TS_CONFIG_HTTP_CONNECT_ATTEMPTS_RR_RETRIES
TS_CONFIG_HTTP_CONNECT_ATTEMPTS_TIMEOUT
TS_CONFIG_HTTP_POST_CONNECT_ATTEMPTS_TIMEOUT
TS_CONFIG_HTTP_DOWN_SERVER_CACHE_TIME
TS_CONFIG_HTTP_DOWN_SERVER_ABORT_THRESHOLD
TS_CONFIG_HTTP_CACHE_FUZZ_TIME
TS_CONFIG_HTTP_CACHE_FUZZ_MIN_TIME
TS_CONFIG_HTTP_DOC_IN_CACHE_SKIP_DNS
TS_CONFIG_HTTP_BACKGROUND_FILL_ACTIVE_TIMEOUT
TS_CONFIG_HTTP_RESPONSE_SERVER_STR
TS_CONFIG_HTTP_CACHE_HEURISTIC_LM_FACTOR
TS_CONFIG_HTTP_CACHE_FUZZ_PROBABILITY
TS_CONFIG_HTTP_BACKGROUND_FILL_COMPLETED_THRESHOLD
TS_CONFIG_NET_SOCK_PACKET_MARK_OUT
TS_CONFIG_NET_SOCK_PACKET_TOS_OUT
TS_CONFIG_HTTP_INSERT_AGE_IN_RESPONSE
TS_CONFIG_HTTP_CHUNKING_SIZE
TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED
TS_CONFIG_HTTP_FLOW_CONTROL_LOW_WATER_MARK
TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER_MARK
TS_CONFIG_HTTP_CACHE_RANGE_LOOKUP
TS_CONFIG_HTTP_NORMALIZE_AE_GZIP
TS_CONFIG_HTTP_DEFAULT_BUFFER_SIZE
TS_CONFIG_HTTP_DEFAULT_BUFFER_WATER_MARK
TS_CONFIG_HTTP_REQUEST_HEADER_MAX_SIZE
TS_CONFIG_HTTP_RESPONSE_HEADER_MAX_SIZE
TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_ENABLED
TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_LIFETIME
TS_CONFIG_HTTP_ACCEPT_ENCODING_FILTER_ENABLED
TS_CONFIG_SSL_HSTS_MAX_AGE
TS_CONFIG_SSL_HSTS_INCLUDE_SUBDOMAINS
TS_CONFIG_HTTP_CACHE_OPEN_READ_RETRY_TIME
TS_CONFIG_HTTP_CACHE_MAX_OPEN_READ_RETRIES
TS_CONFIG_HTTP_CACHE_RANGE_WRITE
TS_CONFIG_HTTP_POST_CHECK_CONTENT_LENGTH_ENABLED
TS_CONFIG_HTTP_GLOBAL_USER_AGENT_HEADER
TS_CONFIG_LAST_ENTRY

Definition at line 648 of file apidefs.h.

enum TSParseResult

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

Enumerator:

TS_PARSE_ERROR
TS_PARSE_DONE
TS_PARSE_OK
TS_PARSE_CONT

Definition at line 113 of file apidefs.h.

enum TSRecordAccessType

Enumerator:

TS_RECORDACCESS_NULL
TS_RECORDACCESS_NO_ACCESS
TS_RECORDACCESS_READ_ONLY

Definition at line 641 of file apidefs.h.

enum TSRecordCheckType

Enumerator:

TS_RECORDCHECK_NULL
TS_RECORDCHECK_STR
TS_RECORDCHECK_INT
TS_RECORDCHECK_IP

Definition at line 623 of file apidefs.h.

enum TSRecordDataType

Enumerator:

TS_RECORDDATATYPE_NULL
TS_RECORDDATATYPE_INT
TS_RECORDDATATYPE_FLOAT
TS_RECORDDATATYPE_STRING
TS_RECORDDATATYPE_COUNTER
TS_RECORDDATATYPE_STAT_CONST
TS_RECORDDATATYPE_STAT_FX
TS_RECORDDATATYPE_MAX

Definition at line 584 of file apidefs.h.

enum TSRecordModeType

Enumerator:

TS_RECORDMODE_NULL
TS_RECORDMODE_CLIENT
TS_RECORDMODE_SERVER
TS_RECORDMODE_STAND_ALONE

Definition at line 632 of file apidefs.h.

enum TSRecordPersistType

Enumerator:

TS_RECORDP_NULL
TS_RECORDP_PERSISTENT
TS_RECORDP_NON_PERSISTENT

Definition at line 605 of file apidefs.h.

enum TSRecordType

Enumerator:

TS_RECORDTYPE_NULL
TS_RECORDTYPE_CONFIG
TS_RECORDTYPE_PROCESS
TS_RECORDTYPE_NODE
TS_RECORDTYPE_CLUSTER
TS_RECORDTYPE_LOCAL
TS_RECORDTYPE_PLUGIN
TS_RECORDTYPE_ALL

Definition at line 571 of file apidefs.h.

enum TSRecordUpdateType

Enumerator:

TS_RECORDUPDATE_NULL
TS_RECORDUPDATE_DYNAMIC
TS_RECORDUPDATE_RESTART_TS
TS_RECORDUPDATE_RESTART_TM
TS_RECORDUPDATE_RESTART_TC

Definition at line 613 of file apidefs.h.

enum TSReturnCode

Enumerator:

TS_ERROR
TS_SUCCESS

Definition at line 534 of file apidefs.h.

enum TSSDKVersion

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

Enumerator:

TS_SDK_VERSION_2_0
TS_SDK_VERSION_3_0

Definition at line 528 of file apidefs.h.

enum TSServerSessionSharingMatchType

Server session sharing values - match Must be identical to definition in HttpProxyAPIEnums.h.

Enumerator:

TS_SERVER_SESSION_SHARING_MATCH_NONE
TS_SERVER_SESSION_SHARING_MATCH_BOTH
TS_SERVER_SESSION_SHARING_MATCH_IP
TS_SERVER_SESSION_SHARING_MATCH_HOST
TS_SERVER_SESSION_SHARING_MATCH_NONE
TS_SERVER_SESSION_SHARING_MATCH_BOTH
TS_SERVER_SESSION_SHARING_MATCH_IP
TS_SERVER_SESSION_SHARING_MATCH_HOST

Definition at line 551 of file apidefs.h.

enum TSServerSessionSharingPoolType

Server session sharing values - pool Must be identical to definition in HttpProxyAPIEnums.h.

Enumerator:

TS_SERVER_SESSION_SHARING_POOL_GLOBAL
TS_SERVER_SESSION_SHARING_POOL_THREAD
TS_SERVER_SESSION_SHARING_POOL_GLOBAL
TS_SERVER_SESSION_SHARING_POOL_THREAD

Definition at line 561 of file apidefs.h.

enum TSServerState

Enumerator:

TS_SRVSTATE_STATE_UNDEFINED
TS_SRVSTATE_ACTIVE_TIMEOUT
TS_SRVSTATE_BAD_INCOMING_RESPONSE
TS_SRVSTATE_CONNECTION_ALIVE
TS_SRVSTATE_CONNECTION_CLOSED
TS_SRVSTATE_CONNECTION_ERROR
TS_SRVSTATE_INACTIVE_TIMEOUT
TS_SRVSTATE_OPEN_RAW_ERROR
TS_SRVSTATE_PARSE_ERROR
TS_SRVSTATE_TRANSACTION_COMPLETE
TS_SRVSTATE_CONGEST_CONTROL_CONGESTED_ON_F
TS_SRVSTATE_CONGEST_CONTROL_CONGESTED_ON_M

Definition at line 449 of file apidefs.h.

enum TSThreadPool

Enumerator:

TS_THREAD_POOL_DEFAULT
TS_THREAD_POOL_NET
TS_THREAD_POOL_TASK
TS_THREAD_POOL_SSL
TS_THREAD_POOL_DNS
TS_THREAD_POOL_REMAP
TS_THREAD_POOL_CLUSTER
TS_THREAD_POOL_UDP

Definition at line 742 of file apidefs.h.

enum TSVConnCloseFlags

Enumerator:

TS_VC_CLOSE_ABORT
TS_VC_CLOSE_NORMAL

Definition at line 506 of file apidefs.h.

Function Documentation

tsapi void TSPluginInit	(	int	argc,
		const char *	argv[]
	)

This function must be defined by all plugins.

Traffic Server calls this initialization routine when it loads the plugin (at startup), and sets argc and argv appropriately based on the values in plugin.config.

Parameters:

	argc	the number of initial values specified in plugin.config, plus one. If only the name of your plugin shared object is specified in plugin.config, argc=1.
	argv	the vector of arguments. The length of argv is argc. argv[0] is the name of the plugin shared library. Subsequent values of argv are initialization values specified in plugin.config.