trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jpe...@apache.org
Subject [22/51] trafficserver git commit: Documentation reorganization
Date Tue, 03 Nov 2015 06:09:58 GMT
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSLookingUpType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSLookingUpType.en.rst b/doc/developer-guide/api/types/TSLookingUpType.en.rst
new file mode 100644
index 0000000..169bc0a
--- /dev/null
+++ b/doc/developer-guide/api/types/TSLookingUpType.en.rst
@@ -0,0 +1,48 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSLookingUpType
+***************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSLookingUpType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSLookingUpType TS_LOOKUP_UNDEFINED_LOOKUP
+
+.. c:member:: TSLookingUpType TS_LOOKUP_ICP_SUGGESTED_HOST
+
+.. c:member:: TSLookingUpType TS_LOOKUP_PARENT_PROXY
+
+.. c:member:: TSLookingUpType TS_LOOKUP_ORIGIN_SERVER
+
+.. c:member:: TSLookingUpType TS_LOOKUP_INCOMING_ROUTER
+
+.. c:member:: TSLookingUpType TS_LOOKUP_HOST_NONE
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSMilestonesType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSMilestonesType.en.rst b/doc/developer-guide/api/types/TSMilestonesType.en.rst
new file mode 100644
index 0000000..ff5aaaf
--- /dev/null
+++ b/doc/developer-guide/api/types/TSMilestonesType.en.rst
@@ -0,0 +1,78 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSMiletonesType
+***************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSMiletonesType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSMiletonesType TS_MILESTONE_NULL
+
+.. c:member:: TSMiletonesType TS_MILESTONE_UA_BEGIN
+
+.. c:member:: TSMiletonesType TS_MILESTONE_UA_READ_HEADER_DONE
+
+.. c:member:: TSMiletonesType TS_MILESTONE_UA_BEGIN_WRITE
+
+.. c:member:: TSMiletonesType TS_MILESTONE_UA_CLOSE
+
+.. c:member:: TSMiletonesType TS_MILESTONE_SERVER_FIRST_CONNECT
+
+.. c:member:: TSMiletonesType TS_MILESTONE_SERVER_CONNECT
+
+.. c:member:: TSMiletonesType TS_MILESTONE_SERVER_CONNECT_END
+
+.. c:member:: TSMiletonesType TS_MILESTONE_SERVER_BEGIN_WRITE
+
+.. c:member:: TSMiletonesType TS_MILESTONE_SERVER_FIRST_READ
+
+.. c:member:: TSMiletonesType TS_MILESTONE_SERVER_READ_HEADER_DONE
+
+.. c:member:: TSMiletonesType TS_MILESTONE_SERVER_CLOSE
+
+.. c:member:: TSMiletonesType TS_MILESTONE_CACHE_OPEN_READ_BEGIN
+
+.. c:member:: TSMiletonesType TS_MILESTONE_CACHE_OPEN_READ_END
+
+.. c:member:: TSMiletonesType TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN
+
+.. c:member:: TSMiletonesType TS_MILESTONE_CACHE_OPEN_WRITE_END
+
+.. c:member:: TSMiletonesType TS_MILESTONE_DNS_LOOKUP_BEGIN
+
+.. c:member:: TSMiletonesType TS_MILESTONE_DNS_LOOKUP_END
+
+.. c:member:: TSMiletonesType TS_MILESTONE_SM_START
+
+.. c:member:: TSMiletonesType TS_MILESTONE_SM_FINISH
+
+.. c:member:: TSMiletonesType TS_MILESTONE_LAST_ENTRY
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst b/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
new file mode 100644
index 0000000..abe1045
--- /dev/null
+++ b/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
@@ -0,0 +1,212 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSOverridableConfigKey
+**********************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSOverridableConfigKey
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_NULL
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_URL_REMAP_PRISTINE_HOST_HDR
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CHUNKING_ENABLED
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_NEGATIVE_CACHING_ENABLED
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_NEGATIVE_CACHING_LIFETIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_WHEN_TO_REVALIDATE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_IN
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_KEEP_ALIVE_ENABLED_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_KEEP_ALIVE_POST_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_SHARE_SERVER_SESSIONS, // DEPRECATED
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_SERVER_SESSION_SHARING_POOL
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_SERVER_SESSION_SHARING_MATCH
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_NET_SOCK_RECV_BUFFER_SIZE_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_NET_SOCK_SEND_BUFFER_SIZE_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_NET_SOCK_OPTION_FLAG_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_FORWARD_PROXY_AUTH_TO_PARENT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_ANONYMIZE_REMOVE_FROM
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_ANONYMIZE_REMOVE_REFERER
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_ANONYMIZE_REMOVE_USER_AGENT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_ANONYMIZE_REMOVE_COOKIE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_ANONYMIZE_REMOVE_CLIENT_IP
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_ANONYMIZE_INSERT_CLIENT_IP
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_RESPONSE_SERVER_ENABLED
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_INSERT_SQUID_X_FORWARDED_FOR
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_SERVER_TCP_INIT_CWND
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_SEND_HTTP11_REQUESTS
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_HTTP
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_CLUSTER_CACHE_LOCAL
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_NO_CACHE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_IGNORE_CLIENT_CC_MAX_AGE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_IMS_ON_CLIENT_NO_CACHE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_IGNORE_SERVER_NO_CACHE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_CACHE_RESPONSES_TO_COOKIES
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_IGNORE_AUTHENTICATION
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_CACHE_URLS_THAT_LOOK_DYNAMIC
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_REQUIRED_HEADERS
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_INSERT_REQUEST_VIA_STR
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_INSERT_RESPONSE_VIA_STR
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_HEURISTIC_MIN_LIFETIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_HEURISTIC_MAX_LIFETIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_GUARANTEED_MIN_LIFETIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_GUARANTEED_MAX_LIFETIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_MAX_STALE_AGE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_IN
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_KEEP_ALIVE_NO_ACTIVITY_TIMEOUT_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_IN
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_TRANSACTION_NO_ACTIVITY_TIMEOUT_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_TRANSACTION_ACTIVE_TIMEOUT_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_ORIGIN_MAX_CONNECTIONS
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CONNECT_ATTEMPTS_MAX_RETRIES_DEAD_SERVER
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CONNECT_ATTEMPTS_RR_RETRIES
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CONNECT_ATTEMPTS_TIMEOUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_POST_CONNECT_ATTEMPTS_TIMEOUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_DOWN_SERVER_CACHE_TIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_DOWN_SERVER_ABORT_THRESHOLD
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_FUZZ_TIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_FUZZ_MIN_TIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_DOC_IN_CACHE_SKIP_DNS
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_BACKGROUND_FILL_ACTIVE_TIMEOUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_RESPONSE_SERVER_STR
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_HEURISTIC_LM_FACTOR
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_FUZZ_PROBABILITY
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_BACKGROUND_FILL_COMPLETED_THRESHOLD
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_NET_SOCK_PACKET_MARK_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_NET_SOCK_PACKET_TOS_OUT
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_INSERT_AGE_IN_RESPONSE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CHUNKING_SIZE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_FLOW_CONTROL_LOW_WATER_MARK
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER_MARK
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_RANGE_LOOKUP
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_NORMALIZE_AE_GZIP
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_DEFAULT_BUFFER_SIZE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_DEFAULT_BUFFER_WATER_MARK
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_REQUEST_HEADER_MAX_SIZE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_RESPONSE_HEADER_MAX_SIZE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_ENABLED
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_NEGATIVE_REVALIDATING_LIFETIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_ACCEPT_ENCODING_FILTER_ENABLED
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_SSL_HSTS_MAX_AGE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_SSL_HSTS_INCLUDE_SUBDOMAINS
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_OPEN_READ_RETRY_TIME
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_MAX_OPEN_READ_RETRIES
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_CACHE_RANGE_WRITE
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_POST_CHECK_CONTENT_LENGTH_ENABLED
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_HTTP_GLOBAL_USER_AGENT_HEADER
+
+.. c:member:: TSOverridableConfigKey TS_CONFIG_LAST_ENTRY
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSParseResult.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSParseResult.en.rst b/doc/developer-guide/api/types/TSParseResult.en.rst
new file mode 100644
index 0000000..4b06274
--- /dev/null
+++ b/doc/developer-guide/api/types/TSParseResult.en.rst
@@ -0,0 +1,45 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSParseResult
+*************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSParseResult
+
+Enum typedef defining the possible return values from
+:c:func:`TSHttpHdrParseResp`.
+
+Enumeration Members
+===================
+
+.. c:member:: TSParseResult TS_PARSE_ERROR
+
+.. c:member:: TSParseResult TS_PARSE_DONE
+
+.. c:member:: TSParseResult TS_PARSE_OK
+
+.. c:member:: TSParseResult TS_PARSE_CONT
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSRecordAccessType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSRecordAccessType.en.rst b/doc/developer-guide/api/types/TSRecordAccessType.en.rst
new file mode 100644
index 0000000..84f71e1
--- /dev/null
+++ b/doc/developer-guide/api/types/TSRecordAccessType.en.rst
@@ -0,0 +1,42 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSRecordAccessType
+******************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSRecordAccessType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSRecordAccessType TS_RECORDACCESS_NULL
+
+.. c:member:: TSRecordAccessType TS_RECORDACCESS_NO_ACCESS
+
+.. c:member:: TSRecordAccessType TS_RECORDACCESS_READ_ONLY
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSRecordCheckType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSRecordCheckType.en.rst b/doc/developer-guide/api/types/TSRecordCheckType.en.rst
new file mode 100644
index 0000000..a6fc51f
--- /dev/null
+++ b/doc/developer-guide/api/types/TSRecordCheckType.en.rst
@@ -0,0 +1,44 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSRecordCheckType
+*****************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSRecordCheckType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSRecordCheckType TS_RECORDCHECK_NULL
+
+.. c:member:: TSRecordCheckType TS_RECORDCHECK_STR
+
+.. c:member:: TSRecordCheckType TS_RECORDCHECK_INT
+
+.. c:member:: TSRecordCheckType TS_RECORDCHECK_IP
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSRecordDataType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSRecordDataType.en.rst b/doc/developer-guide/api/types/TSRecordDataType.en.rst
new file mode 100644
index 0000000..9bfdb8a
--- /dev/null
+++ b/doc/developer-guide/api/types/TSRecordDataType.en.rst
@@ -0,0 +1,52 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSRecordDataType
+****************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSRecordDataType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSRecordDataType TS_RECORDDATATYPE_NULL
+
+.. c:member:: TSRecordDataType TS_RECORDDATATYPE_INT
+
+.. c:member:: TSRecordDataType TS_RECORDDATATYPE_FLOAT
+
+.. c:member:: TSRecordDataType TS_RECORDDATATYPE_STRING
+
+.. c:member:: TSRecordDataType TS_RECORDDATATYPE_COUNTER
+
+.. c:member:: TSRecordDataType TS_RECORDDATATYPE_STAT_CONST
+
+.. c:member:: TSRecordDataType TS_RECORDDATATYPE_STAT_FX
+
+.. c:member:: TSRecordDataType TS_RECORDDATATYPE_MAX
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSRecordModeType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSRecordModeType.en.rst b/doc/developer-guide/api/types/TSRecordModeType.en.rst
new file mode 100644
index 0000000..cdfa6c3
--- /dev/null
+++ b/doc/developer-guide/api/types/TSRecordModeType.en.rst
@@ -0,0 +1,44 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSRecordModeType
+****************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSRecordModeType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSRecordModeType TS_RECORDMODE_NULL
+
+.. c:member:: TSRecordModeType TS_RECORDMODE_CLIENT
+
+.. c:member:: TSRecordModeType TS_RECORDMODE_SERVER
+
+.. c:member:: TSRecordModeType TS_RECORDMODE_STAND_ALONE
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSRecordPersistType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSRecordPersistType.en.rst b/doc/developer-guide/api/types/TSRecordPersistType.en.rst
new file mode 100644
index 0000000..448e832
--- /dev/null
+++ b/doc/developer-guide/api/types/TSRecordPersistType.en.rst
@@ -0,0 +1,42 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSRecordPersistType
+*******************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSRecordPersistType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSRecordPersistType TS_RECORDP_NULL
+
+.. c:member:: TSRecordPersistType TS_RECORDP_PERSISTENT
+
+.. c:member:: TSRecordPersistType TS_RECORDP_NON_PERSISTENT
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSRecordType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSRecordType.en.rst b/doc/developer-guide/api/types/TSRecordType.en.rst
new file mode 100644
index 0000000..cb4a4f4
--- /dev/null
+++ b/doc/developer-guide/api/types/TSRecordType.en.rst
@@ -0,0 +1,52 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSRecordType
+************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSRecordType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSRecordType TS_RECORDTYPE_NULL
+
+.. c:member:: TSRecordType TS_RECORDTYPE_CONFIG
+
+.. c:member:: TSRecordType TS_RECORDTYPE_PROCESS
+
+.. c:member:: TSRecordType TS_RECORDTYPE_NODE
+
+.. c:member:: TSRecordType TS_RECORDTYPE_CLUSTER
+
+.. c:member:: TSRecordType TS_RECORDTYPE_LOCAL
+
+.. c:member:: TSRecordType TS_RECORDTYPE_PLUGIN
+
+.. c:member:: TSRecordType TS_RECORDTYPE_ALL
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSRecordUpdateType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSRecordUpdateType.en.rst b/doc/developer-guide/api/types/TSRecordUpdateType.en.rst
new file mode 100644
index 0000000..e24d5dd
--- /dev/null
+++ b/doc/developer-guide/api/types/TSRecordUpdateType.en.rst
@@ -0,0 +1,46 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSRecordUpdateType
+******************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSRecordUpdateType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSRecordUpdateType TS_RECORDUPDATE_NULL
+
+.. c:member:: TSRecordUpdateType TS_RECORDUPDATE_DYNAMIC
+
+.. c:member:: TSRecordUpdateType TS_RECORDUPDATE_RESTART_TS
+
+.. c:member:: TSRecordUpdateType TS_RECORDUPDATE_RESTART_TM
+
+.. c:member:: TSRecordUpdateType TS_RECORDUPDATE_RESTART_TC
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSReturnCode.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSReturnCode.en.rst b/doc/developer-guide/api/types/TSReturnCode.en.rst
new file mode 100644
index 0000000..5885fc3
--- /dev/null
+++ b/doc/developer-guide/api/types/TSReturnCode.en.rst
@@ -0,0 +1,40 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSReturnCode
+************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSReturnCode
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSReturnCode TS_ERROR
+
+.. c:member:: TSReturnCode TS_SUCCESS
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSSDKVersion.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSSDKVersion.en.rst b/doc/developer-guide/api/types/TSSDKVersion.en.rst
new file mode 100644
index 0000000..2fa3b0e
--- /dev/null
+++ b/doc/developer-guide/api/types/TSSDKVersion.en.rst
@@ -0,0 +1,40 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSSDKVersion
+************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSSDKVersion
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSSDKVersion TS_SDK_VERSION_2_0
+
+.. c:member:: TSSDKVersion TS_SDK_VERSION_3_0
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSServerSessionSharingMatchType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSServerSessionSharingMatchType.en.rst b/doc/developer-guide/api/types/TSServerSessionSharingMatchType.en.rst
new file mode 100644
index 0000000..6b2c369
--- /dev/null
+++ b/doc/developer-guide/api/types/TSServerSessionSharingMatchType.en.rst
@@ -0,0 +1,44 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSServerSessionSharingMatchType
+*******************************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSServerSessionSharingMatchType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSServerSessionSharingMatchType TS_SERVER_SESSION_SHARING_MATCH_NONE
+
+.. c:member:: TSServerSessionSharingMatchType TS_SERVER_SESSION_SHARING_MATCH_BOTH
+
+.. c:member:: TSServerSessionSharingMatchType TS_SERVER_SESSION_SHARING_MATCH_IP
+
+.. c:member:: TSServerSessionSharingMatchType TS_SERVER_SESSION_SHARING_MATCH_HOST
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSServerSessionSharingPoolType.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSServerSessionSharingPoolType.en.rst b/doc/developer-guide/api/types/TSServerSessionSharingPoolType.en.rst
new file mode 100644
index 0000000..e21b88e
--- /dev/null
+++ b/doc/developer-guide/api/types/TSServerSessionSharingPoolType.en.rst
@@ -0,0 +1,40 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSServerSessionSharingPoolType
+******************************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSServerSessionSharingPoolType
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSServerSessionSharingPoolType TS_SERVER_SESSION_SHARING_POOL_GLOBAL
+
+.. c:member:: TSServerSessionSharingPoolType TS_SERVER_SESSION_SHARING_POOL_THREAD
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSServerState.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSServerState.en.rst b/doc/developer-guide/api/types/TSServerState.en.rst
new file mode 100644
index 0000000..05f03b6
--- /dev/null
+++ b/doc/developer-guide/api/types/TSServerState.en.rst
@@ -0,0 +1,60 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSServerState
+*************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSServerState
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSServerState TS_SRVSTATE_STATE_UNDEFINED
+
+.. c:member:: TSServerState TS_SRVSTATE_ACTIVE_TIMEOUT
+
+.. c:member:: TSServerState TS_SRVSTATE_BAD_INCOMING_RESPONSE
+
+.. c:member:: TSServerState TS_SRVSTATE_CONNECTION_ALIVE
+
+.. c:member:: TSServerState TS_SRVSTATE_CONNECTION_CLOSED
+
+.. c:member:: TSServerState TS_SRVSTATE_CONNECTION_ERROR
+
+.. c:member:: TSServerState TS_SRVSTATE_INACTIVE_TIMEOUT
+
+.. c:member:: TSServerState TS_SRVSTATE_OPEN_RAW_ERROR
+
+.. c:member:: TSServerState TS_SRVSTATE_PARSE_ERROR
+
+.. c:member:: TSServerState TS_SRVSTATE_TRANSACTION_COMPLETE
+
+.. c:member:: TSServerState TS_SRVSTATE_CONGEST_CONTROL_CONGESTED_ON_F
+
+.. c:member:: TSServerState TS_SRVSTATE_CONGEST_CONTROL_CONGESTED_ON_M
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSSslVConnOp.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSSslVConnOp.en.rst b/doc/developer-guide/api/types/TSSslVConnOp.en.rst
new file mode 100644
index 0000000..a45ece2
--- /dev/null
+++ b/doc/developer-guide/api/types/TSSslVConnOp.en.rst
@@ -0,0 +1,44 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSSslVConnOp
+************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSSslVConnOp
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSSslVConnOp TS_SSL_HOOK_OP_DEFAULT
+
+.. c:member:: TSSslVConnOp TS_SSL_HOOK_OP_TUNNEL
+
+.. c:member:: TSSslVConnOp TS_SSL_HOOK_OP_TERMINATE
+
+.. c:member:: TSSslVConnOp TS_SSL_HOOK_OP_LAST
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSThreadPool.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSThreadPool.en.rst b/doc/developer-guide/api/types/TSThreadPool.en.rst
new file mode 100644
index 0000000..e7140a9
--- /dev/null
+++ b/doc/developer-guide/api/types/TSThreadPool.en.rst
@@ -0,0 +1,52 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSThreadPool
+************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSThreadPool
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSThreadPool TS_THREAD_POOL_DEFAULT
+
+.. c:member:: TSThreadPool TS_THREAD_POOL_NET
+
+.. c:member:: TSThreadPool TS_THREAD_POOL_TASK
+
+.. c:member:: TSThreadPool TS_THREAD_POOL_SSL
+
+.. c:member:: TSThreadPool TS_THREAD_POOL_DNS
+
+.. c:member:: TSThreadPool TS_THREAD_POOL_REMAP
+
+.. c:member:: TSThreadPool TS_THREAD_POOL_CLUSTER
+
+.. c:member:: TSThreadPool TS_THREAD_POOL_UDP
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/TSVConnCloseFlags.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/TSVConnCloseFlags.en.rst b/doc/developer-guide/api/types/TSVConnCloseFlags.en.rst
new file mode 100644
index 0000000..fff3473
--- /dev/null
+++ b/doc/developer-guide/api/types/TSVConnCloseFlags.en.rst
@@ -0,0 +1,40 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+TSVConnCloseFlags
+*****************
+
+Synopsis
+========
+
+`#include <ts/apidefs.h>`
+
+.. c:type:: TSVConnCloseFlags
+
+Enum typedef.
+
+Enumeration Members
+===================
+
+.. c:member:: TSVConnCloseFlags TS_VC_CLOSE_ABORT
+
+.. c:member:: TSVConnCloseFlags TS_VC_CLOSE_NORMAL
+
+Description
+===========
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/types/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/types/index.en.rst b/doc/developer-guide/api/types/index.en.rst
new file mode 100644
index 0000000..20ff9b9
--- /dev/null
+++ b/doc/developer-guide/api/types/index.en.rst
@@ -0,0 +1,34 @@
+.. 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.
+
+.. include:: ../../../common.defs
+
+.. _developer-api-ref-types:
+
+API Types
+*********
+
+This section documents all of the types defined by the |TS| C API. While each
+type's documentation references the C header file in which they are defined,
+``ts/apidefs.h``, please note that your plugins should never need to include
+this file directly. Including the ``ts/ts.h`` header is sufficient.
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   *

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/architecture/api-functions.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/architecture/api-functions.en.rst b/doc/developer-guide/architecture/api-functions.en.rst
new file mode 100644
index 0000000..16b4c1f
--- /dev/null
+++ b/doc/developer-guide/architecture/api-functions.en.rst
@@ -0,0 +1,69 @@
+.. 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.
+
+.. include:: ../../common.defs
+
+.. _developer-cache-api-functions:
+
+API functions
+*************
+
+.. c:function:: void TSHttpTxnReqCacheableSet(TSHttpTxn txnp, int flag)
+
+   Set a flag that marks a request as cacheable. This is a positive override
+   only, setting :arg:`flag` to ``0`` restores the default behavior, it does not
+   force the request to be uncacheable.
+
+.. c:function:: TSReturnCode TSCacheUrlSet(TSHttpTxn txnp, char const* url, int length)
+
+   Set the cache key for the transaction :arg:`txnp` as the string pointed at by
+   :arg:`url` of :arg:`length` characters. It need not be NUL-terminated. This should
+   be called from ``TS_HTTP_READ_REQUEST_HDR_HOOK`` which is before cache lookup
+   but late enough that the HTTP request header is available.
+
+.. c:function:: TSReturnCode TSHttpTxnCacheLookupUrlGet(TSHttpTxn txnp, TSMBuffer bufp, TSMLoc
offset)
+
+   Get the current cache key URL, also referred to as the lookup URL. This must
+   be stored in a properly allocated URL object, typically created with a
+   :c:func:`TSUrlCreate()`.
+
+.. c:function:: TSReturnCode TSHttpTxnCacheLookupUrlSet(TSHttpTxn txnp, TSMBuffer bufp, TSMLoc
offset)
+
+   Set the current cache key URL, also referred to as the lookup URL. This must
+   be stored in a properly allocated URL object, typically created with a
+   :c:func:`TSUrlCreate()` or :c:func:`TSUrlClone()`.
+
+
+The APIs that modify the cache key can be called as early as
+``TS_HTTP_READ_REQUEST_HDR_HOOK`` but no later than
+``TS_HTTP_POST_REMAP_HOOK``. The cache key is not only used for a cache lookup
+before going to origin, but also to mark the intent to write to cache on an
+origin response (if possible).
+
+Cache Internals
+===============
+
+.. cpp:function:: int DIR_SIZE_WITH_BLOCK(int big)
+
+   A preprocessor macro which computes the maximum size of a fragment based on
+   the value of :arg:`big`. This is computed as if the argument where the value of
+   the :arg:`big` field in a struct :cpp:class:`Dir`.
+
+.. cpp:function:: int DIR_BLOCK_SIZE(int big)
+
+   A preprocessor macro which computes the block size multiplier for a struct
+   :cpp:class:`Dir` where :arg:`big` is the :arg:`big` field value.


Mime
View raw message