You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2010/11/16 21:22:08 UTC
svn commit: r1035782 [12/29] - in /trafficserver/traffic/trunk:
example/add-header/ example/append-transform/ example/basic-auth/
example/blacklist-0/ example/blacklist-1/ example/bnull-transform/
example/cache_plugin/ example/cache_scan/ example/file-...
Modified: trafficserver/traffic/trunk/proxy/api/ts/ts.h.in
URL: http://svn.apache.org/viewvc/trafficserver/traffic/trunk/proxy/api/ts/ts.h.in?rev=1035782&r1=1035781&r2=1035782&view=diff
==============================================================================
--- trafficserver/traffic/trunk/proxy/api/ts/ts.h.in (original)
+++ trafficserver/traffic/trunk/proxy/api/ts/ts.h.in Tue Nov 16 20:22:02 2010
@@ -27,8 +27,8 @@
*/
-#ifndef __INK_API_H__
-#define __INK_API_H__
+#ifndef __TS_API_H__
+#define __TS_API_H__
/* GENERATED FILE WARNING! DO NOT EDIT ts.h
*
@@ -39,9 +39,9 @@
#include <sys/types.h>
#include <stdint.h>
-#define inkapi
-#define inkexp
-#define inkimp
+#define tsapi
+#define tsexp
+#define tsimp
#ifdef __cplusplus
extern "C"
@@ -56,25 +56,25 @@ extern "C"
#define TS_VERSION_MINOR @TS_VERSION_MINOR@
#define TS_VERSION_MICRO @TS_VERSION_MICRO@
-#define INK_HTTP_VERSION(a,b) ((((a) & 0xFFFF) << 16) | ((b) & 0xFFFF))
-#define INK_HTTP_MINOR(v) ((v) & 0xFFFF)
-#define INK_HTTP_MAJOR(v) (((v) >> 16) & 0xFFFF)
-#define __INK_RES_PATH(x) #x
-#define _INK_RES_PATH(x) __INK_RES_PATH (x)
-#define INK_RES_PATH(x) x __FILE__ ":" _INK_RES_PATH (__LINE__)
-#define INK_RES_MEM_PATH INK_RES_PATH ("memory/")
-#define INK_MAX_USER_NAME_LEN 256
+#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
#if __GNUC__ >= 3
-#ifndef INK_DEPRECATED
-#define INK_DEPRECATED __attribute__ ((deprecated))
+#ifndef TS_DEPRECATED
+#define TS_DEPRECATED __attribute__ ((deprecated))
#endif
#else
-#define INK_DEPRECATED
+#define TS_DEPRECATED
#endif
/**
- The following struct is used by INKPluginRegister(). It stores
+ The following struct is used by TSPluginRegister(). It stores
registration information about the plugin.
*/
@@ -83,364 +83,356 @@ extern "C"
char *plugin_name;
char *vendor_name;
char *support_email;
- } INKPluginRegistrationInfo;
+ } TSPluginRegistrationInfo;
/**
This set of enums are possible values returned by
- INKHttpHdrParseReq() and INKHttpHdrParseResp().
+ TSHttpHdrParseReq() and TSHttpHdrParseResp().
*/
typedef enum
{
- INK_PARSE_ERROR = -1,
- INK_PARSE_DONE = 0,
- INK_PARSE_OK = 1,
- INK_PARSE_CONT = 2
- } INKParseResult;
+ TS_PARSE_ERROR = -1,
+ TS_PARSE_DONE = 0,
+ TS_PARSE_OK = 1,
+ TS_PARSE_CONT = 2
+ } TSParseResult;
/**
This set of enums represents the possible HTTP types that
can be assigned to an HTTP header. When a header is created
- with INKHttpHdrCreate(), it is automatically assigned a type of
- INK_HTTP_TYPE_UNKNOWN. You can modify the HTTP type ONCE after it
- the header is created, using INKHttpHdrTypeSet(). After setting the
- HTTP type once, you cannot set it again. Use INKHttpHdrTypeGet()
- to obtain the INKHttpType of an HTTP header.
+ 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.
*/
typedef enum
{
- INK_HTTP_TYPE_UNKNOWN,
- INK_HTTP_TYPE_REQUEST,
- INK_HTTP_TYPE_RESPONSE
- } INKHttpType;
+ TS_HTTP_TYPE_UNKNOWN,
+ TS_HTTP_TYPE_REQUEST,
+ TS_HTTP_TYPE_RESPONSE
+ } TSHttpType;
/**
This set of enums represents possible return values from
- INKHttpHdrStatusGet(), which retrieves the status code from an
- HTTP response header (INKHttpHdrStatusGet() retrieves status codes
- only from headers of type INK_HTTP_TYPE_RESPONSE). You can also set
- the INKHttpStatus of a response header using INKHttpHdrStatusSet().
+ 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().
*/
typedef enum
{
- INK_HTTP_STATUS_NONE = 0,
-
- INK_HTTP_STATUS_CONTINUE = 100,
- INK_HTTP_STATUS_SWITCHING_PROTOCOL = 101,
-
- INK_HTTP_STATUS_OK = 200,
- INK_HTTP_STATUS_CREATED = 201,
- INK_HTTP_STATUS_ACCEPTED = 202,
- INK_HTTP_STATUS_NON_AUTHORITATIVE_INFORMATION = 203,
- INK_HTTP_STATUS_NO_CONTENT = 204,
- INK_HTTP_STATUS_RESET_CONTENT = 205,
- INK_HTTP_STATUS_PARTIAL_CONTENT = 206,
-
- INK_HTTP_STATUS_MULTIPLE_CHOICES = 300,
- INK_HTTP_STATUS_MOVED_PERMANENTLY = 301,
- INK_HTTP_STATUS_MOVED_TEMPORARILY = 302,
- INK_HTTP_STATUS_SEE_OTHER = 303,
- INK_HTTP_STATUS_NOT_MODIFIED = 304,
- INK_HTTP_STATUS_USE_PROXY = 305,
- INK_HTTP_STATUS_TEMPORARY_REDIRECT = 307,
-
- INK_HTTP_STATUS_BAD_REQUEST = 400,
- INK_HTTP_STATUS_UNAUTHORIZED = 401,
- INK_HTTP_STATUS_PAYMENT_REQUIRED = 402,
- INK_HTTP_STATUS_FORBIDDEN = 403,
- INK_HTTP_STATUS_NOT_FOUND = 404,
- INK_HTTP_STATUS_METHOD_NOT_ALLOWED = 405,
- INK_HTTP_STATUS_NOT_ACCEPTABLE = 406,
- INK_HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED = 407,
- INK_HTTP_STATUS_REQUEST_TIMEOUT = 408,
- INK_HTTP_STATUS_CONFLICT = 409,
- INK_HTTP_STATUS_GONE = 410,
- INK_HTTP_STATUS_LENGTH_REQUIRED = 411,
- INK_HTTP_STATUS_PRECONDITION_FAILED = 412,
- INK_HTTP_STATUS_REQUEST_ENTITY_TOO_LARGE = 413,
- INK_HTTP_STATUS_REQUEST_URI_TOO_LONG = 414,
- INK_HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE = 415,
-
- INK_HTTP_STATUS_INTERNAL_SERVER_ERROR = 500,
- INK_HTTP_STATUS_NOT_IMPLEMENTED = 501,
- INK_HTTP_STATUS_BAD_GATEWAY = 502,
- INK_HTTP_STATUS_SERVICE_UNAVAILABLE = 503,
- INK_HTTP_STATUS_GATEWAY_TIMEOUT = 504,
- INK_HTTP_STATUS_HTTPVER_NOT_SUPPORTED = 505
- } INKHttpStatus;
+ 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_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_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_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
+ } TSHttpStatus;
/**
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:
- INKHttpHookAdd: adds a global hook. You can globally add
- any hook except for INK_HTTP_REQUEST_TRANSFORM_HOOK and
- INK_HTTP_RESPONSE_TRANSFORM_HOOK.
+ TSHttpHookAdd: adds a global hook. You can globally add
+ any hook except for TS_HTTP_REQUEST_TRANSFORM_HOOK and
+ TS_HTTP_RESPONSE_TRANSFORM_HOOK.
The following hooks can ONLY be added globally:
- - INK_HTTP_SELECT_ALT_HOOK
- - INK_HTTP_SSN_START_HOOK
- - INK_HTTP_SSN_CLOSE_HOOK
+ - TS_HTTP_SELECT_ALT_HOOK
+ - TS_HTTP_SSN_START_HOOK
+ - TS_HTTP_SSN_CLOSE_HOOK
- INKHttpSsnHookAdd: adds a transaction hook to each transaction
+ TSHttpSsnHookAdd: adds a transaction hook to each transaction
within a session. You can only use transaction hooks with this call:
- - INK_HTTP_READ_REQUEST_HDR_HOOK
- - INK_HTTP_OS_DNS_HOOK
- - INK_HTTP_SEND_REQUEST_HDR_HOOK
- - INK_HTTP_READ_CACHE_HDR_HOOK
- - INK_HTTP_READ_RESPONSE_HDR_HOOK
- - INK_HTTP_SEND_RESPONSE_HDR_HOOK
- - INK_HTTP_REQUEST_TRANSFORM_HOOK
- - INK_HTTP_RESPONSE_TRANSFORM_HOOK
- - INK_HTTP_TXN_START_HOOK
- - INK_HTTP_TXN_CLOSE_HOOK
+ - 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_START_HOOK
+ - TS_HTTP_TXN_CLOSE_HOOK
- INKHttpTxnHookAdd: adds a callback at a specific point within
+ TSHttpTxnHookAdd: adds a callback at a specific point within
an HTTP transaction. The following hooks can be used with this
function:
- - INK_HTTP_READ_REQUEST_HDR_HOOK
- - INK_HTTP_OS_DNS_HOOK
- - INK_HTTP_SEND_REQUEST_HDR_HOOK
- - INK_HTTP_READ_CACHE_HDR_HOOK
- - INK_HTTP_READ_RESPONSE_HDR_HOOK
- - INK_HTTP_SEND_RESPONSE_HDR_HOOK
- - INK_HTTP_REQUEST_TRANSFORM_HOOK
- - INK_HTTP_RESPONSE_TRANSFORM_HOOK
- - INK_HTTP_TXN_CLOSE_HOOK
+ - 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.
- INK_HTTP_LAST_HOOK _must_ be the last element. Only right place
- to insert a new element is just before INK_HTTP_LAST_HOOK.
+ TS_HTTP_LAST_HOOK _must_ be the last element. Only right place
+ to insert a new element is just before TS_HTTP_LAST_HOOK.
*/
typedef enum
{
- INK_HTTP_READ_REQUEST_HDR_HOOK,
- INK_HTTP_OS_DNS_HOOK,
- INK_HTTP_SEND_REQUEST_HDR_HOOK,
- INK_HTTP_READ_CACHE_HDR_HOOK,
- INK_HTTP_READ_RESPONSE_HDR_HOOK,
- INK_HTTP_SEND_RESPONSE_HDR_HOOK,
- INK_HTTP_REQUEST_TRANSFORM_HOOK,
- INK_HTTP_RESPONSE_TRANSFORM_HOOK,
- INK_HTTP_SELECT_ALT_HOOK,
- INK_HTTP_TXN_START_HOOK,
- INK_HTTP_TXN_CLOSE_HOOK,
- INK_HTTP_SSN_START_HOOK,
- INK_HTTP_SSN_CLOSE_HOOK,
- INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK,
- INK_HTTP_PRE_REMAP_HOOK,
- INK_HTTP_POST_REMAP_HOOK,
- INK_HTTP_LAST_HOOK
- } INKHttpHookID;
-
- #define INK_HTTP_READ_REQUEST_PRE_REMAP_HOOK INK_HTTP_PRE_REMAP_HOOK //backwards compat
-
+ 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_LAST_HOOK
+ } TSHttpHookID;
+ #define TS_HTTP_READ_REQUEST_PRE_REMAP_HOOK TS_HTTP_PRE_REMAP_HOOK //backwards compat
+
typedef enum
{
- INK_CACHE_PLUGIN_HOOK,
- INK_CACHE_LOOKUP_HOOK,
- INK_CACHE_READ_HOOK,
- INK_CACHE_WRITE_HOOK,
- INK_CACHE_DELETE_HOOK,
- INK_CACHE_LAST_HOOK
- } INKCacheHookID;
+ TS_CACHE_PLUGIN_HOOK,
+ TS_CACHE_LOOKUP_HOOK,
+ TS_CACHE_READ_HOOK,
+ TS_CACHE_WRITE_HOOK,
+ TS_CACHE_DELETE_HOOK,
+ TS_CACHE_LAST_HOOK
+ } TSCacheHookID;
/**
- INKEvents are sent to continuations when they are called back.
- The INKEvent provides the continuation's handler function with
+ 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.
*/
typedef enum
{
- INK_EVENT_NONE = 0,
- INK_EVENT_IMMEDIATE = 1,
- INK_EVENT_TIMEOUT = 2,
- INK_EVENT_ERROR = 3,
- INK_EVENT_CONTINUE = 4,
-
- INK_EVENT_VCONN_READ_READY = 100,
- INK_EVENT_VCONN_WRITE_READY = 101,
- INK_EVENT_VCONN_READ_COMPLETE = 102,
- INK_EVENT_VCONN_WRITE_COMPLETE = 103,
- INK_EVENT_VCONN_EOS = 104,
- INK_EVENT_VCONN_INACTIVITY_TIMEOUT = 105,
-
- INK_EVENT_NET_CONNECT = 200,
- INK_EVENT_NET_CONNECT_FAILED = 201,
- INK_EVENT_NET_ACCEPT = 202,
- INK_EVENT_NET_ACCEPT_FAILED = 204,
+ 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,
/* EVENTS 206 - 212 for internal use */
- INK_EVENT_INTERNAL_206 = 206,
- INK_EVENT_INTERNAL_207 = 207,
- INK_EVENT_INTERNAL_208 = 208,
- INK_EVENT_INTERNAL_209 = 209,
- INK_EVENT_INTERNAL_210 = 210,
- INK_EVENT_INTERNAL_211 = 211,
- INK_EVENT_INTERNAL_212 = 212,
-
- INK_EVENT_HOST_LOOKUP = 500,
- INK_EVENT_CACHE_OPEN_READ = 1102,
- INK_EVENT_CACHE_OPEN_READ_FAILED = 1103,
- INK_EVENT_CACHE_OPEN_WRITE = 1108,
- INK_EVENT_CACHE_OPEN_WRITE_FAILED = 1109,
- INK_EVENT_CACHE_REMOVE = 1112,
- INK_EVENT_CACHE_REMOVE_FAILED = 1113,
- INK_EVENT_CACHE_SCAN = 1120,
- INK_EVENT_CACHE_SCAN_FAILED = 1121,
- INK_EVENT_CACHE_SCAN_OBJECT = 1122,
- INK_EVENT_CACHE_SCAN_OPERATION_BLOCKED = 1123,
- INK_EVENT_CACHE_SCAN_OPERATION_FAILED = 1124,
- INK_EVENT_CACHE_SCAN_DONE = 1125,
-
- INK_EVENT_CACHE_LOOKUP = 1126,
- INK_EVENT_CACHE_READ = 1127,
- INK_EVENT_CACHE_DELETE = 1128,
- INK_EVENT_CACHE_WRITE = 1129,
- INK_EVENT_CACHE_WRITE_HEADER = 1130,
- INK_EVENT_CACHE_CLOSE = 1131,
- INK_EVENT_CACHE_LOOKUP_READY = 1132,
- INK_EVENT_CACHE_LOOKUP_COMPLETE = 1133,
- INK_EVENT_CACHE_READ_READY = 1134,
- INK_EVENT_CACHE_READ_COMPLETE = 1135,
+ 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,
/* EVENT 1200 for internal use */
- INK_EVENT_INTERNAL_1200 = 1200,
+ TS_EVENT_INTERNAL_1200 = 1200,
/* EVENT 3900 is corresponding to event AIO_EVENT_DONE defined in I_AIO.h */
- INK_AIO_EVENT_DONE = 3900,
+ TS_AIO_EVENT_DONE = 3900,
- INK_EVENT_HTTP_CONTINUE = 60000,
- INK_EVENT_HTTP_ERROR = 60001,
- INK_EVENT_HTTP_READ_REQUEST_HDR = 60002,
- INK_EVENT_HTTP_OS_DNS = 60003,
- INK_EVENT_HTTP_SEND_REQUEST_HDR = 60004,
- INK_EVENT_HTTP_READ_CACHE_HDR = 60005,
- INK_EVENT_HTTP_READ_RESPONSE_HDR = 60006,
- INK_EVENT_HTTP_SEND_RESPONSE_HDR = 60007,
- INK_EVENT_HTTP_REQUEST_TRANSFORM = 60008,
- INK_EVENT_HTTP_RESPONSE_TRANSFORM = 60009,
- INK_EVENT_HTTP_SELECT_ALT = 60010,
- INK_EVENT_HTTP_TXN_START = 60011,
- INK_EVENT_HTTP_TXN_CLOSE = 60012,
- INK_EVENT_HTTP_SSN_START = 60013,
- INK_EVENT_HTTP_SSN_CLOSE = 60014,
- INK_EVENT_HTTP_CACHE_LOOKUP_COMPLETE = 60015,
- INK_EVENT_HTTP_PRE_REMAP = 60016,
- INK_EVENT_HTTP_POST_REMAP = 60017,
- INK_EVENT_MGMT_UPDATE = 60100,
+ 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_MGMT_UPDATE = 60100,
/* EVENTS 60200 - 60202 for internal use */
- INK_EVENT_INTERNAL_60200 = 60200,
- INK_EVENT_INTERNAL_60201 = 60201,
- INK_EVENT_INTERNAL_60202 = 60202
- } INKEvent;
-
- #define INK_EVENT_HTTP_READ_REQUEST_PRE_REMAP INK_EVENT_HTTP_PRE_REMAP //backwards compat
-
+ TS_EVENT_INTERNAL_60200 = 60200,
+ TS_EVENT_INTERNAL_60201 = 60201,
+ TS_EVENT_INTERNAL_60202 = 60202
+ } TSEvent;
+ #define TS_EVENT_HTTP_READ_REQUEST_PRE_REMAP TS_EVENT_HTTP_PRE_REMAP //backwards compat
+
typedef enum
- { INK_SRVSTATE_STATE_UNDEFINED = 0,
- INK_SRVSTATE_ACTIVE_TIMEOUT,
- INK_SRVSTATE_BAD_INCOMING_RESPONSE,
- INK_SRVSTATE_CONNECTION_ALIVE,
- INK_SRVSTATE_CONNECTION_CLOSED,
- INK_SRVSTATE_CONNECTION_ERROR,
- INK_SRVSTATE_INACTIVE_TIMEOUT,
- INK_SRVSTATE_OPEN_RAW_ERROR,
- INK_SRVSTATE_PARSE_ERROR,
- INK_SRVSTATE_TRANSACTION_COMPLETE,
- INK_SRVSTATE_CONGEST_CONTROL_CONGESTED_ON_F,
- INK_SRVSTATE_CONGEST_CONTROL_CONGESTED_ON_M
- } INKServerState;
+ { 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
+ } TSServerState;
typedef enum
{
- INK_LOOKUP_UNDEFINED_LOOKUP,
- INK_LOOKUP_ICP_SUGGESTED_HOST,
- INK_LOOKUP_PARENT_PROXY,
- INK_LOOKUP_ORIGIN_SERVER,
- INK_LOOKUP_INCOMING_ROUTER,
- INK_LOOKUP_HOST_NONE
- } INKLookingUpType;
+ 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
+ } TSLookingUpType;
typedef enum
{
- INK_CACHE_LOOKUP_MISS,
- INK_CACHE_LOOKUP_HIT_STALE,
- INK_CACHE_LOOKUP_HIT_FRESH,
- INK_CACHE_LOOKUP_SKIPPED
- } INKCacheLookupResult;
+ TS_CACHE_LOOKUP_MISS,
+ TS_CACHE_LOOKUP_HIT_STALE,
+ TS_CACHE_LOOKUP_HIT_FRESH,
+ TS_CACHE_LOOKUP_SKIPPED
+ } TSCacheLookupResult;
typedef enum
{
- INK_CACHE_DATA_TYPE_NONE,
- INK_CACHE_DATA_TYPE_HTTP,
- INK_CACHE_DATA_TYPE_OTHER
- } INKCacheDataType;
+ TS_CACHE_DATA_TYPE_NONE,
+ TS_CACHE_DATA_TYPE_HTTP,
+ TS_CACHE_DATA_TYPE_OTHER
+ } TSCacheDataType;
typedef enum
{
- INK_CACHE_ERROR_NO_DOC = -20400,
- INK_CACHE_ERROR_DOC_BUSY = -20401,
- INK_CACHE_ERROR_NOT_READY = -20407
- } INKCacheError;
+ TS_CACHE_ERROR_NO_DOC = -20400,
+ TS_CACHE_ERROR_DOC_BUSY = -20401,
+ TS_CACHE_ERROR_NOT_READY = -20407
+ } TSCacheError;
typedef enum
{
- INK_CACHE_SCAN_RESULT_DONE = 0,
- INK_CACHE_SCAN_RESULT_CONTINUE = 1,
- INK_CACHE_SCAN_RESULT_DELETE = 10,
- INK_CACHE_SCAN_RESULT_DELETE_ALL_ALTERNATES,
- INK_CACHE_SCAN_RESULT_UPDATE,
- INK_CACHE_SCAN_RESULT_RETRY
- } INKCacheScanResult;
+ 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
+ } TSCacheScanResult;
typedef enum
{
- INK_DATA_ALLOCATE,
- INK_DATA_MALLOCED,
- INK_DATA_CONSTANT
- } INKIOBufferDataFlags;
+ TS_DATA_ALLOCATE,
+ TS_DATA_MALLOCED,
+ TS_DATA_CONSTANT
+ } TSIOBufferDataFlags;
typedef enum
{
- INK_VC_CLOSE_ABORT = -1,
- INK_VC_CLOSE_NORMAL = 1
- } INKVConnCloseFlags;
+ TS_VC_CLOSE_ABORT = -1,
+ TS_VC_CLOSE_NORMAL = 1
+ } TSVConnCloseFlags;
typedef enum
{
- INK_IOBUFFER_SIZE_INDEX_128 = 0,
- INK_IOBUFFER_SIZE_INDEX_256 = 1,
- INK_IOBUFFER_SIZE_INDEX_512 = 2,
- INK_IOBUFFER_SIZE_INDEX_1K = 3,
- INK_IOBUFFER_SIZE_INDEX_2K = 4,
- INK_IOBUFFER_SIZE_INDEX_4K = 5,
- INK_IOBUFFER_SIZE_INDEX_8K = 6,
- INK_IOBUFFER_SIZE_INDEX_16K = 7,
- INK_IOBUFFER_SIZE_INDEX_32K = 8
- } INKIOBufferSizeIndex;
+ 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
+ } TSIOBufferSizeIndex;
/**
Starting 2.0, SDK now follows same versioning as Traffic Server.
*/
typedef enum
{
- INK_SDK_VERSION_2_0 = 0
- } INKSDKVersion;
-
- typedef enum
- {
- INK_ERROR = -1,
- INK_SUCCESS = 0
- } INKReturnCode;
+ TS_SDK_VERSION_2_0 = 0
+ } TSSDKVersion;
typedef enum
{
@@ -453,8 +445,8 @@ extern "C"
NO_CALLBACK = 0,
AFTER_HEADER ,
AFTER_BODY
- } INKFetchWakeUpOptions;
- extern inkapi const void *INK_ERROR_PTR;
+ } TSFetchWakeUpOptions;
+ extern tsapi const void *TS_ERROR_PTR;
typedef int int32;
typedef unsigned int uint32;
@@ -463,60 +455,60 @@ extern "C"
typedef int64 TSHRTime;
- /* These typedefs are used with the corresponding INKMgmt*Get functions
+ /* These typedefs are used with the corresponding TSMgmt*Get functions
for storing the values retrieved by those functions. For example,
- INKMgmtCounterGet() retrieves an INKMgmtCounter. */
- typedef int64 INKMgmtInt;
- typedef int64 INKMgmtCounter;
- typedef float INKMgmtFloat;
- typedef char *INKMgmtString;
-
- typedef void *INKFile;
-
- typedef void *INKMLoc;
- typedef void *INKMBuffer;
- typedef void *INKHttpSsn;
- typedef void *INKHttpTxn;
- typedef void *INKHttpAltInfo;
- typedef void *INKMimeParser;
- typedef void *INKHttpParser;
- typedef void *INKCacheKey;
- typedef void *INKCacheHttpInfo;
- typedef void *INKCacheTxn;
-
- typedef void *INKVIO;
- typedef void *INKThread;
- typedef void *INKMutex;
- typedef void *INKConfig;
- typedef void *INKCont;
- typedef void *INKAction;
- typedef void *INKVConn;
- typedef void *INKIOBuffer;
- typedef void *INKIOBufferData;
- typedef void *INKIOBufferBlock;
- typedef void *INKIOBufferReader;
- typedef void *INKHostLookupResult;
-
- typedef void *(*INKThreadFunc) (void *data);
- typedef int (*INKEventFunc) (INKCont contp, INKEvent event, void *edata);
- typedef void (*INKConfigDestroyFunc) (void *data);
+ TSMgmtCounterGet() retrieves an TSMgmtCounter. */
+ typedef int64 TSMgmtInt;
+ typedef int64 TSMgmtCounter;
+ typedef float TSMgmtFloat;
+ typedef char *TSMgmtString;
+
+ typedef void *TSFile;
+
+ typedef void *TSMLoc;
+ typedef void *TSMBuffer;
+ typedef void *TSHttpSsn;
+ typedef void *TSHttpTxn;
+ typedef void *TSHttpAltInfo;
+ typedef void *TSMimeParser;
+ typedef void *TSHttpParser;
+ typedef void *TSCacheKey;
+ typedef void *TSCacheHttpInfo;
+ typedef void *TSCacheTxn;
+
+ typedef void *TSVIO;
+ typedef void *TSThread;
+ typedef void *TSMutex;
+ typedef void *TSConfig;
+ typedef void *TSCont;
+ typedef void *TSAction;
+ typedef void *TSVConn;
+ typedef void *TSIOBuffer;
+ typedef void *TSIOBufferData;
+ typedef void *TSIOBufferBlock;
+ typedef void *TSIOBufferReader;
+ typedef void *TSHostLookupResult;
+
+ typedef void *(*TSThreadFunc) (void *data);
+ typedef int (*TSEventFunc) (TSCont contp, TSEvent event, void *edata);
+ typedef void (*TSConfigDestroyFunc) (void *data);
typedef struct
{
int success_event_id;
int failure_event_id;
int timeout_event_id;
- }INKFetchEvent;
- typedef struct INKFetchUrlParams
+ }TSFetchEvent;
+ typedef struct TSFetchUrlParams
{
const char *request;
int request_len;
unsigned int ip;
int port;
- INKCont contp;
- INKFetchEvent events;
- INKFetchWakeUpOptions options;
- struct INKFetchUrlParams *next;
- }INKFetchUrlParams_t;
+ TSCont contp;
+ TSFetchEvent events;
+ TSFetchWakeUpOptions options;
+ struct TSFetchUrlParams *next;
+ }TSFetchUrlParams_t;
/* --------------------------------------------------------------------------
Init */
@@ -536,7 +528,7 @@ extern "C"
plugin.config.
*/
- extern inkexp void INKPluginInit(int argc, const char *argv[]);
+ extern tsexp void TSPluginInit(int argc, const char *argv[]);
/* --------------------------------------------------------------------------
License */
@@ -551,298 +543,298 @@ extern "C"
@return Zero if no license is required. Returns 1 if a license
is required.
*/
- extern inkexp int INKPluginLicenseRequired(void);
+ extern tsexp int TSPluginLicenseRequired(void);
/* --------------------------------------------------------------------------
URL schemes */
- extern inkapi const char *INK_URL_SCHEME_FILE;
- extern inkapi const char *INK_URL_SCHEME_FTP;
- extern inkapi const char *INK_URL_SCHEME_GOPHER;
- extern inkapi const char *INK_URL_SCHEME_HTTP;
- extern inkapi const char *INK_URL_SCHEME_HTTPS;
- extern inkapi const char *INK_URL_SCHEME_MAILTO;
- extern inkapi const char *INK_URL_SCHEME_NEWS;
- extern inkapi const char *INK_URL_SCHEME_NNTP;
- extern inkapi const char *INK_URL_SCHEME_PROSPERO;
- extern inkapi const char *INK_URL_SCHEME_TELNET;
- extern inkapi const char *INK_URL_SCHEME_WAIS;
+ extern tsapi const char *TS_URL_SCHEME_FILE;
+ extern tsapi const char *TS_URL_SCHEME_FTP;
+ extern tsapi const char *TS_URL_SCHEME_GOPHER;
+ extern tsapi const char *TS_URL_SCHEME_HTTP;
+ extern tsapi const char *TS_URL_SCHEME_HTTPS;
+ extern tsapi const char *TS_URL_SCHEME_MAILTO;
+ extern tsapi const char *TS_URL_SCHEME_NEWS;
+ extern tsapi const char *TS_URL_SCHEME_NNTP;
+ extern tsapi const char *TS_URL_SCHEME_PROSPERO;
+ extern tsapi const char *TS_URL_SCHEME_TELNET;
+ extern tsapi const char *TS_URL_SCHEME_WAIS;
/* --------------------------------------------------------------------------
URL scheme string lengths */
- extern inkapi int INK_URL_LEN_FILE;
- extern inkapi int INK_URL_LEN_FTP;
- extern inkapi int INK_URL_LEN_GOPHER;
- extern inkapi int INK_URL_LEN_HTTP;
- extern inkapi int INK_URL_LEN_HTTPS;
- extern inkapi int INK_URL_LEN_MAILTO;
- extern inkapi int INK_URL_LEN_NEWS;
- extern inkapi int INK_URL_LEN_NNTP;
- extern inkapi int INK_URL_LEN_PROSPERO;
- extern inkapi int INK_URL_LEN_TELNET;
- extern inkapi int INK_URL_LEN_WAIS;
+ extern tsapi int TS_URL_LEN_FILE;
+ extern tsapi int TS_URL_LEN_FTP;
+ extern tsapi int TS_URL_LEN_GOPHER;
+ extern tsapi int TS_URL_LEN_HTTP;
+ extern tsapi int TS_URL_LEN_HTTPS;
+ extern tsapi int TS_URL_LEN_MAILTO;
+ extern tsapi int TS_URL_LEN_NEWS;
+ extern tsapi int TS_URL_LEN_NNTP;
+ extern tsapi int TS_URL_LEN_PROSPERO;
+ extern tsapi int TS_URL_LEN_TELNET;
+ extern tsapi int TS_URL_LEN_WAIS;
/* --------------------------------------------------------------------------
MIME fields */
- extern inkapi const char *INK_MIME_FIELD_ACCEPT;
- extern inkapi const char *INK_MIME_FIELD_ACCEPT_CHARSET;
- extern inkapi const char *INK_MIME_FIELD_ACCEPT_ENCODING;
- extern inkapi const char *INK_MIME_FIELD_ACCEPT_LANGUAGE;
- extern inkapi const char *INK_MIME_FIELD_ACCEPT_RANGES;
- extern inkapi const char *INK_MIME_FIELD_AGE;
- extern inkapi const char *INK_MIME_FIELD_ALLOW;
- extern inkapi const char *INK_MIME_FIELD_APPROVED;
- extern inkapi const char *INK_MIME_FIELD_AUTHORIZATION;
- extern inkapi const char *INK_MIME_FIELD_BYTES;
- extern inkapi const char *INK_MIME_FIELD_CACHE_CONTROL;
- extern inkapi const char *INK_MIME_FIELD_CLIENT_IP;
- extern inkapi const char *INK_MIME_FIELD_CONNECTION;
- extern inkapi const char *INK_MIME_FIELD_CONTENT_BASE;
- extern inkapi const char *INK_MIME_FIELD_CONTENT_ENCODING;
- extern inkapi const char *INK_MIME_FIELD_CONTENT_LANGUAGE;
- extern inkapi const char *INK_MIME_FIELD_CONTENT_LENGTH;
- extern inkapi const char *INK_MIME_FIELD_CONTENT_LOCATION;
- extern inkapi const char *INK_MIME_FIELD_CONTENT_MD5;
- extern inkapi const char *INK_MIME_FIELD_CONTENT_RANGE;
- extern inkapi const char *INK_MIME_FIELD_CONTENT_TYPE;
- extern inkapi const char *INK_MIME_FIELD_CONTROL;
- extern inkapi const char *INK_MIME_FIELD_COOKIE;
- extern inkapi const char *INK_MIME_FIELD_DATE;
- extern inkapi const char *INK_MIME_FIELD_DISTRIBUTION;
- extern inkapi const char *INK_MIME_FIELD_ETAG;
- extern inkapi const char *INK_MIME_FIELD_EXPECT;
- extern inkapi const char *INK_MIME_FIELD_EXPIRES;
- extern inkapi const char *INK_MIME_FIELD_FOLLOWUP_TO;
- extern inkapi const char *INK_MIME_FIELD_FROM;
- extern inkapi const char *INK_MIME_FIELD_HOST;
- extern inkapi const char *INK_MIME_FIELD_IF_MATCH;
- extern inkapi const char *INK_MIME_FIELD_IF_MODIFIED_SINCE;
- extern inkapi const char *INK_MIME_FIELD_IF_NONE_MATCH;
- extern inkapi const char *INK_MIME_FIELD_IF_RANGE;
- extern inkapi const char *INK_MIME_FIELD_IF_UNMODIFIED_SINCE;
- extern inkapi const char *INK_MIME_FIELD_KEEP_ALIVE;
- extern inkapi const char *INK_MIME_FIELD_KEYWORDS;
- extern inkapi const char *INK_MIME_FIELD_LAST_MODIFIED;
- extern inkapi const char *INK_MIME_FIELD_LINES;
- extern inkapi const char *INK_MIME_FIELD_LOCATION;
- extern inkapi const char *INK_MIME_FIELD_MAX_FORWARDS;
- extern inkapi const char *INK_MIME_FIELD_MESSAGE_ID;
- extern inkapi const char *INK_MIME_FIELD_NEWSGROUPS;
- extern inkapi const char *INK_MIME_FIELD_ORGANIZATION;
- extern inkapi const char *INK_MIME_FIELD_PATH;
- extern inkapi const char *INK_MIME_FIELD_PRAGMA;
- extern inkapi const char *INK_MIME_FIELD_PROXY_AUTHENTICATE;
- extern inkapi const char *INK_MIME_FIELD_PROXY_AUTHORIZATION;
- extern inkapi const char *INK_MIME_FIELD_PROXY_CONNECTION;
- extern inkapi const char *INK_MIME_FIELD_PUBLIC;
- extern inkapi const char *INK_MIME_FIELD_RANGE;
- extern inkapi const char *INK_MIME_FIELD_REFERENCES;
- extern inkapi const char *INK_MIME_FIELD_REFERER;
- extern inkapi const char *INK_MIME_FIELD_REPLY_TO;
- extern inkapi const char *INK_MIME_FIELD_RETRY_AFTER;
- extern inkapi const char *INK_MIME_FIELD_SENDER;
- extern inkapi const char *INK_MIME_FIELD_SERVER;
- extern inkapi const char *INK_MIME_FIELD_SET_COOKIE;
- extern inkapi const char *INK_MIME_FIELD_SUBJECT;
- extern inkapi const char *INK_MIME_FIELD_SUMMARY;
- extern inkapi const char *INK_MIME_FIELD_TE;
- extern inkapi const char *INK_MIME_FIELD_TRANSFER_ENCODING;
- extern inkapi const char *INK_MIME_FIELD_UPGRADE;
- extern inkapi const char *INK_MIME_FIELD_USER_AGENT;
- extern inkapi const char *INK_MIME_FIELD_VARY;
- extern inkapi const char *INK_MIME_FIELD_VIA;
- extern inkapi const char *INK_MIME_FIELD_WARNING;
- extern inkapi const char *INK_MIME_FIELD_WWW_AUTHENTICATE;
- extern inkapi const char *INK_MIME_FIELD_XREF;
- extern inkapi const char *INK_MIME_FIELD_X_FORWARDED_FOR;
+ extern tsapi const char *TS_MIME_FIELD_ACCEPT;
+ extern tsapi const char *TS_MIME_FIELD_ACCEPT_CHARSET;
+ extern tsapi const char *TS_MIME_FIELD_ACCEPT_ENCODING;
+ extern tsapi const char *TS_MIME_FIELD_ACCEPT_LANGUAGE;
+ extern tsapi const char *TS_MIME_FIELD_ACCEPT_RANGES;
+ extern tsapi const char *TS_MIME_FIELD_AGE;
+ extern tsapi const char *TS_MIME_FIELD_ALLOW;
+ extern tsapi const char *TS_MIME_FIELD_APPROVED;
+ extern tsapi const char *TS_MIME_FIELD_AUTHORIZATION;
+ extern tsapi const char *TS_MIME_FIELD_BYTES;
+ extern tsapi const char *TS_MIME_FIELD_CACHE_CONTROL;
+ extern tsapi const char *TS_MIME_FIELD_CLIENT_IP;
+ extern tsapi const char *TS_MIME_FIELD_CONNECTION;
+ extern tsapi const char *TS_MIME_FIELD_CONTENT_BASE;
+ extern tsapi const char *TS_MIME_FIELD_CONTENT_ENCODING;
+ extern tsapi const char *TS_MIME_FIELD_CONTENT_LANGUAGE;
+ extern tsapi const char *TS_MIME_FIELD_CONTENT_LENGTH;
+ extern tsapi const char *TS_MIME_FIELD_CONTENT_LOCATION;
+ extern tsapi const char *TS_MIME_FIELD_CONTENT_MD5;
+ extern tsapi const char *TS_MIME_FIELD_CONTENT_RANGE;
+ extern tsapi const char *TS_MIME_FIELD_CONTENT_TYPE;
+ extern tsapi const char *TS_MIME_FIELD_CONTROL;
+ extern tsapi const char *TS_MIME_FIELD_COOKIE;
+ extern tsapi const char *TS_MIME_FIELD_DATE;
+ extern tsapi const char *TS_MIME_FIELD_DISTRIBUTION;
+ extern tsapi const char *TS_MIME_FIELD_ETAG;
+ extern tsapi const char *TS_MIME_FIELD_EXPECT;
+ extern tsapi const char *TS_MIME_FIELD_EXPIRES;
+ extern tsapi const char *TS_MIME_FIELD_FOLLOWUP_TO;
+ extern tsapi const char *TS_MIME_FIELD_FROM;
+ extern tsapi const char *TS_MIME_FIELD_HOST;
+ extern tsapi const char *TS_MIME_FIELD_IF_MATCH;
+ extern tsapi const char *TS_MIME_FIELD_IF_MODIFIED_SINCE;
+ extern tsapi const char *TS_MIME_FIELD_IF_NONE_MATCH;
+ extern tsapi const char *TS_MIME_FIELD_IF_RANGE;
+ extern tsapi const char *TS_MIME_FIELD_IF_UNMODIFIED_SINCE;
+ extern tsapi const char *TS_MIME_FIELD_KEEP_ALIVE;
+ extern tsapi const char *TS_MIME_FIELD_KEYWORDS;
+ extern tsapi const char *TS_MIME_FIELD_LAST_MODIFIED;
+ extern tsapi const char *TS_MIME_FIELD_LINES;
+ extern tsapi const char *TS_MIME_FIELD_LOCATION;
+ extern tsapi const char *TS_MIME_FIELD_MAX_FORWARDS;
+ extern tsapi const char *TS_MIME_FIELD_MESSAGE_ID;
+ extern tsapi const char *TS_MIME_FIELD_NEWSGROUPS;
+ extern tsapi const char *TS_MIME_FIELD_ORGANIZATION;
+ extern tsapi const char *TS_MIME_FIELD_PATH;
+ extern tsapi const char *TS_MIME_FIELD_PRAGMA;
+ extern tsapi const char *TS_MIME_FIELD_PROXY_AUTHENTICATE;
+ extern tsapi const char *TS_MIME_FIELD_PROXY_AUTHORIZATION;
+ extern tsapi const char *TS_MIME_FIELD_PROXY_CONNECTION;
+ extern tsapi const char *TS_MIME_FIELD_PUBLIC;
+ extern tsapi const char *TS_MIME_FIELD_RANGE;
+ extern tsapi const char *TS_MIME_FIELD_REFERENCES;
+ extern tsapi const char *TS_MIME_FIELD_REFERER;
+ extern tsapi const char *TS_MIME_FIELD_REPLY_TO;
+ extern tsapi const char *TS_MIME_FIELD_RETRY_AFTER;
+ extern tsapi const char *TS_MIME_FIELD_SENDER;
+ extern tsapi const char *TS_MIME_FIELD_SERVER;
+ extern tsapi const char *TS_MIME_FIELD_SET_COOKIE;
+ extern tsapi const char *TS_MIME_FIELD_SUBJECT;
+ extern tsapi const char *TS_MIME_FIELD_SUMMARY;
+ extern tsapi const char *TS_MIME_FIELD_TE;
+ extern tsapi const char *TS_MIME_FIELD_TRANSFER_ENCODING;
+ extern tsapi const char *TS_MIME_FIELD_UPGRADE;
+ extern tsapi const char *TS_MIME_FIELD_USER_AGENT;
+ extern tsapi const char *TS_MIME_FIELD_VARY;
+ extern tsapi const char *TS_MIME_FIELD_VIA;
+ extern tsapi const char *TS_MIME_FIELD_WARNING;
+ extern tsapi const char *TS_MIME_FIELD_WWW_AUTHENTICATE;
+ extern tsapi const char *TS_MIME_FIELD_XREF;
+ extern tsapi const char *TS_MIME_FIELD_X_FORWARDED_FOR;
/* --------------------------------------------------------------------------
MIME fields string lengths */
- extern inkapi int INK_MIME_LEN_ACCEPT;
- extern inkapi int INK_MIME_LEN_ACCEPT_CHARSET;
- extern inkapi int INK_MIME_LEN_ACCEPT_ENCODING;
- extern inkapi int INK_MIME_LEN_ACCEPT_LANGUAGE;
- extern inkapi int INK_MIME_LEN_ACCEPT_RANGES;
- extern inkapi int INK_MIME_LEN_AGE;
- extern inkapi int INK_MIME_LEN_ALLOW;
- extern inkapi int INK_MIME_LEN_APPROVED;
- extern inkapi int INK_MIME_LEN_AUTHORIZATION;
- extern inkapi int INK_MIME_LEN_BYTES;
- extern inkapi int INK_MIME_LEN_CACHE_CONTROL;
- extern inkapi int INK_MIME_LEN_CLIENT_IP;
- extern inkapi int INK_MIME_LEN_CONNECTION;
- extern inkapi int INK_MIME_LEN_CONTENT_BASE;
- extern inkapi int INK_MIME_LEN_CONTENT_ENCODING;
- extern inkapi int INK_MIME_LEN_CONTENT_LANGUAGE;
- extern inkapi int INK_MIME_LEN_CONTENT_LENGTH;
- extern inkapi int INK_MIME_LEN_CONTENT_LOCATION;
- extern inkapi int INK_MIME_LEN_CONTENT_MD5;
- extern inkapi int INK_MIME_LEN_CONTENT_RANGE;
- extern inkapi int INK_MIME_LEN_CONTENT_TYPE;
- extern inkapi int INK_MIME_LEN_CONTROL;
- extern inkapi int INK_MIME_LEN_COOKIE;
- extern inkapi int INK_MIME_LEN_DATE;
- extern inkapi int INK_MIME_LEN_DISTRIBUTION;
- extern inkapi int INK_MIME_LEN_ETAG;
- extern inkapi int INK_MIME_LEN_EXPECT;
- extern inkapi int INK_MIME_LEN_EXPIRES;
- extern inkapi int INK_MIME_LEN_FOLLOWUP_TO;
- extern inkapi int INK_MIME_LEN_FROM;
- extern inkapi int INK_MIME_LEN_HOST;
- extern inkapi int INK_MIME_LEN_IF_MATCH;
- extern inkapi int INK_MIME_LEN_IF_MODIFIED_SINCE;
- extern inkapi int INK_MIME_LEN_IF_NONE_MATCH;
- extern inkapi int INK_MIME_LEN_IF_RANGE;
- extern inkapi int INK_MIME_LEN_IF_UNMODIFIED_SINCE;
- extern inkapi int INK_MIME_LEN_KEEP_ALIVE;
- extern inkapi int INK_MIME_LEN_KEYWORDS;
- extern inkapi int INK_MIME_LEN_LAST_MODIFIED;
- extern inkapi int INK_MIME_LEN_LINES;
- extern inkapi int INK_MIME_LEN_LOCATION;
- extern inkapi int INK_MIME_LEN_MAX_FORWARDS;
- extern inkapi int INK_MIME_LEN_MESSAGE_ID;
- extern inkapi int INK_MIME_LEN_NEWSGROUPS;
- extern inkapi int INK_MIME_LEN_ORGANIZATION;
- extern inkapi int INK_MIME_LEN_PATH;
- extern inkapi int INK_MIME_LEN_PRAGMA;
- extern inkapi int INK_MIME_LEN_PROXY_AUTHENTICATE;
- extern inkapi int INK_MIME_LEN_PROXY_AUTHORIZATION;
- extern inkapi int INK_MIME_LEN_PROXY_CONNECTION;
- extern inkapi int INK_MIME_LEN_PUBLIC;
- extern inkapi int INK_MIME_LEN_RANGE;
- extern inkapi int INK_MIME_LEN_REFERENCES;
- extern inkapi int INK_MIME_LEN_REFERER;
- extern inkapi int INK_MIME_LEN_REPLY_TO;
- extern inkapi int INK_MIME_LEN_RETRY_AFTER;
- extern inkapi int INK_MIME_LEN_SENDER;
- extern inkapi int INK_MIME_LEN_SERVER;
- extern inkapi int INK_MIME_LEN_SET_COOKIE;
- extern inkapi int INK_MIME_LEN_SUBJECT;
- extern inkapi int INK_MIME_LEN_SUMMARY;
- extern inkapi int INK_MIME_LEN_TE;
- extern inkapi int INK_MIME_LEN_TRANSFER_ENCODING;
- extern inkapi int INK_MIME_LEN_UPGRADE;
- extern inkapi int INK_MIME_LEN_USER_AGENT;
- extern inkapi int INK_MIME_LEN_VARY;
- extern inkapi int INK_MIME_LEN_VIA;
- extern inkapi int INK_MIME_LEN_WARNING;
- extern inkapi int INK_MIME_LEN_WWW_AUTHENTICATE;
- extern inkapi int INK_MIME_LEN_XREF;
- extern inkapi int INK_MIME_LEN_X_FORWARDED_FOR;
+ extern tsapi int TS_MIME_LEN_ACCEPT;
+ extern tsapi int TS_MIME_LEN_ACCEPT_CHARSET;
+ extern tsapi int TS_MIME_LEN_ACCEPT_ENCODING;
+ extern tsapi int TS_MIME_LEN_ACCEPT_LANGUAGE;
+ extern tsapi int TS_MIME_LEN_ACCEPT_RANGES;
+ extern tsapi int TS_MIME_LEN_AGE;
+ extern tsapi int TS_MIME_LEN_ALLOW;
+ extern tsapi int TS_MIME_LEN_APPROVED;
+ extern tsapi int TS_MIME_LEN_AUTHORIZATION;
+ extern tsapi int TS_MIME_LEN_BYTES;
+ extern tsapi int TS_MIME_LEN_CACHE_CONTROL;
+ extern tsapi int TS_MIME_LEN_CLIENT_IP;
+ extern tsapi int TS_MIME_LEN_CONNECTION;
+ extern tsapi int TS_MIME_LEN_CONTENT_BASE;
+ extern tsapi int TS_MIME_LEN_CONTENT_ENCODING;
+ extern tsapi int TS_MIME_LEN_CONTENT_LANGUAGE;
+ extern tsapi int TS_MIME_LEN_CONTENT_LENGTH;
+ extern tsapi int TS_MIME_LEN_CONTENT_LOCATION;
+ extern tsapi int TS_MIME_LEN_CONTENT_MD5;
+ extern tsapi int TS_MIME_LEN_CONTENT_RANGE;
+ extern tsapi int TS_MIME_LEN_CONTENT_TYPE;
+ extern tsapi int TS_MIME_LEN_CONTROL;
+ extern tsapi int TS_MIME_LEN_COOKIE;
+ extern tsapi int TS_MIME_LEN_DATE;
+ extern tsapi int TS_MIME_LEN_DISTRIBUTION;
+ extern tsapi int TS_MIME_LEN_ETAG;
+ extern tsapi int TS_MIME_LEN_EXPECT;
+ extern tsapi int TS_MIME_LEN_EXPIRES;
+ extern tsapi int TS_MIME_LEN_FOLLOWUP_TO;
+ extern tsapi int TS_MIME_LEN_FROM;
+ extern tsapi int TS_MIME_LEN_HOST;
+ extern tsapi int TS_MIME_LEN_IF_MATCH;
+ extern tsapi int TS_MIME_LEN_IF_MODIFIED_SINCE;
+ extern tsapi int TS_MIME_LEN_IF_NONE_MATCH;
+ extern tsapi int TS_MIME_LEN_IF_RANGE;
+ extern tsapi int TS_MIME_LEN_IF_UNMODIFIED_SINCE;
+ extern tsapi int TS_MIME_LEN_KEEP_ALIVE;
+ extern tsapi int TS_MIME_LEN_KEYWORDS;
+ extern tsapi int TS_MIME_LEN_LAST_MODIFIED;
+ extern tsapi int TS_MIME_LEN_LINES;
+ extern tsapi int TS_MIME_LEN_LOCATION;
+ extern tsapi int TS_MIME_LEN_MAX_FORWARDS;
+ extern tsapi int TS_MIME_LEN_MESSAGE_ID;
+ extern tsapi int TS_MIME_LEN_NEWSGROUPS;
+ extern tsapi int TS_MIME_LEN_ORGANIZATION;
+ extern tsapi int TS_MIME_LEN_PATH;
+ extern tsapi int TS_MIME_LEN_PRAGMA;
+ extern tsapi int TS_MIME_LEN_PROXY_AUTHENTICATE;
+ extern tsapi int TS_MIME_LEN_PROXY_AUTHORIZATION;
+ extern tsapi int TS_MIME_LEN_PROXY_CONNECTION;
+ extern tsapi int TS_MIME_LEN_PUBLIC;
+ extern tsapi int TS_MIME_LEN_RANGE;
+ extern tsapi int TS_MIME_LEN_REFERENCES;
+ extern tsapi int TS_MIME_LEN_REFERER;
+ extern tsapi int TS_MIME_LEN_REPLY_TO;
+ extern tsapi int TS_MIME_LEN_RETRY_AFTER;
+ extern tsapi int TS_MIME_LEN_SENDER;
+ extern tsapi int TS_MIME_LEN_SERVER;
+ extern tsapi int TS_MIME_LEN_SET_COOKIE;
+ extern tsapi int TS_MIME_LEN_SUBJECT;
+ extern tsapi int TS_MIME_LEN_SUMMARY;
+ extern tsapi int TS_MIME_LEN_TE;
+ extern tsapi int TS_MIME_LEN_TRANSFER_ENCODING;
+ extern tsapi int TS_MIME_LEN_UPGRADE;
+ extern tsapi int TS_MIME_LEN_USER_AGENT;
+ extern tsapi int TS_MIME_LEN_VARY;
+ extern tsapi int TS_MIME_LEN_VIA;
+ extern tsapi int TS_MIME_LEN_WARNING;
+ extern tsapi int TS_MIME_LEN_WWW_AUTHENTICATE;
+ extern tsapi int TS_MIME_LEN_XREF;
+ extern tsapi int TS_MIME_LEN_X_FORWARDED_FOR;
/* --------------------------------------------------------------------------
HTTP values */
- extern inkapi const char *INK_HTTP_VALUE_BYTES;
- extern inkapi const char *INK_HTTP_VALUE_CHUNKED;
- extern inkapi const char *INK_HTTP_VALUE_CLOSE;
- extern inkapi const char *INK_HTTP_VALUE_COMPRESS;
- extern inkapi const char *INK_HTTP_VALUE_DEFLATE;
- extern inkapi const char *INK_HTTP_VALUE_GZIP;
- extern inkapi const char *INK_HTTP_VALUE_IDENTITY;
- extern inkapi const char *INK_HTTP_VALUE_KEEP_ALIVE;
- extern inkapi const char *INK_HTTP_VALUE_MAX_AGE;
- extern inkapi const char *INK_HTTP_VALUE_MAX_STALE;
- extern inkapi const char *INK_HTTP_VALUE_MIN_FRESH;
- extern inkapi const char *INK_HTTP_VALUE_MUST_REVALIDATE;
- extern inkapi const char *INK_HTTP_VALUE_NONE;
- extern inkapi const char *INK_HTTP_VALUE_NO_CACHE;
- extern inkapi const char *INK_HTTP_VALUE_NO_STORE;
- extern inkapi const char *INK_HTTP_VALUE_NO_TRANSFORM;
- extern inkapi const char *INK_HTTP_VALUE_ONLY_IF_CACHED;
- extern inkapi const char *INK_HTTP_VALUE_PRIVATE;
- extern inkapi const char *INK_HTTP_VALUE_PROXY_REVALIDATE;
- extern inkapi const char *INK_HTTP_VALUE_PUBLIC;
+ extern tsapi const char *TS_HTTP_VALUE_BYTES;
+ extern tsapi const char *TS_HTTP_VALUE_CHUNKED;
+ extern tsapi const char *TS_HTTP_VALUE_CLOSE;
+ extern tsapi const char *TS_HTTP_VALUE_COMPRESS;
+ extern tsapi const char *TS_HTTP_VALUE_DEFLATE;
+ extern tsapi const char *TS_HTTP_VALUE_GZIP;
+ extern tsapi const char *TS_HTTP_VALUE_IDENTITY;
+ extern tsapi const char *TS_HTTP_VALUE_KEEP_ALIVE;
+ extern tsapi const char *TS_HTTP_VALUE_MAX_AGE;
+ extern tsapi const char *TS_HTTP_VALUE_MAX_STALE;
+ extern tsapi const char *TS_HTTP_VALUE_MIN_FRESH;
+ extern tsapi const char *TS_HTTP_VALUE_MUST_REVALIDATE;
+ extern tsapi const char *TS_HTTP_VALUE_NONE;
+ extern tsapi const char *TS_HTTP_VALUE_NO_CACHE;
+ extern tsapi const char *TS_HTTP_VALUE_NO_STORE;
+ extern tsapi const char *TS_HTTP_VALUE_NO_TRANSFORM;
+ extern tsapi const char *TS_HTTP_VALUE_ONLY_IF_CACHED;
+ extern tsapi const char *TS_HTTP_VALUE_PRIVATE;
+ extern tsapi const char *TS_HTTP_VALUE_PROXY_REVALIDATE;
+ extern tsapi const char *TS_HTTP_VALUE_PUBLIC;
/* --------------------------------------------------------------------------
HTTP values string lengths */
- extern inkapi int INK_HTTP_LEN_BYTES;
- extern inkapi int INK_HTTP_LEN_CHUNKED;
- extern inkapi int INK_HTTP_LEN_CLOSE;
- extern inkapi int INK_HTTP_LEN_COMPRESS;
- extern inkapi int INK_HTTP_LEN_DEFLATE;
- extern inkapi int INK_HTTP_LEN_GZIP;
- extern inkapi int INK_HTTP_LEN_IDENTITY;
- extern inkapi int INK_HTTP_LEN_KEEP_ALIVE;
- extern inkapi int INK_HTTP_LEN_MAX_AGE;
- extern inkapi int INK_HTTP_LEN_MAX_STALE;
- extern inkapi int INK_HTTP_LEN_MIN_FRESH;
- extern inkapi int INK_HTTP_LEN_MUST_REVALIDATE;
- extern inkapi int INK_HTTP_LEN_NONE;
- extern inkapi int INK_HTTP_LEN_NO_CACHE;
- extern inkapi int INK_HTTP_LEN_NO_STORE;
- extern inkapi int INK_HTTP_LEN_NO_TRANSFORM;
- extern inkapi int INK_HTTP_LEN_ONLY_IF_CACHED;
- extern inkapi int INK_HTTP_LEN_PRIVATE;
- extern inkapi int INK_HTTP_LEN_PROXY_REVALIDATE;
- extern inkapi int INK_HTTP_LEN_PUBLIC;
+ extern tsapi int TS_HTTP_LEN_BYTES;
+ extern tsapi int TS_HTTP_LEN_CHUNKED;
+ extern tsapi int TS_HTTP_LEN_CLOSE;
+ extern tsapi int TS_HTTP_LEN_COMPRESS;
+ extern tsapi int TS_HTTP_LEN_DEFLATE;
+ extern tsapi int TS_HTTP_LEN_GZIP;
+ extern tsapi int TS_HTTP_LEN_IDENTITY;
+ extern tsapi int TS_HTTP_LEN_KEEP_ALIVE;
+ extern tsapi int TS_HTTP_LEN_MAX_AGE;
+ extern tsapi int TS_HTTP_LEN_MAX_STALE;
+ extern tsapi int TS_HTTP_LEN_MIN_FRESH;
+ extern tsapi int TS_HTTP_LEN_MUST_REVALIDATE;
+ extern tsapi int TS_HTTP_LEN_NONE;
+ extern tsapi int TS_HTTP_LEN_NO_CACHE;
+ extern tsapi int TS_HTTP_LEN_NO_STORE;
+ extern tsapi int TS_HTTP_LEN_NO_TRANSFORM;
+ extern tsapi int TS_HTTP_LEN_ONLY_IF_CACHED;
+ extern tsapi int TS_HTTP_LEN_PRIVATE;
+ extern tsapi int TS_HTTP_LEN_PROXY_REVALIDATE;
+ extern tsapi int TS_HTTP_LEN_PUBLIC;
/* --------------------------------------------------------------------------
HTTP methods */
- extern inkapi const char *INK_HTTP_METHOD_CONNECT;
- extern inkapi const char *INK_HTTP_METHOD_DELETE;
- extern inkapi const char *INK_HTTP_METHOD_GET;
- extern inkapi const char *INK_HTTP_METHOD_HEAD;
- extern inkapi const char *INK_HTTP_METHOD_ICP_QUERY;
- extern inkapi const char *INK_HTTP_METHOD_OPTIONS;
- extern inkapi const char *INK_HTTP_METHOD_POST;
- extern inkapi const char *INK_HTTP_METHOD_PURGE;
- extern inkapi const char *INK_HTTP_METHOD_PUT;
- extern inkapi const char *INK_HTTP_METHOD_TRACE;
+ extern tsapi const char *TS_HTTP_METHOD_CONNECT;
+ extern tsapi const char *TS_HTTP_METHOD_DELETE;
+ extern tsapi const char *TS_HTTP_METHOD_GET;
+ extern tsapi const char *TS_HTTP_METHOD_HEAD;
+ extern tsapi const char *TS_HTTP_METHOD_ICP_QUERY;
+ extern tsapi const char *TS_HTTP_METHOD_OPTIONS;
+ extern tsapi const char *TS_HTTP_METHOD_POST;
+ extern tsapi const char *TS_HTTP_METHOD_PURGE;
+ extern tsapi const char *TS_HTTP_METHOD_PUT;
+ extern tsapi const char *TS_HTTP_METHOD_TRACE;
/* --------------------------------------------------------------------------
HTTP methods string lengths */
- extern inkapi int INK_HTTP_LEN_CONNECT;
- extern inkapi int INK_HTTP_LEN_DELETE;
- extern inkapi int INK_HTTP_LEN_GET;
- extern inkapi int INK_HTTP_LEN_HEAD;
- extern inkapi int INK_HTTP_LEN_ICP_QUERY;
- extern inkapi int INK_HTTP_LEN_OPTIONS;
- extern inkapi int INK_HTTP_LEN_POST;
- extern inkapi int INK_HTTP_LEN_PURGE;
- extern inkapi int INK_HTTP_LEN_PUT;
- extern inkapi int INK_HTTP_LEN_TRACE;
+ extern tsapi int TS_HTTP_LEN_CONNECT;
+ extern tsapi int TS_HTTP_LEN_DELETE;
+ extern tsapi int TS_HTTP_LEN_GET;
+ extern tsapi int TS_HTTP_LEN_HEAD;
+ extern tsapi int TS_HTTP_LEN_ICP_QUERY;
+ extern tsapi int TS_HTTP_LEN_OPTIONS;
+ extern tsapi int TS_HTTP_LEN_POST;
+ extern tsapi int TS_HTTP_LEN_PURGE;
+ extern tsapi int TS_HTTP_LEN_PUT;
+ extern tsapi int TS_HTTP_LEN_TRACE;
/* --------------------------------------------------------------------------
MLoc Constants */
/**
- Use INK_NULL_MLOC as the parent in calls that require a parent
- when an INKMLoc does not have a parent INKMLoc. For example if
- the INKMLoc is obtained by a call to INKHttpTxnClientReqGet(),
+ Use TS_NULL_MLOC as the parent in calls that require a parent
+ when an TSMLoc does not have a parent TSMLoc. For example if
+ the TSMLoc is obtained by a call to TSHttpTxnClientReqGet(),
*/
- extern inkapi const INKMLoc INK_NULL_MLOC;
+ extern tsapi const TSMLoc TS_NULL_MLOC;
/* --------------------------------------------------------------------------
Memory */
-#define INKmalloc(s) _INKmalloc ((s), INK_RES_MEM_PATH)
-#define INKrealloc(p,s) _INKrealloc ((p), (s), INK_RES_MEM_PATH)
-#define INKstrdup(p) _INKstrdup ((p), -1, INK_RES_MEM_PATH)
-#define INKstrndup(p,n) _INKstrdup ((p), (n), INK_RES_MEM_PATH)
-#define INKfree(p) _INKfree (p)
-
- inkapi void *_INKmalloc(size_t size, const char *path);
- inkapi void *_INKrealloc(void *ptr, size_t size, const char *path);
- inkapi char *_INKstrdup(const char *str, int64 length, const char *path);
- inkapi void _INKfree(void *ptr);
+#define TSmalloc(s) _TSmalloc ((s), TS_RES_MEM_PATH)
+#define TSrealloc(p,s) _TSrealloc ((p), (s), TS_RES_MEM_PATH)
+#define TSstrdup(p) _TSstrdup ((p), -1, TS_RES_MEM_PATH)
+#define TSstrndup(p,n) _TSstrdup ((p), (n), TS_RES_MEM_PATH)
+#define TSfree(p) _TSfree (p)
+
+ tsapi void *_TSmalloc(size_t size, const char *path);
+ tsapi void *_TSrealloc(void *ptr, size_t size, const char *path);
+ tsapi char *_TSstrdup(const char *str, int64 length, const char *path);
+ tsapi void _TSfree(void *ptr);
/* --------------------------------------------------------------------------
Component object handles */
/**
- Releases the INKMLoc mloc created from the INKMLoc parent.
- If there is no parent INKMLoc, use INK_NULL_MLOC.
+ Releases the TSMLoc mloc created from the TSMLoc parent.
+ If there is no parent TSMLoc, use TS_NULL_MLOC.
- @param bufp marshal buffer containing the INKMLoc handle to be
+ @param bufp marshal buffer containing the TSMLoc handle to be
released.
@param parent location of the parent object from which the handle
was created.
@param mloc location of the handle to be released.
*/
- inkapi INKReturnCode INKHandleMLocRelease(INKMBuffer bufp, INKMLoc parent, INKMLoc mloc);
+ tsapi TSReturnCode TSHandleMLocRelease(TSMBuffer bufp, TSMLoc parent, TSMLoc mloc);
/**
- Releases the string str created from the INKMLoc parent. Do not use
- INKHandleStringRelease() for strings created by INKUrlStringGet();
- in that special case, free the string with INKfree().
+ Releases the string str created from the TSMLoc parent. Do not use
+ TSHandleStringRelease() for strings created by TSUrlStringGet();
+ in that special case, free the string with TSfree().
@param bufp marshal buffer containing the string to be released.
@param parent location of the parent object from which the string
@@ -850,7 +842,7 @@ extern "C"
@param str pointer to the string to be released.
*/
- inkapi INKReturnCode INKHandleStringRelease(INKMBuffer bufp, INKMLoc parent, const char *str);
+ tsapi TSReturnCode TSHandleStringRelease(TSMBuffer bufp, TSMLoc parent, const char *str);
/* --------------------------------------------------------------------------
Install and plugin locations */
@@ -862,7 +854,7 @@ extern "C"
@return pointer to Traffic Server install directory.
*/
- inkapi const char *INKInstallDirGet(void);
+ tsapi const char *TSInstallDirGet(void);
/**
Gets the path of the directory of Traffic Server configuration.
@@ -870,7 +862,7 @@ extern "C"
@return pointer to Traffic Server configuration directory.
*/
- inkapi const char *INKConfigDirGet(void);
+ tsapi const char *TSConfigDirGet(void);
/**
Gets the path of the plugin directory relative to the Traffic Server
@@ -878,14 +870,14 @@ extern "C"
the plugin directory:
@code
- INKfopen("INKPluginInstallDirGet()/INKPluginDirGet()/config_ui.txt");
+ TSfopen("TSPluginInstallDirGet()/TSPluginDirGet()/config_ui.txt");
@endcode
@return pointer to plugin directory relative to Traffic Server install
directory.
*/
- inkapi const char *INKPluginDirGet(void);
+ tsapi const char *TSPluginDirGet(void);
/* --------------------------------------------------------------------------
Traffic Server Version */
@@ -897,7 +889,7 @@ extern "C"
@return pointer to version of Traffic Server running the plugin.
*/
- inkapi const char *INKTrafficServerVersionGet(void);
+ tsapi const char *TSTrafficServerVersionGet(void);
/* --------------------------------------------------------------------------
Plugin registration */
@@ -911,12 +903,12 @@ extern "C"
@param sdk_version earliest version of the Traffic Server SDK that
supports your plugin.
@param plugin_info contains registration information about your
- plugin. See INKPluginRegistrationInfo.
+ plugin. See TSPluginRegistrationInfo.
@return 0 if the plugin registration failed.
*/
- inkapi int INKPluginRegister(INKSDKVersion sdk_version, INKPluginRegistrationInfo * plugin_info);
- inkapi INKReturnCode INKPluginInfoRegister(INKPluginRegistrationInfo * plugin_info);
+ tsapi int TSPluginRegister(TSSDKVersion sdk_version, TSPluginRegistrationInfo * plugin_info);
+ tsapi TSReturnCode TSPluginInfoRegister(TSPluginRegistrationInfo * plugin_info);
/* --------------------------------------------------------------------------
Files */
@@ -931,11 +923,11 @@ extern "C"
writing. If mode is "r" then the file is opened for reading.
If mode is "w" then the file is opened for writing. Currently
"r" and "w" are the only two valid modes for opening a file.
- @return descriptor for the file that INKfopen opens. Descriptors of
- type INKFile can be greater than 256.
+ @return descriptor for the file that TSfopen opens. Descriptors of
+ type TSFile can be greater than 256.
*/
- inkapi INKFile INKfopen(const char *filename, const char *mode);
+ tsapi TSFile TSfopen(const char *filename, const char *mode);
/**
Closes the file to which filep points and frees the data structures
@@ -945,7 +937,7 @@ extern "C"
@param filep file to be closed.
*/
- inkapi void INKfclose(INKFile filep);
+ tsapi void TSfclose(TSFile filep);
/**
Attempts to read length bytes of data from the file pointed to by
@@ -959,12 +951,12 @@ extern "C"
while reading the file, it returns -1.
*/
- inkapi size_t INKfread(INKFile filep, void *buf, size_t length);
+ tsapi size_t TSfread(TSFile filep, void *buf, size_t length);
/**
Attempts to write length bytes of data from the buffer buf
to the file filep. Make sure that filep is open for writing.
- You might want to check the number of bytes written (INKfwrite()
+ You might want to check the number of bytes written (TSfwrite()
returns this value) against the value of length. If it is less,
there might be insufficient space on disk, for example.
@@ -976,16 +968,16 @@ extern "C"
writing, it returns the number of bytes successfully written.
*/
- inkapi size_t INKfwrite(INKFile filep, const void *buf, size_t length);
+ tsapi size_t TSfwrite(TSFile filep, const void *buf, size_t length);
/**
Flushes pending data that has been buffered up in memory from
- previous calls to INKfwrite().
+ previous calls to TSfwrite().
@param filep file to flush.
*/
- inkapi void INKfflush(INKFile filep);
+ tsapi void TSfflush(TSFile filep);
/**
Reads a line from the file pointed to by filep into the buffer buf.
@@ -1000,13 +992,13 @@ extern "C"
@return pointer to the string read into the buffer buf.
*/
- inkapi char *INKfgets(INKFile filep, char *buf, size_t length);
+ tsapi char *TSfgets(TSFile filep, char *buf, size_t length);
/* --------------------------------------------------------------------------
Error logging */
/**
Writes printf-style error messages to the Traffic Server error
- log. One advantage of INKError over printf is that each call is
+ log. One advantage of TSError over printf is that each call is
atomically placed into the error log and is not garbled with other
error entries. This is not an issue in single-threaded programs
but is a definite nuisance in multi-threaded programs.
@@ -1015,18 +1007,18 @@ extern "C"
@param ... argument for the printf format description.
*/
- inkapi void INKError(const char *fmt, ...);
+ tsapi void TSError(const char *fmt, ...);
/* --------------------------------------------------------------------------
Assertions */
- inkapi int _INKReleaseAssert(const char *txt, const char *f, int l);
- inkapi int _INKAssert(const char *txt, const char *f, int l);
+ tsapi int _TSReleaseAssert(const char *txt, const char *f, int l);
+ tsapi int _TSAssert(const char *txt, const char *f, int l);
-#define INKReleaseAssert(EX) \
- (void)((EX) || (_INKReleaseAssert(#EX, __FILE__, __LINE__)))
+#define TSReleaseAssert(EX) \
+ (void)((EX) || (_TSReleaseAssert(#EX, __FILE__, __LINE__)))
-#define INKAssert(EX) \
- (void)((EX) || (_INKAssert(#EX, __FILE__, __LINE__)))
+#define TSAssert(EX) \
+ (void)((EX) || (_TSAssert(#EX, __FILE__, __LINE__)))
/* --------------------------------------------------------------------------
Marshal buffers */
@@ -1035,7 +1027,7 @@ extern "C"
to 1.
*/
- inkapi INKMBuffer INKMBufferCreate(void);
+ tsapi TSMBuffer TSMBufferCreate(void);
/**
Ignores the reference count and destroys the marshal buffer bufp.
@@ -1045,7 +1037,7 @@ extern "C"
@param bufp marshal buffer to be destroyed.
*/
- inkapi INKReturnCode INKMBufferDestroy(INKMBuffer bufp);
+ tsapi TSReturnCode TSMBufferDestroy(TSMBuffer bufp);
/* --------------------------------------------------------------------------
URLs */
@@ -1057,25 +1049,25 @@ extern "C"
@return location of the created URL.
*/
- inkapi INKMLoc INKUrlCreate(INKMBuffer bufp);
+ tsapi TSMLoc TSUrlCreate(TSMBuffer bufp);
/**
Destroys the URL located at url_loc within the marshal buffer
- bufp. Do not forget to release the INKMLoc url_loc with a call
- to INKHandleMLocRelease().
+ bufp. Do not forget to release the TSMLoc url_loc with a call
+ to TSHandleMLocRelease().
@param bufp marshal buffer containing the URL to be destroyed.
@param offset location of the URL to be destroyed.
*/
- inkapi INKReturnCode INKUrlDestroy(INKMBuffer bufp, INKMLoc offset);
+ tsapi TSReturnCode TSUrlDestroy(TSMBuffer bufp, TSMLoc offset);
/**
Copies the URL located at src_url within src_bufp to a URL
location within the marshal buffer dest_bufp, and returns the
- INKMLoc location of the copied URL. Unlike INKUrlCopy(), you do
+ TSMLoc location of the copied URL. Unlike TSUrlCopy(), you do
not have to create the destination URL before cloning. Release
- the returned INKMLoc handle with a call to INKHandleMLocRelease().
+ the returned TSMLoc handle with a call to TSHandleMLocRelease().
@param dest_bufp marshal buffer containing the cloned URL.
@param src_bufp marshal buffer containing the URL to be cloned.
@@ -1084,14 +1076,14 @@ extern "C"
@return location of the newly created URL.
*/
- inkapi INKMLoc INKUrlClone(INKMBuffer dest_bufp, INKMBuffer src_bufp, INKMLoc src_url);
+ tsapi TSMLoc TSUrlClone(TSMBuffer dest_bufp, TSMBuffer src_bufp, TSMLoc src_url);
/**
Copies the contents of the URL at lcoation src_loc within the
marshal buffer src_bufp to the location dest_loc within the marshal
- buffer dest_bufp. INKUrlCopy() works correctly even if src_bufp
+ buffer dest_bufp. TSUrlCopy() works correctly even if src_bufp
and dest_bufp point to different marshal buffers. Important: create
- the destination URL before copying into it. Use INKUrlCreate().
+ the destination URL before copying into it. Use TSUrlCreate().
@param dest_bufp marshal buffer to contain the copied URL.
@param dest_offset location of the URL to be copied.
@@ -1099,17 +1091,17 @@ extern "C"
@param src_offset location of the source URL within src_bufp.
*/
- inkapi INKReturnCode INKUrlCopy(INKMBuffer dest_bufp, INKMLoc dest_offset, INKMBuffer src_bufp, INKMLoc src_offset);
+ tsapi TSReturnCode TSUrlCopy(TSMBuffer dest_bufp, TSMLoc dest_offset, TSMBuffer src_bufp, TSMLoc src_offset);
/**
- Formats a URL stored in an INKMBuffer into an INKIOBuffer.
+ Formats a URL stored in an TSMBuffer into an TSIOBuffer.
@param bufp marshal buffer contain the URL to be printed.
@param offset location of the URL within bufp.
- @param iobufp destination INKIOBuffer for the URL.
+ @param iobufp destination TSIOBuffer for the URL.
*/
- inkapi INKReturnCode INKUrlPrint(INKMBuffer bufp, INKMLoc offset, INKIOBuffer iobufp);
+ tsapi TSReturnCode TSUrlPrint(TSMBuffer bufp, TSMLoc offset, TSIOBuffer iobufp);
/**
Parses a URL. The start pointer is both an input and an output
@@ -1118,38 +1110,38 @@ extern "C"
The end pointer must be one byte after the last character you
want to parse. The URL parsing routine assumes that everything
between start and end is part of the URL. It is up to higher level
- parsing routines, such as INKHttpHdrParseReq(), to determine the
- actual end of the URL. Returns INK_PARSE_ERROR if an error occurs,
- otherwise INK_PARSE_DONE is returned to indicate success.
+ parsing routines, such as TSHttpHdrParseReq(), to determine the
+ actual end of the URL. Returns TS_PARSE_ERROR if an error occurs,
+ otherwise TS_PARSE_DONE is returned to indicate success.
@param bufp marshal buffer containing the URL to be parsed.
@param offset location of the URL to be parsed.
@param start points to the start of the URL to be parsed AND at
the end of a successful parse it will equal the end pointer.
@param end must be one byte after the last character.
- @return INK_PARSE_ERROR or INK_PARSE_DONE.
+ @return TS_PARSE_ERROR or TS_PARSE_DONE.
*/
- inkapi int INKUrlParse(INKMBuffer bufp, INKMLoc offset, const char **start, const char *end);
+ tsapi int TSUrlParse(TSMBuffer bufp, TSMLoc offset, const char **start, const char *end);
/**
Calculates the length of the URL located at url_loc within the
marshal buffer bufp if it were returned as a string. This length
- is the same as the length returned by INKUrlStringGet().
+ is the same as the length returned by TSUrlStringGet().
@param bufp marshal buffer containing the URL whose length you want.
@param offset location of the URL within the marshal buffer bufp.
@return string length of the URL.
*/
- inkapi int INKUrlLengthGet(INKMBuffer bufp, INKMLoc offset);
+ tsapi int TSUrlLengthGet(TSMBuffer bufp, TSMLoc offset);
/**
Constructs a string representation of the URL located at url_loc
- within bufp. INKUrlStringGet() stores the length of the allocated
+ within bufp. TSUrlStringGet() stores the length of the allocated
string in the parameter length. This is the same length that
- INKUrlLengthGet() returns. The returned string is allocated by a
- call to INKmalloc(). It should be freed by a call to INKfree().
+ TSUrlLengthGet() returns. The returned string is allocated by a
+ call to TSmalloc(). It should be freed by a call to TSfree().
If length is NULL then no attempt is made to dereference it.
@param bufp marshal buffer containing the URL you want to get.
@@ -1158,11 +1150,11 @@ extern "C"
@return The URL as a string.
*/
- inkapi char *INKUrlStringGet(INKMBuffer bufp, INKMLoc offset, int *length);
+ tsapi char *TSUrlStringGet(TSMBuffer bufp, TSMLoc offset, int *length);
/**
Retrieves the scheme portion of the URL located at url_loc within
- the marshal buffer bufp. INKUrlSchemeGet() places the length of
+ the marshal buffer bufp. TSUrlSchemeGet() places the length of
the string in the length argument. If the length is NULL then no
attempt is made to dereference it.
@@ -1172,15 +1164,15 @@ extern "C"
@return The scheme portion of the URL, as a string.
*/
- inkapi const char *INKUrlSchemeGet(INKMBuffer bufp, INKMLoc offset, int *length);
+ tsapi const char *TSUrlSchemeGet(TSMBuffer bufp, TSMLoc offset, int *length);
/**
Sets the scheme portion of the URL located at url_loc within
the marshal buffer bufp to the string value. If length is -1
- then INKUrlSchemeSet() assumes that value is null-terminated.
+ then TSUrlSchemeSet() assumes that value is null-terminated.
Otherwise, the length of the string value is taken to be length.
- INKUrlSchemeSet() copies the string to within bufp, so it is OK
- to modify or delete value after calling INKUrlSchemeSet().
+ TSUrlSchemeSet() copies the string to within bufp, so it is OK
+ to modify or delete value after calling TSUrlSchemeSet().
@param bufp marshal buffer containing the URL.
@param offset location of the URL.
@@ -1188,7 +1180,7 @@ extern "C"
@param length string stored in value.
*/
- inkapi INKReturnCode INKUrlSchemeSet(INKMBuffer bufp, INKMLoc offset, const char *value, int length);
+ tsapi TSReturnCode TSUrlSchemeSet(TSMBuffer bufp, TSMLoc offset, const char *value, int length);
/* --------------------------------------------------------------------------
Internet specific URLs */
@@ -1196,7 +1188,7 @@ extern "C"
Retrieves the user portion of the URL located at url_loc
within bufp. Note: the returned string is not guaranteed to
be null-terminated. Release the returned string with a call to
- INKHandleStringRelease().
+ TSHandleStringRelease().
@param bufp marshal buffer containing the URL.
@param offset location of the URL.
@@ -1204,15 +1196,15 @@ extern "C"
@return user portion of the URL.
*/
- inkapi const char *INKUrlUserGet(INKMBuffer bufp, INKMLoc offset, int *length);
+ tsapi const char *TSUrlUserGet(TSMBuffer bufp, TSMLoc offset, int *length);
/**
Sets the user portion of the URL located at url_loc within bufp
- to the string value. If length is -1 then INKUrlUserSet() assumes
+ to the string value. If length is -1 then TSUrlUserSet() assumes
that value is null-terminated. Otherwise, the length of the string
- value is taken to be length. INKUrlUserSet() copies the string to
+ value is taken to be length. TSUrlUserSet() copies the string to
within bufp, so it is OK to modify or delete value after calling
- INKUrlUserSet().
+ TSUrlUserSet().
@param bufp marshal buffer containing the URL.
@param offset location of the URL whose user is to be set.
@@ -1220,14 +1212,14 @@ extern "C"
@param length string length of value.
*/
- inkapi INKReturnCode INKUrlUserSet(INKMBuffer bufp, INKMLoc offset, const char *value, int length);
+ tsapi TSReturnCode TSUrlUserSet(TSMBuffer bufp, TSMLoc offset, const char *value, int length);
/**
Retrieves the password portion of the URL located at url_loc
- within bufp. INKUrlPasswordGet() places the length of the returned
+ within bufp. TSUrlPasswordGet() places the length of the returned
string in the length argument. Note: the returned string is
not guaranteed to be null-terminated. Release with a call to
- INKHandleStringRelease().
+ TSHandleStringRelease().
@param bufp marshal buffer containing the URL.
@param offset
@@ -1235,15 +1227,15 @@ extern "C"
@return password portion of the URL.
*/
- inkapi const char *INKUrlPasswordGet(INKMBuffer bufp, INKMLoc offset, int *length);
+ tsapi const char *TSUrlPasswordGet(TSMBuffer bufp, TSMLoc offset, int *length);
/**
Sets the password portion of the URL located at url_loc within
- bufp to the string value. If length is -1 then INKUrlPasswordSet()
+ bufp to the string value. If length is -1 then TSUrlPasswordSet()
assumes that value is null-terminated. Otherwise, the length
- of value is taken to be length. INKUrlPasswordSet() copies the
+ of value is taken to be length. TSUrlPasswordSet() copies the
string to within bufp, so it is okay to modify or delete value
- after calling INKUrlPasswordSet().
+ after calling TSUrlPasswordSet().
@param bufp marshal buffer containing the URL.
@param offset
@@ -1251,12 +1243,12 @@ extern "C"
@param length of the new password.
*/
- inkapi INKReturnCode INKUrlPasswordSet(INKMBuffer bufp, INKMLoc offset, const char *value, int length);
+ tsapi TSReturnCode TSUrlPasswordSet(TSMBuffer bufp, TSMLoc offset, const char *value, int length);
/**
Retrieves the host portion of the URL located at url_loc
within bufp. Note: the returned string is not guaranteed to be
- null-terminated. Release with a call to INKHandleStringRelease().
+ null-terminated. Release with a call to TSHandleStringRelease().
@param bufp marshal buffer containing the URL.
@param offset location of the URL.
@@ -1264,14 +1256,14 @@ extern "C"
@return Host portion of the URL.
*/
- inkapi const char *INKUrlHostGet(INKMBuffer bufp, INKMLoc offset, int *length);
+ tsapi const char *TSUrlHostGet(TSMBuffer bufp, TSMLoc offset, int *length);
/**
Sets the host portion of the URL at url_loc to the string value.
- If length is -1 then INKUrlHostSet() assumes that value is
+ If length is -1 then TSUrlHostSet() assumes that value is
null-terminated. Otherwise, the length of the string value is
taken to be length. The string is copied to within bufp, so you
- can modify or delete value after calling INKUrlHostSet().
+ can modify or delete value after calling TSUrlHostSet().
@param bufp marshal buffer containing the URL to modify.
@param offset location of the URL.
@@ -1279,7 +1271,7 @@ extern "C"
@param length string length of the new host name of the URL.
*/
- inkapi INKReturnCode INKUrlHostSet(INKMBuffer bufp, INKMLoc offset, const char *value, int length);
+ tsapi TSReturnCode TSUrlHostSet(TSMBuffer bufp, TSMLoc offset, const char *value, int length);
/**
Retrieves the port portion of the URL located at url_loc.
@@ -1289,7 +1281,7 @@ extern "C"
@return port portion of the URL.
*/
- inkapi int INKUrlPortGet(INKMBuffer bufp, INKMLoc offset);
+ tsapi int TSUrlPortGet(TSMBuffer bufp, TSMLoc offset);
/**
Sets the port portion of the URL located at url_loc.
@@ -1299,15 +1291,15 @@ extern "C"
@param port new port setting for the URL.
*/
- inkapi INKReturnCode INKUrlPortSet(INKMBuffer bufp, INKMLoc offset, int port);
+ tsapi TSReturnCode TSUrlPortSet(TSMBuffer bufp, TSMLoc offset, int port);
/* --------------------------------------------------------------------------
HTTP specific URLs */
/**
Retrieves the path portion of the URL located at url_loc within
- bufp. INKUrlPathGet() places the length of the returned string in
+ bufp. TSUrlPathGet() places the length of the returned string in
the length argument. Note: the returned string is not guaranteed to
- be null-terminated. Release with a call to INKHandleStringRelease().
+ be null-terminated. Release with a call to TSHandleStringRelease().
@param bufp marshal buffer containing the URL.
@param offset location of the URL.
@@ -1315,14 +1307,14 @@ extern "C"
@return path portion of the URL.
*/
- inkapi const char *INKUrlPathGet(INKMBuffer bufp, INKMLoc offset, int *length);
+ tsapi const char *TSUrlPathGet(TSMBuffer bufp, TSMLoc offset, int *length);
/**
Sets the path portion of the URL located at url_loc within bufp
- to the string value. If length is -1 then INKUrlPathSet() assumes
+ to the string value. If length is -1 then TSUrlPathSet() assumes
that value is null-terminated. Otherwise, the length of the value
- is taken to be length. INKUrlPathSet() copies the string into bufp,
- so you can modify or delete value after calling INKUrlPathSet().
+ is taken to be length. TSUrlPathSet() copies the string into bufp,
+ so you can modify or delete value after calling TSUrlPathSet().
@param bufp marshal buffer containing the URL.
@param offset location of the URL.
@@ -1330,7 +1322,7 @@ extern "C"
@param length of the new path string.
*/
- inkapi INKReturnCode INKUrlPathSet(INKMBuffer bufp, INKMLoc offset, const char *value, int length);
+ tsapi TSReturnCode TSUrlPathSet(TSMBuffer bufp, TSMLoc offset, const char *value, int length);
/* --------------------------------------------------------------------------
FTP specific URLs */
@@ -1342,7 +1334,7 @@ extern "C"
@return FTP type of the URL.
*/
- inkapi int INKUrlFtpTypeGet(INKMBuffer bufp, INKMLoc offset);
+ tsapi int TSUrlFtpTypeGet(TSMBuffer bufp, TSMLoc offset);
/**
Sets the FTP type portion of the URL located at url_loc within
@@ -1353,7 +1345,7 @@ extern "C"
@param type new FTP type for the URL.
*/
- inkapi INKReturnCode INKUrlFtpTypeSet(INKMBuffer bufp, INKMLoc offset, int type);
+ tsapi TSReturnCode TSUrlFtpTypeSet(TSMBuffer bufp, TSMLoc offset, int type);
/* --------------------------------------------------------------------------
HTTP specific URLs */
@@ -1361,7 +1353,7 @@ extern "C"
Retrieves the HTTP params portion of the URL located at url_loc
within bufp. The length of the returned string is in the length
argument. Note: the returned string is not guaranteed to be
- null-terminated. Release with a call to INKHandleStringRelease().
+ null-terminated. Release with a call to TSHandleStringRelease().
@param bufp marshal buffer containing the URL.
@param offset location of the URL.
@@ -1369,15 +1361,15 @@ extern "C"
@return HTTP params portion of the URL.
*/
- inkapi const char *INKUrlHttpParamsGet(INKMBuffer bufp, INKMLoc offset, int *length);
+ tsapi const char *TSUrlHttpParamsGet(TSMBuffer bufp, TSMLoc offset, int *length);
/**
Sets the HTTP params portion of the URL located at url_loc within
- bufp to the string value. If length is -1 that INKUrlHttpParamsSet()
+ bufp to the string value. If length is -1 that TSUrlHttpParamsSet()
assumes that value is null-terminated. Otherwise, the length of
- the string value is taken to be length. INKUrlHttpParamsSet()
+ the string value is taken to be length. TSUrlHttpParamsSet()
copies the string to within bufp, so you can modify or delete
- value after calling INKUrlHttpParamsSet().
+ value after calling TSUrlHttpParamsSet().
@param bufp marshal buffer containing the URL.
@param offset location of the URL.
@@ -1385,13 +1377,13 @@ extern "C"
@param length string length of the new HTTP params value.
*/
- inkapi INKReturnCode INKUrlHttpParamsSet(INKMBuffer bufp, INKMLoc offset, const char *value, int length);
+ tsapi TSReturnCode TSUrlHttpParamsSet(TSMBuffer bufp, TSMLoc offset, const char *value, int length);
/**
Retrieves the HTTP query portion of the URL located at url_loc
within bufp. The length of the returned string is in the length
argument. Note: the returned string is not guaranteed to be
- null-terminated. Release with a call to INKHandleStringRelease().
+ null-terminated. Release with a call to TSHandleStringRelease().
@param bufp marshal buffer containing the URL.
@param offset location of the URL.
@@ -1399,14 +1391,14 @@ extern "C"
@return HTTP query portion of the URL.
*/
- inkapi const char *INKUrlHttpQueryGet(INKMBuffer bufp, INKMLoc offset, int *length);
+ tsapi const char *TSUrlHttpQueryGet(TSMBuffer bufp, TSMLoc offset, int *length);
/**
Sets the HTTP query portion of the URL located at url_loc within
bufp to value. If length is -1, the string value is assumed to
be null-terminated; otherwise, the length of value is taken to be
- length. INKUrlHttpQuerySet() copies the string to within bufp, so
- you can modify or delete value after calling INKUrlHttpQuerySet().
+ length. TSUrlHttpQuerySet() copies the string to within bufp, so
+ you can modify or delete value after calling TSUrlHttpQuerySet().
@param bufp marshal buffer containing the URL.
@param offset location of the URL within bufp.
@@ -1414,13 +1406,13 @@ extern "C"
@param length of the new HTTP query string.
*/
- inkapi INKReturnCode INKUrlHttpQuerySet(INKMBuffer bufp, INKMLoc offset, const char *value, int length);
+ tsapi TSReturnCode TSUrlHttpQuerySet(TSMBuffer bufp, TSMLoc offset, const char *value, int length);
/**
Retrieves the HTTP fragment portion of the URL located at url_loc
within bufp. The length of the returned string is in the length
argument. Note: the returned string is not guaranteed to be
- null-terminated. Release with a call to INKHandleStringRelease().
+ null-terminated. Release with a call to TSHandleStringRelease().
@param bufp marshal buffer containing the URL.
@param offset location of the URL.
@@ -1428,15 +1420,15 @@ extern "C"
@return HTTP fragment portion of the URL.
*/
- inkapi const char *INKUrlHttpFragmentGet(INKMBuffer bufp, INKMLoc offset, int *length);
+ tsapi const char *TSUrlHttpFragmentGet(TSMBuffer bufp, TSMLoc offset, int *length);
/**
Sets the HTTP fragment portion of the URL located at url_loc
within bufp to value. If length is -1, the string value is
assumed to be null-terminated; otherwise, the length of value
- is taken to be length. INKUrlHttpFragmentSet() copies the string
+ is taken to be length. TSUrlHttpFragmentSet() copies the string
to within bufp, so you can modify or delete value after calling
- INKUrlHttpFragmentSet().
+ TSUrlHttpFragmentSet().
@param bufp marshal buffer containing the URL.
@param offset location of the URL within bufp.
@@ -1444,7 +1436,7 @@ extern "C"
@param length of the new HTTP query string.
*/
- inkapi INKReturnCode INKUrlHttpFragmentSet(INKMBuffer bufp, INKMLoc offset, const char *value, int length);
+ tsapi TSReturnCode TSUrlHttpFragmentSet(TSMBuffer bufp, TSMLoc offset, const char *value, int length);
/* --------------------------------------------------------------------------
MIME headers */
@@ -1454,10 +1446,10 @@ extern "C"
information about the header being parsed. A single MIME
parser can be used multiple times, though not simultaneously.
Before being used again, the parser must be cleared by calling
- INKMimeParserClear().
+ TSMimeParserClear().
*/
- inkapi INKMimeParser INKMimeParserCreate(void);
+ tsapi TSMimeParser TSMimeParserCreate(void);
/**
Clears the specified MIME parser so that it can be used again.
@@ -1465,24 +1457,24 @@ extern "C"
@param parser to be cleared.
*/
- inkapi INKReturnCode INKMimeParserClear(INKMimeParser parser);
+ tsapi TSReturnCode TSMimeParserClear(TSMimeParser parser);
/**
Destroys the specified MIME parser and frees the associated memory.
@param parser to destroy.
*/
- inkapi INKReturnCode INKMimeParserDestroy(INKMimeParser parser);
+ tsapi TSReturnCode TSMimeParserDestroy(TSMimeParser parser);
/**
Creates a new MIME header within bufp. Release with a call to
- INKHandleMLocRelease().
+ TSHandleMLocRelease().
@param bufp marshal buffer to contain the new MIME header.
@return location of the new MIME header within bufp.
*/
- inkapi INKMLoc INKMimeHdrCreate(INKMBuffer bufp);
+ tsapi TSMLoc TSMimeHdrCreate(TSMBuffer bufp);
/**
Destroys the MIME header located at hdr_loc within bufp.
@@ -1491,14 +1483,14 @@ extern "C"
@param offset location of the MIME header.
*/
- inkapi INKReturnCode INKMimeHdrDestroy(INKMBuffer bufp, INKMLoc offset);
+ tsapi TSReturnCode TSMimeHdrDestroy(TSMBuffer bufp, TSMLoc offset);
/**
Copies a specified MIME header to a specified marshal buffer,
and returns the location of the copied MIME header within the
- destination marshal buffer. Unlike INKMimeHdrCopy(), you do not
+ destination marshal buffer. Unlike TSMimeHdrCopy(), you do not
have to create the destination MIME header before cloning. Release
- the returned INKMLoc handle with a call to INKHandleMLocRelease().
+ the returned TSMLoc handle with a call to TSHandleMLocRelease().
@param dest_bufp destination marshal buffer.
@param src_bufp source marshal buffer.
@@ -1506,15 +1498,15 @@ extern "C"
@return location of the copied MIME header.
*/
- inkapi INKMLoc INKMimeHdrClone(INKMBuffer dest_bufp, INKMBuffer src_bufp, INKMLoc src_hdr);
+ tsapi TSMLoc TSMimeHdrClone(TSMBuffer dest_bufp, TSMBuffer src_bufp, TSMLoc src_hdr);
/**
Copies the contents of the MIME header located at src_loc
within src_bufp to the MIME header located at dest_loc within
- dest_bufp. INKMimeHdrCopy() works correctly even if src_bufp and
+ dest_bufp. TSMimeHdrCopy() works correctly even if src_bufp and
dest_bufp point to different marshal buffers. Important: you must
create the destination MIME header before copying into it--use
- INKMimeHdrCreate().
+ TSMimeHdrCreate().
@param dest_bufp is the destination marshal buffer.
@param dest_offset
@@ -1522,27 +1514,27 @@ extern "C"
@param src_offset
*/
- inkapi INKReturnCode INKMimeHdrCopy(INKMBuffer dest_bufp, INKMLoc dest_offset, INKMBuffer src_bufp,
- INKMLoc src_offset);
+ tsapi TSReturnCode TSMimeHdrCopy(TSMBuffer dest_bufp, TSMLoc dest_offset, TSMBuffer src_bufp,
+ TSMLoc src_offset);
/**
Formats the MIME header located at hdr_loc within bufp into the
- INKIOBuffer iobufp.
+ TSIOBuffer iobufp.
@param bufp marshal buffer containing the header to be copied to
- an INKIOBuffer.
+ an TSIOBuffer.
@param offset
- @param iobufp target INKIOBuffer.
+ @param iobufp target TSIOBuffer.
*/
- inkapi INKReturnCode INKMimeHdrPrint(INKMBuffer bufp, INKMLoc offset, INKIOBuffer iobufp);
+ tsapi TSReturnCode TSMimeHdrPrint(TSMBuffer bufp, TSMLoc offset, TSIOBuffer iobufp);
/**
Parses a MIME header. The MIME header must have already been
allocated and both bufp and hdr_loc must point within that header.
It is possible to parse a MIME header a single byte at a time
- using repeated calls to INKMimeHdrParse(). As long as an error
- does not occur, INKMimeHdrParse() consumes each single byte and
+ using repeated calls to TSMimeHdrParse(). As long as an error
+ does not occur, TSMimeHdrParse() consumes each single byte and
asks for more.
@param parser parses the specified MIME header.
@@ -1554,14 +1546,14 @@ extern "C"
character parsed.
@param end points to one byte after the end of the buffer.
@return One of 3 possible int values:
- - INK_PARSE_ERROR if there is a parsing error.
- - INK_PARSE_DONE is returned when a "\r\n\r\n" pattern is
+ - TS_PARSE_ERROR if there is a parsing error.
+ - TS_PARSE_DONE is returned when a "\r\n\r\n" pattern is
encountered, indicating the end of the header.
- - INK_PARSE_CONT is returned if parsing of the header stopped
+ - TS_PARSE_CONT is returned if parsing of the header stopped
because the end of the buffer was reached.
*/
- inkapi int INKMimeHdrParse(INKMimeParser parser, INKMBuffer bufp, INKMLoc offset, const char **start,
+ tsapi int TSMimeHdrParse(TSMimeParser parser, TSMBuffer bufp, TSMLoc offset, const char **start,
const char *end);
/**
@@ -1574,20 +1566,20 @@ extern "C"
@return string length of the MIME header located at hdr_loc.
*/
- inkapi int INKMimeHdrLengthGet(INKMBuffer bufp, INKMLoc offset);
+ tsapi int TSMimeHdrLengthGet(TSMBuffer bufp, TSMLoc offset);
/**
Removes and destroys all the MIME fields within the MIME header
located at hdr_loc within the marshal buffer bufp. Important:
do not forget to release any corresponding MIME field string
- values or INKMLoc handles using INKHandleStringRelease() or
- INKHandleMLocRelease().
+ values or TSMLoc handles using TSHandleStringRelease() or
+ TSHandleMLocRelease().
@param bufp marshal buffer containing the MIME header.
@param offset location of the MIME header.
*/
- inkapi INKReturnCode INKMimeHdrFieldsClear(INKMBuffer bufp, INKMLoc offset);
+ tsapi TSReturnCode TSMimeHdrFieldsClear(TSMBuffer bufp, TSMLoc offset);
/**
Returns a count of the number of MIME fields within the MIME header
@@ -1599,15 +1591,15 @@ extern "C"
at hdr_loc.
*/
- inkapi int INKMimeHdrFieldsCount(INKMBuffer bufp, INKMLoc offset);
+ tsapi int TSMimeHdrFieldsCount(TSMBuffer bufp, TSMLoc offset);
/**
Retrieves the location of a specified MIME field within the
MIME header located at hdr_loc within bufp. The idx parameter
specifies which field to retrieve. The fields are numbered from 0
- to INKMimeHdrFieldsCount(bufp, hdr_loc) - 1. If idx does not lie
- within that range then INKMimeHdrFieldGet returns 0. Release the
- returned handle with a call to INKHandleMLocRelease.
+ to TSMimeHdrFieldsCount(bufp, hdr_loc) - 1. If idx does not lie
+ within that range then TSMimeHdrFieldGet returns 0. Release the
+ returned handle with a call to TSHandleMLocRelease.
@param bufp marshal buffer containing the MIME header.
@param hdr location of the MIME header.
@@ -1615,16 +1607,16 @@ extern "C"
@return location of the specified MIME field.
*/
- inkapi INKMLoc INKMimeHdrFieldGet(INKMBuffer bufp, INKMLoc hdr, int idx);
+ tsapi TSMLoc TSMimeHdrFieldGet(TSMBuffer bufp, TSMLoc hdr, int idx);
/**
- Retrieves the INKMLoc location of a specfied MIME field from within
+ Retrieves the TSMLoc location of a specfied MIME field from within
the MIME header located at hdr. The name and length parameters
specify which field to retrieve. For each MIME field in the MIME
header, a case insensitive string comparison is done between
- the field name and name. If INKMimeHdrFieldFind() cannot find the
- requested field, it returns 0. Release the returned INKMLoc handle
- with a call to INKHandleMLocRelease().
+ the field name and name. If TSMimeHdrFieldFind() cannot find the
+ requested field, it returns 0. Release the returned TSMLoc handle
+ with a call to TSHandleMLocRelease().
[... 1478 lines stripped ...]