1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
|
/** @file
This header file defines common types that can be shared
between internal code and TS APIs.
@section license 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.
@section developers Developers
Developers, when adding a new element to an enum, append it. DO NOT
insert it. Otherwise, binary compatibility of plugins will be broken!
*/
#ifndef __TS_APIDEFS_H__
#define __TS_APIDEFS_H__
/*
* ATS Plugin just needs to include <ts/ts.h>,
* should not include this file directly!
*
*/
/* GENERATED FILE WARNING! DO NOT EDIT apidefs.h
*
* You must modify apidefs.h.in instead.
*
*/
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>
#include <sys/socket.h>
#ifndef tsapi
#define tsapi
#endif
#if !defined(TS_PRINTFLIKE)
#if defined(__GNUC__) || defined(__clang__)
#define TS_PRINTFLIKE(fmt, arg) __attribute__((format(printf, fmt, arg)))
#else
#define TS_PRINTFLIKE(fmt, arg)
#endif
#endif
#if !defined(TS_NORETURN)
#if defined(__GNUC__) || defined(__clang__)
#define TS_NORETURN __attribute__((noreturn))
#else
#define TS_NORETURN
#endif
#endif
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/* Version info
*/
/* clang-format off */
#define TS_VERSION_STRING "@TS_VERSION_STRING@"
#define TS_VERSION_NUMBER @TS_VERSION_NUMBER@
#define TS_VERSION_MAJOR @TS_VERSION_MAJOR@
#define TS_VERSION_MINOR @TS_VERSION_MINOR@
#define TS_VERSION_MICRO @TS_VERSION_MICRO@
/* clang-format on */
#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)
#ifndef TS_RES_MEM_PATH
#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/")
#endif
#define TS_MAX_USER_NAME_LEN 256
#ifndef TS_DEPRECATED
#define TS_DEPRECATED __attribute__((deprecated))
#endif
/**
The following struct is used by TSPluginRegister(). It stores
registration information about the plugin.
*/
typedef struct {
char *plugin_name;
char *vendor_name;
char *support_email;
} TSPluginRegistrationInfo;
/**
This set of enums are possible values returned by
TSHttpHdrParseReq() and TSHttpHdrParseResp().
*/
typedef enum { 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 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 { TS_HTTP_TYPE_UNKNOWN, TS_HTTP_TYPE_REQUEST, TS_HTTP_TYPE_RESPONSE } TSHttpType;
/**
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().
*/
typedef enum {
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
} 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:
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_VCONN_PRE_ACCEPT_HOOK - Called before the SSL hand
shake starts. No handshake data has been read or sent (from the
proxy) at this point
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 {
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,
// Putting the SSL hooks in the same enum space
// So both sets of hooks can be set by the same Hook function
TS_SSL_FIRST_HOOK,
TS_VCONN_PRE_ACCEPT_HOOK = TS_SSL_FIRST_HOOK,
TS_SSL_SNI_HOOK,
TS_SSL_CERT_HOOK = TS_SSL_SNI_HOOK,
TS_SSL_LAST_HOOK = TS_SSL_CERT_HOOK,
TS_HTTP_LAST_HOOK
} TSHttpHookID;
#define TS_HTTP_READ_REQUEST_PRE_REMAP_HOOK TS_HTTP_PRE_REMAP_HOOK /* backwards compat */
/** 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 @c 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.
*/
typedef enum {
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
} TSLifecycleHookID;
/**
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 {
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_VCONN_ACTIVE_TIMEOUT = 106,
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_VCONN_PRE_ACCEPT = 60023,
TS_EVENT_MGMT_UPDATE = 60100,
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 {
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 {
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 {
TS_CACHE_LOOKUP_MISS,
TS_CACHE_LOOKUP_HIT_STALE,
TS_CACHE_LOOKUP_HIT_FRESH,
TS_CACHE_LOOKUP_SKIPPED
} TSCacheLookupResult;
typedef enum { TS_CACHE_DATA_TYPE_NONE, TS_CACHE_DATA_TYPE_HTTP, TS_CACHE_DATA_TYPE_OTHER } TSCacheDataType;
typedef enum { TS_CACHE_ERROR_NO_DOC = -20400, TS_CACHE_ERROR_DOC_BUSY = -20401, TS_CACHE_ERROR_NOT_READY = -20407 } TSCacheError;
typedef enum {
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 {
TS_TXN_INFO_NONE = -1,
TS_TXN_INFO_CACHE_HIT_RAM,
TS_TXN_INFO_CACHE_COMPRESSED_IN_RAM,
TS_TXN_INFO_CACHE_HIT_RWW, // READ_WHILE_WRITE
TS_TXN_INFO_CACHE_OPEN_READ_TRIES,
TS_TXN_INFO_CACHE_OPEN_WRITE_TRIES,
TS_TXN_INFO_CACHE_VOLUME,
TS_TXN_INFO_LAST_ENTRY
} TSHttpTxnInfoKey;
typedef enum { TS_VC_CLOSE_ABORT = -1, TS_VC_CLOSE_NORMAL = 1 } TSVConnCloseFlags;
typedef enum {
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,
TS_IOBUFFER_SIZE_INDEX_64K = 9,
TS_IOBUFFER_SIZE_INDEX_128K = 10,
TS_IOBUFFER_SIZE_INDEX_256K = 11,
TS_IOBUFFER_SIZE_INDEX_512K = 12,
TS_IOBUFFER_SIZE_INDEX_1M = 13,
TS_IOBUFFER_SIZE_INDEX_2M = 14
} TSIOBufferSizeIndex;
typedef enum { TS_ERROR = -1, TS_SUCCESS = 0 } TSReturnCode;
typedef enum { NO_CALLBACK = 0, AFTER_HEADER, AFTER_BODY } TSFetchWakeUpOptions;
#ifndef _HTTP_PROXY_API_ENUMS_H_
#define _HTTP_PROXY_API_ENUMS_H_
/// Server session sharing values - match
/// Must be identical to definition in HttpProxyAPIEnums.h
typedef enum {
TS_SERVER_SESSION_SHARING_MATCH_NONE,
TS_SERVER_SESSION_SHARING_MATCH_BOTH,
TS_SERVER_SESSION_SHARING_MATCH_IP,
TS_SERVER_SESSION_SHARING_MATCH_HOST
} TSServerSessionSharingMatchType;
/// Server session sharing values - pool
/// Must be identical to definition in HttpProxyAPIEnums.h
typedef enum { TS_SERVER_SESSION_SHARING_POOL_GLOBAL, TS_SERVER_SESSION_SHARING_POOL_THREAD } TSServerSessionSharingPoolType;
#endif
/* librecords types */
/* The values of this enum must match enum RecT in I_RecDefs.h */
typedef enum {
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
} TSRecordType;
/* The values of this enum must match enum RecDataT in I_RecDefs.h */
typedef enum {
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
} TSRecordDataType;
typedef union {
int64_t rec_int;
float rec_float;
char *rec_string;
int64_t rec_counter;
} TSRecordData;
/* The values of this enum must match enum RecPersistT in I_RecDefs.h */
typedef enum { TS_RECORDP_NULL, TS_RECORDP_PERSISTENT, TS_RECORDP_NON_PERSISTENT } TSRecordPersistType;
/* The values of this enum must match enum RecUpdateT in I_RecDefs.h */
typedef enum {
TS_RECORDUPDATE_NULL,
TS_RECORDUPDATE_DYNAMIC,
TS_RECORDUPDATE_RESTART_TS,
TS_RECORDUPDATE_RESTART_TM,
TS_RECORDUPDATE_RESTART_TC
} TSRecordUpdateType;
/* The values of this enum must match enum RecCheckT in I_RecDefs.h */
typedef enum { TS_RECORDCHECK_NULL, TS_RECORDCHECK_STR, TS_RECORDCHECK_INT, TS_RECORDCHECK_IP } TSRecordCheckType;
/* The values of this enum must match enum RecModeT in I_RecDefs.h */
typedef enum { TS_RECORDMODE_NULL, TS_RECORDMODE_CLIENT, TS_RECORDMODE_SERVER, TS_RECORDMODE_STAND_ALONE } TSRecordModeType;
/* The values of this enum must match enum RecAccessT in I_RecDefs.h */
typedef enum { TS_RECORDACCESS_NULL, TS_RECORDACCESS_NO_ACCESS, TS_RECORDACCESS_READ_ONLY } TSRecordAccessType;
typedef enum {
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_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_HTTP_AUTH_SERVER_SESSION_PRIVATE,
TS_CONFIG_HTTP_SLOW_LOG_THRESHOLD,
TS_CONFIG_HTTP_CACHE_GENERATION,
TS_CONFIG_BODY_FACTORY_TEMPLATE_BASE,
TS_CONFIG_HTTP_CACHE_OPEN_WRITE_FAIL_ACTION,
TS_CONFIG_HTTP_ENABLE_REDIRECTION,
TS_CONFIG_HTTP_NUMBER_OF_REDIRECTIONS,
TS_CONFIG_HTTP_CACHE_MAX_OPEN_WRITE_RETRIES,
TS_CONFIG_HTTP_REDIRECT_USE_ORIG_CACHE_KEY,
TS_CONFIG_HTTP_ATTACH_SERVER_SESSION_TO_CLIENT,
TS_CONFIG_HTTP_ORIGIN_MAX_CONNECTIONS_QUEUE,
TS_CONFIG_WEBSOCKET_NO_ACTIVITY_TIMEOUT,
TS_CONFIG_WEBSOCKET_ACTIVE_TIMEOUT,
TS_CONFIG_HTTP_UNCACHEABLE_REQUESTS_BYPASS_PARENT,
TS_CONFIG_HTTP_PARENT_PROXY_TOTAL_CONNECT_ATTEMPTS,
TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_IN,
TS_CONFIG_LAST_ENTRY
} TSOverridableConfigKey;
/* The TASK pool of threads is the primary method of off-loading continuations from the
net-threads. Configure this with proxy.config.task_threads in records.config. */
typedef enum {
TS_THREAD_POOL_DEFAULT = -1,
TS_THREAD_POOL_NET,
TS_THREAD_POOL_TASK,
/* unlikely you should use these */
TS_THREAD_POOL_SSL,
TS_THREAD_POOL_DNS,
TS_THREAD_POOL_REMAP,
TS_THREAD_POOL_CLUSTER,
TS_THREAD_POOL_UDP
} TSThreadPool;
typedef int64_t TSHRTime;
/* The TSMilestonesType is an enum defining all the various milestones ("timers") that
we track for a request. */
typedef enum {
TS_MILESTONE_NULL = -1,
TS_MILESTONE_UA_BEGIN,
TS_MILESTONE_UA_FIRST_READ,
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_PLUGIN_ACTIVE,
TS_MILESTONE_PLUGIN_TOTAL,
TS_MILESTONE_LAST_ENTRY
} TSMilestonesType;
/// Operation requested by asynchronous hooks during SSL processing
typedef enum {
TS_SSL_HOOK_OP_DEFAULT, ///< Null / initialization value. Do normal processing.
TS_SSL_HOOK_OP_TUNNEL, ///< Switch to blind tunnel
TS_SSL_HOOK_OP_TERMINATE, ///< Termination connection / transaction.
TS_SSL_HOOK_OP_LAST = TS_SSL_HOOK_OP_TERMINATE ///< End marker value.
} TSSslVConnOp;
/* These typedefs are used with the corresponding TSMgmt*Get functions
for storing the values retrieved by those functions. For example,
TSMgmtCounterGet() retrieves an TSMgmtCounter. */
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_ssl_obj *TSSslConnection;
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; /* a VConn is really a specialized TSCont */
typedef struct tsapi_ssl_context *TSSslContext;
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 {
int success_event_id;
int failure_event_id;
int timeout_event_id;
} TSFetchEvent;
typedef struct TSFetchUrlParams {
const char *request;
int request_len;
struct sockaddr_storage ip;
int port;
TSCont contp;
TSFetchEvent events;
TSFetchWakeUpOptions options;
struct TSFetchUrlParams *next;
} TSFetchUrlParams_t;
/* --------------------------------------------------------------------------
Init */
/**
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.
@param 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.
@param 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.
*/
extern tsapi void TSPluginInit(int argc, const char *argv[]);
/* --------------------------------------------------------------------------
URL schemes */
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_TUNNEL;
extern tsapi const char *TS_URL_SCHEME_WAIS;
extern tsapi const char *TS_URL_SCHEME_PNM;
extern tsapi const char *TS_URL_SCHEME_RTSP;
extern tsapi const char *TS_URL_SCHEME_RTSPU;
extern tsapi const char *TS_URL_SCHEME_MMS;
extern tsapi const char *TS_URL_SCHEME_MMSU;
extern tsapi const char *TS_URL_SCHEME_MMST;
/* --------------------------------------------------------------------------
URL scheme string lengths */
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 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_STRICT_TRANSPORT_SECURITY;
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 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_STRICT_TRANSPORT_SECURITY;
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 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 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 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;
extern tsapi const char *TS_HTTP_METHOD_PUSH;
/* --------------------------------------------------------------------------
HTTP methods string lengths */
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;
extern tsapi int TS_HTTP_LEN_PUSH;
/* --------------------------------------------------------------------------
TLS Next Protocol well-known protocol names. */
extern tsapi const char *const TS_NPN_PROTOCOL_HTTP_0_9;
extern tsapi const char *const TS_NPN_PROTOCOL_HTTP_1_0;
extern tsapi const char *const TS_NPN_PROTOCOL_HTTP_1_1;
extern tsapi const char *const TS_NPN_PROTOCOL_HTTP_2_0_14;
extern tsapi const char *const TS_NPN_PROTOCOL_HTTP_2_0;
extern tsapi const char *const TS_NPN_PROTOCOL_SPDY_1;
extern tsapi const char *const TS_NPN_PROTOCOL_SPDY_2;
extern tsapi const char *const TS_NPN_PROTOCOL_SPDY_3;
extern tsapi const char *const TS_NPN_PROTOCOL_SPDY_3_1;
extern tsapi int TS_NPN_PROTOCOL_INDEX_HTTP_0_9;
extern tsapi int TS_NPN_PROTOCOL_INDEX_HTTP_1_0;
extern tsapi int TS_NPN_PROTOCOL_INDEX_HTTP_1_1;
extern tsapi int TS_NPN_PROTOCOL_INDEX_SPDY_1;
extern tsapi int TS_NPN_PROTOCOL_INDEX_SPDY_2;
extern tsapi int TS_NPN_PROTOCOL_INDEX_SPDY_3;
extern tsapi int TS_NPN_PROTOCOL_INDEX_SPDY_3_1;
extern tsapi int TS_NPN_PROTOCOL_INDEX_HTTP_2_0;
extern tsapi const char *const TS_NPN_PROTOCOL_GROUP_HTTP;
extern tsapi const char *const TS_NPN_PROTOCOL_GROUP_HTTP2;
extern tsapi const char *const TS_NPN_PROTOCOL_GROUP_SPDY;
/* --------------------------------------------------------------------------
MLoc Constants */
/**
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 tsapi const TSMLoc TS_NULL_MLOC;
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __TS_APIDEFS_H__ */
|