You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2015/11/03 07:09:48 UTC
[12/51] trafficserver git commit: Documentation reorganization
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldDestroy.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldDestroy.en.rst b/doc/reference/api/TSMimeHdrFieldDestroy.en.rst
deleted file mode 100644
index 541607b..0000000
--- a/doc/reference/api/TSMimeHdrFieldDestroy.en.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldDestroy
-=====================
-
-Destroys the MIME field located at field within bufp.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldDestroy(TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
-
-
-Description
------------
-
-You must release the :c:type:`TSMLoc` field with a call to
-:c:func:`TSHandleMLocRelease`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldFind.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldFind.en.rst b/doc/reference/api/TSMimeHdrFieldFind.en.rst
deleted file mode 100644
index bedf089..0000000
--- a/doc/reference/api/TSMimeHdrFieldFind.en.rst
+++ /dev/null
@@ -1,41 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldFind
-==================
-
-Retrieves the :c:type:`TSMLoc` location of a specified MIME field from
-within the MIME header located at hdr.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSMLoc TSMimeHdrFieldFind(TSMBuffer bufp, TSMLoc hdr, const char *name, int length)
-
-
-Description
------------
-
-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
-:c:func:`TSMimeHdrFieldFind` cannot find the requested field, it
-returns :c:data:`TS_NULL_MLOC`. Release the returned :c:type:`TSMLoc`
-handle with a call to :c:func:`TSHandleMLocRelease`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldGet.en.rst b/doc/reference/api/TSMimeHdrFieldGet.en.rst
deleted file mode 100644
index 4dcddfe..0000000
--- a/doc/reference/api/TSMimeHdrFieldGet.en.rst
+++ /dev/null
@@ -1,40 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldGet
-=================
-
-Retrieves the location of a specified MIME field within the MIME
-header located at hdr_loc within bufp.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSMLoc TSMimeHdrFieldGet(TSMBuffer bufp, TSMLoc hdr, int idx)
-
-
-Description
------------
-
-The idx parameter specifies which field to retrieve. The fields are
-numbered from 0 to ``TSMimeHdrFieldsCount(bufp, hdr_loc)`` - 1. If
-idx does not lie within that range then :c:type:`TSMimeHdrFieldGet`
-returns 0. Release the returned handle with a call to
-:c:type:`TSHandleMLocRelease`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldLengthGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldLengthGet.en.rst b/doc/reference/api/TSMimeHdrFieldLengthGet.en.rst
deleted file mode 100644
index 68a73b1..0000000
--- a/doc/reference/api/TSMimeHdrFieldLengthGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldLengthGet
-=======================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int TSMimeHdrFieldLengthGet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldNameGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldNameGet.en.rst b/doc/reference/api/TSMimeHdrFieldNameGet.en.rst
deleted file mode 100644
index 6d54e17..0000000
--- a/doc/reference/api/TSMimeHdrFieldNameGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldNameGet
-=====================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: const char* TSMimeHdrFieldNameGet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int *length)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldNameSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldNameSet.en.rst b/doc/reference/api/TSMimeHdrFieldNameSet.en.rst
deleted file mode 100644
index ca36e78..0000000
--- a/doc/reference/api/TSMimeHdrFieldNameSet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldNameSet
-=====================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldNameSet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, const char *name, int length)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldNext.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldNext.en.rst b/doc/reference/api/TSMimeHdrFieldNext.en.rst
deleted file mode 100644
index f88fe31..0000000
--- a/doc/reference/api/TSMimeHdrFieldNext.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldNext
-==================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSMLoc TSMimeHdrFieldNext(TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldNextDup.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldNextDup.en.rst b/doc/reference/api/TSMimeHdrFieldNextDup.en.rst
deleted file mode 100644
index 738f710..0000000
--- a/doc/reference/api/TSMimeHdrFieldNextDup.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldNextDup
-=====================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSMLoc TSMimeHdrFieldNextDup(TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldRemove.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldRemove.en.rst b/doc/reference/api/TSMimeHdrFieldRemove.en.rst
deleted file mode 100644
index 38aebba..0000000
--- a/doc/reference/api/TSMimeHdrFieldRemove.en.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldRemove
-====================
-
-Removes the MIME field located at field within bufp from the header
-located at hdr within bufp.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldRemove(TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
-
-
-Description
------------
-
-If the specified field cannot be found in the list of fields
-associated with the header then nothing is done.
-
-.. note::
-
- removing the field does not destroy the field, it only detaches the
- field, hiding it from the printed output. The field can be
- reattached with a call to :c:func:`TSMimeHdrFieldAppend`. If you
- do not use the detached field you should destroy it with a call to
- :c:func:`TSMimeHdrFieldDestroy` and release the handle field with a
- call to :c:func:`TSHandleMLocRelease`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValueAppend.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueAppend.en.rst b/doc/reference/api/TSMimeHdrFieldValueAppend.en.rst
deleted file mode 100644
index 543d3cb..0000000
--- a/doc/reference/api/TSMimeHdrFieldValueAppend.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValueAppend
-=========================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldValueAppend(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, const char *value, int length)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValueDateInsert.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueDateInsert.en.rst b/doc/reference/api/TSMimeHdrFieldValueDateInsert.en.rst
deleted file mode 100644
index f1f7ef4..0000000
--- a/doc/reference/api/TSMimeHdrFieldValueDateInsert.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValueDateInsert
-=============================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldValueDateInsert(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, time_t value)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValueDateSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueDateSet.en.rst b/doc/reference/api/TSMimeHdrFieldValueDateSet.en.rst
deleted file mode 100644
index b4a2c09..0000000
--- a/doc/reference/api/TSMimeHdrFieldValueDateSet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValueDateSet
-==========================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldValueDateSet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, time_t value)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValueIntSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueIntSet.en.rst b/doc/reference/api/TSMimeHdrFieldValueIntSet.en.rst
deleted file mode 100644
index 869b5f3..0000000
--- a/doc/reference/api/TSMimeHdrFieldValueIntSet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValueIntSet
-=========================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldValueIntSet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, int value)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst b/doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst
deleted file mode 100644
index 2e4048d..0000000
--- a/doc/reference/api/TSMimeHdrFieldValueStringGet.en.rst
+++ /dev/null
@@ -1,113 +0,0 @@
-.. 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.
-
-.. default-domain:: c
-
-============================
-TSMimeHdrFieldValueStringGet
-============================
-
-Get HTTP MIME header values.
-
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: const char* TSMimeHdrFieldValueStringGet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, int* value_len_ptr)
-.. function:: int TSMimeHdrFieldValueIntGet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx)
-.. function:: int64_t TSMimeHdrFieldValueInt64Get(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx)
-.. function:: unsigned int TSMimeHdrFieldValueUintGet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx)
-.. function:: time_t TSMimeHdrFieldValueDateGet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
-
-
-Description
-===========
-
-MIME headers and fields can be components of request headers,
-response headers, or standalone headers created within a Traffic
-Server plugin. The functions here are all used to access header
-values of specific types, but it is up to the caller to know if a
-header has appropriate semantics for the API used. For all but
-:func:`TSMimeHdrFieldValueStringGet`, an appropriate data conversion
-algorithm is applied to the header field string.
-
-All the APIs take a :type:`TSMBuffer` marshal buffer argument, and
-a :type:`TSMLoc` argument indicating the location of the HTTP
-headers. The required :data:`field` argument is the locator of a
-specific header value, as returned by an accessor function such as
-:func:`TSMimeHdrFieldFind`.
-
-Within the header field, comma-separated values can be retrieved with an index
-(:data:`idx`) ranging from 0 to the maximum number of fields for this value; this
-maximum is retrieved using :func:`TSMimeHdrFieldValuesCount`. An :data:`idx` value of
-``-1`` has the semantics of retrieving the entire header value, regardless of
-how many comma-separated values there are. If a header is not comma-separated,
-an :data:`idx` of :data:`0` or :data:`-1` are the same, but the latter is
-preferred.
-
-:func:`TSMimeHdrFieldValueStringGet` returns a pointer to the header
-value, and populated :data:`value_len_ptr` with the length of the
-value in bytes. The returned header value is not NUL-terminated.
-
-Return values
-=============
-
-All functions returns the header value with a type matching the respective
-function name. Using :func:`TSMimeHdrFieldValueDateGet` on a header which
-does not have date-time semantics always returns :data:`0`.
-
-Examples
-========
-
-This examples show how to retrieve and copy a specific header.
-
-::
-
- #include <string.h>
- #include <ts/ts.h>
-
- int
- get_content_type(TSHttpTxn txnp, char* buf, size_t buf_size)
- {
- TSMBuffer bufp;
- TSMLoc hdrs;
- TSMLoc ctype_field;
- int len = -1;
-
- if (TS_SUCCESS == TSHttpTxnServerRespGet(txnp, &bufp, &hdrs)) {
- ctype_field = TSMimeHdrFieldFind(bufp, hdrs, TS_MIME_FIELD_CONTENT_TYPE, TS_MIME_LEN_CONTENT_TYPE);
-
- if (TS_NULL_MLOC != ctype_field) {
- const char* str = TSMimeHdrFieldValueStringGet(bufp, hdrs, ctype_field, -1, &len);
-
- if (len > buf_size)
- len = buf_size;
- memcpy(buf, str, len);
- TSHandleMLocRelease(bufp, hdrs, ctype_field);
- }
- TSHandleMLocRelease(bufp, TS_NULL_MLOC, hdrs);
- }
-
- return len;
- }
-
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`, :manpage:`TSMBufferCreate(3ts)`, :manpage:`TSMimeHdrFieldValuesCount(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValueStringInsert.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueStringInsert.en.rst b/doc/reference/api/TSMimeHdrFieldValueStringInsert.en.rst
deleted file mode 100644
index 4527edc..0000000
--- a/doc/reference/api/TSMimeHdrFieldValueStringInsert.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValueStringInsert
-===============================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldValueStringInsert(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, const char *value, int length)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValueStringSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueStringSet.en.rst b/doc/reference/api/TSMimeHdrFieldValueStringSet.en.rst
deleted file mode 100644
index 35ec8cb..0000000
--- a/doc/reference/api/TSMimeHdrFieldValueStringSet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValueStringSet
-============================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldValueStringSet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, const char *value, int length)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValueUintInsert.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueUintInsert.en.rst b/doc/reference/api/TSMimeHdrFieldValueUintInsert.en.rst
deleted file mode 100644
index 6c667ba..0000000
--- a/doc/reference/api/TSMimeHdrFieldValueUintInsert.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValueUintInsert
-=============================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldValueUintInsert(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, unsigned int value)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValueUintSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValueUintSet.en.rst b/doc/reference/api/TSMimeHdrFieldValueUintSet.en.rst
deleted file mode 100644
index 923b9a6..0000000
--- a/doc/reference/api/TSMimeHdrFieldValueUintSet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValueUintSet
-==========================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldValueUintSet(TSMBuffer bufp, TSMLoc hdr, TSMLoc field, int idx, unsigned int value)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValuesClear.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValuesClear.en.rst b/doc/reference/api/TSMimeHdrFieldValuesClear.en.rst
deleted file mode 100644
index 5956a86..0000000
--- a/doc/reference/api/TSMimeHdrFieldValuesClear.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValuesClear
-=========================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldValuesClear(TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldValuesCount.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldValuesCount.en.rst b/doc/reference/api/TSMimeHdrFieldValuesCount.en.rst
deleted file mode 100644
index 493bb73..0000000
--- a/doc/reference/api/TSMimeHdrFieldValuesCount.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldValuesCount
-=========================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int TSMimeHdrFieldValuesCount(TSMBuffer bufp, TSMLoc hdr, TSMLoc field)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldsClear.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldsClear.en.rst b/doc/reference/api/TSMimeHdrFieldsClear.en.rst
deleted file mode 100644
index 18c5aa5..0000000
--- a/doc/reference/api/TSMimeHdrFieldsClear.en.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldsClear
-====================
-
-Removes and destroys all the MIME fields within the MIME header
-located at hdr_loc within the marshal buffer bufp.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMimeHdrFieldsClear(TSMBuffer bufp, TSMLoc offset)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrFieldsCount.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrFieldsCount.en.rst b/doc/reference/api/TSMimeHdrFieldsCount.en.rst
deleted file mode 100644
index 0f20ce0..0000000
--- a/doc/reference/api/TSMimeHdrFieldsCount.en.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. 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.
-
-
-TSMimeHdrFieldsCount
-====================
-
-Returns a count of the number of MIME fields within the MIME header
-located at hdr_loc within the marshal buffer bufp.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int TSMimeHdrFieldsCount(TSMBuffer bufp, TSMLoc offset)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrLengthGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrLengthGet.en.rst b/doc/reference/api/TSMimeHdrLengthGet.en.rst
deleted file mode 100644
index 22223d5..0000000
--- a/doc/reference/api/TSMimeHdrLengthGet.en.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-.. 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.
-
-
-TSMimeHdrLengthGet
-==================
-
-Calculates the length of the MIME header located at hdr_loc if it were
-returned as a string.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: int TSMimeHdrLengthGet(TSMBuffer bufp, TSMLoc offset)
-
-
-Description
------------
-
-This the length of the MIME header in its unparsed form.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrParse.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrParse.en.rst b/doc/reference/api/TSMimeHdrParse.en.rst
deleted file mode 100644
index ad6a046..0000000
--- a/doc/reference/api/TSMimeHdrParse.en.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-.. 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.
-
-
-TSMimeHdrParse
-==============
-
-Parses a MIME header.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSParseResult TSMimeHdrParse(TSMimeParser parser, TSMBuffer bufp, TSMLoc offset, const char **start, const char *end)
-
-
-Description
------------
-
-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
-:c:func:`TSMimeHdrParse`. As long as an error does not occur,
-:c:func:`TSMimeHdrParse` consumes each single byte and asks for more.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeHdrPrint.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeHdrPrint.en.rst b/doc/reference/api/TSMimeHdrPrint.en.rst
deleted file mode 100644
index 50916d3..0000000
--- a/doc/reference/api/TSMimeHdrPrint.en.rst
+++ /dev/null
@@ -1,34 +0,0 @@
-.. 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.
-
-
-TSMimeHdrPrint
-==============
-
-Formats the MIME header located at hdr_loc within bufp into the
-:c:type:`TSIOBuffer` iobufp.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSMimeHdrPrint(TSMBuffer bufp, TSMLoc offset, TSIOBuffer iobufp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeParserClear.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeParserClear.en.rst b/doc/reference/api/TSMimeParserClear.en.rst
deleted file mode 100644
index 3dc00fa..0000000
--- a/doc/reference/api/TSMimeParserClear.en.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-.. 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.
-
-
-TSMimeParserClear
-=================
-
-Clears the specified MIME parser so that it can be used again.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSMimeParserClear(TSMimeParser parser)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeParserCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeParserCreate.en.rst b/doc/reference/api/TSMimeParserCreate.en.rst
deleted file mode 100644
index 8156698..0000000
--- a/doc/reference/api/TSMimeParserCreate.en.rst
+++ /dev/null
@@ -1,38 +0,0 @@
-.. 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.
-
-
-TSMimeParserCreate
-==================
-
-Creates a MIME parser.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSMimeParser TSMimeParserCreate(void)
-
-
-Description
------------
-
-The parser's data structure contains 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 :c:func:`TSMimeParserClear`.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMimeParserDestroy.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMimeParserDestroy.en.rst b/doc/reference/api/TSMimeParserDestroy.en.rst
deleted file mode 100644
index 7bcbd34..0000000
--- a/doc/reference/api/TSMimeParserDestroy.en.rst
+++ /dev/null
@@ -1,33 +0,0 @@
-.. 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.
-
-
-TSMimeParserDestroy
-===================
-
-Destroys the specified MIME parser and frees the associated memory.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSMimeParserDestroy(TSMimeParser parser)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMutexCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMutexCreate.en.rst b/doc/reference/api/TSMutexCreate.en.rst
deleted file mode 100644
index 2274bf4..0000000
--- a/doc/reference/api/TSMutexCreate.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMutexCreate
-=============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSMutex TSMutexCreate(void)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMutexDestory.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMutexDestory.en.rst b/doc/reference/api/TSMutexDestory.en.rst
deleted file mode 100644
index ddb65d1..0000000
--- a/doc/reference/api/TSMutexDestory.en.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. 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.
-
-
-TSMutexLock
-===========
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSMutexDestroy(TSMutex mutexp)
-
-
-Description
------------
-Destroys a mutex previously created via TSMutexCreate.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMutexLock.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMutexLock.en.rst b/doc/reference/api/TSMutexLock.en.rst
deleted file mode 100644
index 8ff4d04..0000000
--- a/doc/reference/api/TSMutexLock.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMutexLock
-===========
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSMutexLock(TSMutex mutexp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMutexLockTry.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMutexLockTry.en.rst b/doc/reference/api/TSMutexLockTry.en.rst
deleted file mode 100644
index 1a3d8de..0000000
--- a/doc/reference/api/TSMutexLockTry.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMutexLockTry
-==============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSMutexLockTry(TSMutex mutexp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSMutexUnlock.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSMutexUnlock.en.rst b/doc/reference/api/TSMutexUnlock.en.rst
deleted file mode 100644
index fe131fc..0000000
--- a/doc/reference/api/TSMutexUnlock.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSMutexUnlock
-=============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSMutexUnlock(TSMutex mutexp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSNetAccept.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSNetAccept.en.rst b/doc/reference/api/TSNetAccept.en.rst
deleted file mode 100644
index 19467e8..0000000
--- a/doc/reference/api/TSNetAccept.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSNetAccept
-===========
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSAction TSNetAccept(TSCont contp, int port, int domain, int accept_threads)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSNetAcceptNamedProtocol.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSNetAcceptNamedProtocol.en.rst b/doc/reference/api/TSNetAcceptNamedProtocol.en.rst
deleted file mode 100644
index b2ccd14..0000000
--- a/doc/reference/api/TSNetAcceptNamedProtocol.en.rst
+++ /dev/null
@@ -1,54 +0,0 @@
-.. 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.
-
-
-TSNetAcceptNamedProtocol
-========================
-
-Listen on all SSL ports for connections for the specified protocol
-name.
-
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSReturnCode TSNetAcceptNamedProtocol(TSCont contp, const char *protocol)
-
-
-Description
------------
-
-:c:type:`TSNetAcceptNamedProtocol` registers the specified protocol
-for all statically configured TLS ports. When a client using the TLS
-Next Protocol Negotiation extension negotiates the requested protocol,
-:c:type:`TrafficServer` will route the request to the given handler.
-Note that the protocol is not registered on ports opened by other
-plugins.
-
-The event and data provided to the handler are the same as for
-:c:func:`TSNetAccept`. If a connection is successfully accepted, the
-event code will be :c:data:`TS_EVENT_NET_ACCEPT` and the event data
-will be a valid :c:type:`TSVConn` bound to the accepted connection.
-
-Neither contp nor protocol are copied. They must remain valid for the
-lifetime of the plugin.
-
-:c:type:`TSNetAcceptNamedProtocol` fails if the requested protocol
-cannot be registered on all of the configured TLS ports. If it fails,
-the protocol will not be registered on any ports
-(ie.. no partial failure).
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSNetConnect.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSNetConnect.en.rst b/doc/reference/api/TSNetConnect.en.rst
deleted file mode 100644
index 4478487..0000000
--- a/doc/reference/api/TSNetConnect.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSNetConnect
-============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSAction TSNetConnect(TSCont contp, sockaddr const *addr)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSPluginInit.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSPluginInit.en.rst b/doc/reference/api/TSPluginInit.en.rst
deleted file mode 100644
index 86e30f1..0000000
--- a/doc/reference/api/TSPluginInit.en.rst
+++ /dev/null
@@ -1,77 +0,0 @@
-.. 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.
-
-.. default-domain:: c
-
-============
-TSPluginInit
-============
-
-Traffic Server plugin loading and registration.
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: void TSPluginInit(int argc, const char* argv[])
-.. function:: TSReturnCode TSPluginRegister(TSPluginRegistrationInfo* plugin_info)
-
-Description
-===========
-
-:func:`TSPluginInit` must be defined by all plugins. Traffic Server
-calls this initialization routine when it loads the plugin and sets
-argc and argv appropriately based on the values in plugin.config.
-argc is a count of the number of arguments in the argument vector,
-argv. The count is at least one because the first argument in the
-argument vector is the plugins name, which must exist in order for
-the plugin to be loaded. argv is the vector of arguments. The number
-of arguments in the vector is argc, and argv[0] always contains the
-name of the plugin shared library. :func:`TSPluginRegister` registers
-the appropriate SDK version for your plugin. Use this function to
-make sure that the version of Traffic Server on which your plugin
-is running supports the plugin.
-
-Return values
-=============
-
-:func:`TSPluginRegister` returns :const:`TS_ERROR` if the plugin registration failed.
-
-Examples
-========
-
-::
-
- #include <ts/ts.h>
-
- void
- TSPluginInit (int argc, const char *argv[])
- {
- TSPluginRegistrationInfo info;
- info.plugin_name = "hello-world";
- info.vendor_name = "MyCompany";
- info.support_email = "ts-api-support@MyCompany.com";
-
- if (TSPluginRegister(&info) != TS_SUCCESS) {
- TSError("Plugin registration failed. 0);
- }
- }
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`, :manpage:`TSInstallDirGet(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSRemap.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSRemap.en.rst b/doc/reference/api/TSRemap.en.rst
deleted file mode 100644
index 7542cac..0000000
--- a/doc/reference/api/TSRemap.en.rst
+++ /dev/null
@@ -1,87 +0,0 @@
-.. 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.
-
-.. default-domain:: c
-
-===========
-TSRemapInit
-===========
-
-Traffic Server remap plugin entry points.
-
-Synopsis
-========
-
-| `#include <ts/ts.h>`
-| `#include <ts/remap.h>`
-
-.. function:: TSReturnCode TSRemapInit(TSRemapInterface * api_info, char* errbuf, int errbuf_size)
-.. function:: void TSRemapDone(void)
-.. function:: TSRemapStatus TSRemapDoRemap(void * ih, TSHttpTxn rh, TSRemapRequestInfo * rri)
-.. function:: TSReturnCode TSRemapNewInstance(int argc, char * argv[], void ** ih, char * errbuf, int errbuf_size)
-.. function:: void TSRemapDeleteInstance(void * )
-.. function:: void TSRemapOSResponse(void * ih, TSHttpTxn rh, int os_response_type)
-
-Description
-===========
-
-The Traffic Server remap interface provides a simplified mechanism for
-plugins to manipulate HTTP transactions. A remap plugin is not global; it
-is configured on a per-remap rule basis, which enables you to customize
-how URLs are redirected based on individual rules in the remap.config
-file. Writing a remap plugin consists of implementing one or more of the
-remap entry points and configuring the remap.config configuration file to
-route the transaction through your plugin. Multiple remap plugins can be
-specified for a single remap rule, resulting in a remap plugin chain
-where each plugin is given an opportunity to examine the HTTP transaction.
-
-:func:`TSRemapInit` is a required entry point. This function will be called
-once when Traffic Server loads the plugin. If the optional :func:`TSRemapDone`
-entry point is available, Traffic Server will call then when unloading
-the remap plugin.
-
-A remap plugin may be invoked for different remap rules. Traffic Server
-will call the entry point each time a plugin is specified in a remap
-rule. When a remap plugin instance is no longer required, Traffic Server
-will call :func:`TSRemapDeleteInstance`.
-
-:func:`TSRemapDoRemap` is called for each HTTP transaction. This is a mandatory
-entry point. In this function, the remap plugin may examine and modify
-the HTTP transaction.
-
-Return values
-=============
-
-:func:`TSRemapInit` and :func:`TSRemapNewInstance` should return
-:data:`TS_SUCCESS` on success, and :data:`TS_ERROR` otherwise. A
-return value of :data:`TS_ERROR` is unrecoverable.
-
-:func:`TSRemapDoRemap` returns a status code that indicates whether
-the HTTP transaction has been modified and whether Traffic Server
-should continue to evaluate the chain of remap plugins. If the
-transaction was modified, the plugin should return
-:data:`TSREMAP_DID_REMAP` or :data:`TSREMAP_DID_REMAP_STOP`; otherwise
-it should return :data:`TSREMAP_NO_REMAP` or :data:`TSREMAP_NO_REMAP_STOP`.
-If Traffic Server should not send the transaction to subsequent
-plugins in the remap chain, return :data:`TSREMAP_NO_REMAP_STOP`
-or :data:`TSREMAP_DID_REMAP_STOP`. Returning :data:`TSREMAP_ERROR`
-causes Traffic Server to stop evaluating the remap chain and respond
-with an error.
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSSslContextFindBy.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSSslContextFindBy.en.rst b/doc/reference/api/TSSslContextFindBy.en.rst
deleted file mode 100644
index fc6a975..0000000
--- a/doc/reference/api/TSSslContextFindBy.en.rst
+++ /dev/null
@@ -1,56 +0,0 @@
-.. 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.
-
-
-TSSslContextFindByName
-======================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-
-.. c:function:: TSSslContext TSSslContextFindByName(const char *name)
-
-
-Description
------------
-
- Look for a SSL context created from the :c:type:`ssl_multicert.config` file. Use the server name to search.
-
-TSSslContextFindByAddr
-=======================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSSslContext TSSslContextFindByAddr(struct sockaddr const*)
-
-
-Description
------------
-
- Look for a SSL context created from the :c:type:`ssl_multicert.config` file. Use the server address to search.
-
-Type
-----
-
-.. c:type:: TSSslContext
-
- Corresponds to the SSL_CTX * value in openssl.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSTextLogObjectCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTextLogObjectCreate.en.rst b/doc/reference/api/TSTextLogObjectCreate.en.rst
deleted file mode 100644
index 63822cb..0000000
--- a/doc/reference/api/TSTextLogObjectCreate.en.rst
+++ /dev/null
@@ -1,60 +0,0 @@
-.. 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.
-
-.. default-domain:: c
-
-=====================
-TSTextLogObjectCreate
-=====================
-
-Traffic Server text logging API.
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: TSReturnCode TSTextLogObjectCreate(const char* filename, int mode, TSTextLogObject * new_log_obj)
-.. function:: TSReturnCode TSTextLogObjectWrite(TSTextLogObject the_object, const char * format, ...)
-.. function:: void TSTextLogObjectFlush(TSTextLogObject the_object)
-.. function:: TSReturnCode TSTextLogObjectDestroy(TSTextLogObject the_object)
-.. function:: void TSTextLogObjectHeaderSet(TSTextLogObject the_object, const char * header)
-.. function:: TSReturnCode TSTextLogObjectRollingEnabledSet(TSTextLogObject the_object, int rolling_enabled)
-.. function:: void TSTextLogObjectRollingIntervalSecSet(TSTextLogObject the_object, int rolling_interval_sec)
-.. function:: void TSTextLogObjectRollingOffsetHrSet(TSTextLogObject the_object, int rolling_offset_hr)
-.. function:: void TSTextLogObjectRollingSizeMbSet(TSTextLogObject the_object, int rolling_size_mb)
-
-Description
-===========
-
-:func:`TSTextLogObjectRollingEnabledSet` sets the log rolling mode
-for the given object. This API must be used once the object is
-created and before writing into logs. The :arg:`rolling_enabled`
-argument must be a valid :ts:cv:`proxy.config.log.rolling_enabled`
-values. If :func:`TSTextLogObjectRollingEnabledSet` is never called,
-the log object takes it's log rolling mode from the global
-:ts:cv:`proxy.config.log.rolling_enabled` setting.
-
-It's also important to call :func:`TSTextLogObjectRollingEnabledSet` before
-any of the other APIs that modifies the rolling object. This is due to the
-fact that this API dictates which rolling mode should be used, and therefore
-affects further modifications of the logging object.
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSThreadCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSThreadCreate.en.rst b/doc/reference/api/TSThreadCreate.en.rst
deleted file mode 100644
index 35cd908..0000000
--- a/doc/reference/api/TSThreadCreate.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSThreadCreate
-==============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSThread TSThreadCreate(TSThreadFunc func, void *data)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSThreadDestroy.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSThreadDestroy.en.rst b/doc/reference/api/TSThreadDestroy.en.rst
deleted file mode 100644
index a80abe0..0000000
--- a/doc/reference/api/TSThreadDestroy.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSThreadDestroy
-===============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: void TSThreadDestroy(TSThread thread)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSThreadInit.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSThreadInit.en.rst b/doc/reference/api/TSThreadInit.en.rst
deleted file mode 100644
index 08da73f..0000000
--- a/doc/reference/api/TSThreadInit.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSThreadInit
-============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSThread TSThreadInit(void)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSThreadSelf.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSThreadSelf.en.rst b/doc/reference/api/TSThreadSelf.en.rst
deleted file mode 100644
index efeed83..0000000
--- a/doc/reference/api/TSThreadSelf.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSThreadSelf
-============
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSThread TSThreadSelf(void)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSTrafficServerVersionGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTrafficServerVersionGet.en.rst b/doc/reference/api/TSTrafficServerVersionGet.en.rst
deleted file mode 100644
index c02e41a..0000000
--- a/doc/reference/api/TSTrafficServerVersionGet.en.rst
+++ /dev/null
@@ -1,100 +0,0 @@
-.. 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.
-
-.. default-domain:: c
-
-=========================
-TSTrafficServerVersionGet
-=========================
-
-Return Traffic Server version information.
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: const char * TSTrafficServerVersionGet(void)
-.. function:: int TSTrafficServerVersionGetMajor(void)
-.. function:: int TSTrafficServerVersionGetMinor(void)
-.. function:: int TSTrafficServerVersionGetPatch(void)
-
-Description
-===========
-
-:func:`TSTrafficServerVersionGet` returns a pointer to a string of characters
-that indicates the Traffic Server release version. This string must not
-be modified.
-
-The other APIs return an integer version number.
-
-Example
-=======
-
-::
-
- #include <stdio.h>
- #include <ts/ts.h>
-
- int
- check_ts_version()
- {
- const char *ts_version = TSTrafficServerVersionGet();
- int result = 0;
-
- if (ts_version) {
- int major_ts_version = 0;
- int minor_ts_version = 0;
- int patch_ts_version = 0;
-
- if (sscanf(ts_version, "%d.%d.%d", &major_ts_version,
- &minor_ts_version, &patch_ts_version) != 3) {
- return 0;
- }
-
- /* We need at least Traffic Server 3.0 */
- if (major_ts_version >= 3) {
- result = 1;
- }
- }
-
- return result;
- }
-
- void
- TSPluginInit (int argc, const char *argv[])
- {
- TSPluginRegistrationInfo info;
- info.plugin_name = "hello-world";
- info.vendor_name = "MyCompany";
- info.support_email = "ts-api-support@MyCompany.com";
-
- if (TSPluginRegister(&info) != TS_SUCCESS) {
- TSError("Plugin registration failed. 0);
- }
-
- if (!check_ts_version()) {
- TSError("Plugin requires Traffic Server 3.0 or later0);
- return;
- }
-
- TSDebug("debug-hello", "Hello World!0);
- }
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSTransformCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTransformCreate.en.rst b/doc/reference/api/TSTransformCreate.en.rst
deleted file mode 100644
index 3950eb4..0000000
--- a/doc/reference/api/TSTransformCreate.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSTransformCreate
-=================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSVConn TSTransformCreate(TSEventFunc event_funcp, TSHttpTxn txnp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSTransformOutputVConnGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTransformOutputVConnGet.en.rst b/doc/reference/api/TSTransformOutputVConnGet.en.rst
deleted file mode 100644
index 8ff170a..0000000
--- a/doc/reference/api/TSTransformOutputVConnGet.en.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 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.
-
-
-TSTransformOutputVConnGet
-=========================
-
-Synopsis
---------
-
-`#include <ts/ts.h>`
-
-.. c:function:: TSVConn TSTransformOutputVConnGet(TSVConn connp)
-
-
-Description
------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/api/TSTypes.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTypes.en.rst b/doc/reference/api/TSTypes.en.rst
deleted file mode 100644
index 4664889..0000000
--- a/doc/reference/api/TSTypes.en.rst
+++ /dev/null
@@ -1,187 +0,0 @@
-.. 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.
-
-.. default-domain:: c
-
-===========
-TSAPI Types
-===========
-
-Synopsis
-========
-| `#include <ts/ts.h>`
-| `#include <ts/remap.h>`
-
-Description
-===========
-
-The Apache Traffic Server API provides large number of types. Many of them are specific to a particular API function or
-function group, but others are used more widely. Those are described on this page.
-
-.. type:: ink_hrtime
-
-.. type:: TSAction
-
-.. type:: TSCacheKey
-
-.. type:: TSConfig
-
-.. type:: TSConfigDestroyFunc
-
-.. type:: TSCont
-
- An opaque type that represents a Traffic Server :term:`continuation`.
-
-.. type:: TSEvent
-
- :type:`TSEvents` are sent to continuations when they are called
- back.
-
- The :type:`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.
-
-.. type:: TSEventFunc
-
-.. type:: TSFile
-
-.. type:: TSHostLookupResult
-
-.. type:: TSHRTime
-
- "High Resolution Time"
-
- A 64 bit time value, measured in nanoseconds.
-
-.. type:: TSHttpHookID
-
- An enumeration that identifies a specific type of hook for HTTP transactions.
-
-.. type:: TSHttpParser
-
-.. type:: TSHttpSsn
-
- An opaque type that represents a Traffic Server :term:`session`.
-
-.. type:: TSHttpStatus
-
- This set of enums represents possible return values from
- :func:`TSHttpHdrStatusGet`, which retrieves the status code from an
- HTTP response header (:func:`TSHttpHdrStatusGet` retrieves status
- codes only from headers of type :data:`TS_HTTP_TYPE_RESPONSE`).
-
- You can also set the :type:`TSHttpStatus` of a response header using
- :func:`TSHttpHdrStatusSet`.
-
-.. type:: TSHttpTxn
-
- An opaque type that represents a Traffic Server HTTP :term:`transaction`.
-
-.. type:: TSHttpType
-
- This set of enums represents the possible HTTP types that can be
- assigned to an HTTP header.
-
- When a header is created with :func:`TSHttpHdrCreate`, it is
- automatically assigned a type of :data:`TS_HTTP_TYPE_UNKNOWN`. You
- can modify the HTTP type ONCE after it the header is created, using
- :func:`TSHttpHdrTypeSet`. After setting the HTTP type once, you
- cannot set it again. Use :func:`TSHttpHdrTypeGet` to obtain the
- :type:`TSHttpType` of an HTTP header.
-
-.. type:: TSIOBuffer
-
-.. type:: TSIOBufferBlock
-
-.. type:: TSIOBufferReader
-
-.. type:: TSIOBufferSizeIndex
-
-.. type:: TSLifecycleHookID
-
- An enumeration that identifies a :ref:`life cycle hook <ts-lifecycle-hook-add>`.
-
-.. type:: TSMBuffer
-
-.. type:: TSMgmtCounter
-
-.. type:: TSMgmtFloat
-
- The type used internally for a floating point value. This corresponds to the value :const:`TS_RECORDDATATYPE_FLOAT` for
- :type:`TSRecordDataType`.
-
-.. type:: TSMgmtInt
-
- The type used internally for an integer. This corresponds to the value :const:`TS_RECORDDATATYPE_INT` for
- :type:`TSRecordDataType`.
-
-.. type:: TSMgmtString
-
-.. type:: TSMimeParser
-
-.. type:: TSMLoc
-
-.. type:: TSMutex
-
-.. type:: TSParseResult
-
- This set of enums are possible values returned by
- :func:`TSHttpHdrParseReq` and :func:`TSHttpHdrParseResp`.
-
-.. type:: TSPluginRegistrationInfo
-
- The following struct is used by :func:`TSPluginRegister`.
-
- It stores registration information about the plugin.
-
-.. type:: TSRecordDataType
-
- An enumeration that specifies the type of a value in an internal data structure that is accessible via the API.
-
-.. type:: TSRemapInterface
-
-.. type:: TSRemapRequestInfo
-
-.. type:: TSRemapStatus
-
-.. type:: TSReturnCode
-
- An indicator of the results of an API call. A value of :const:`TS_SUCCESS` means the call was successful. Any other value
- indicates a failure and is specific to the API call.
-
-.. type:: TSSDKVersion
-
- Starting 2.0, SDK now follows same versioning as Traffic Server.
-
-.. type:: TSServerState
-
-.. type:: TSTextLogObject
-
- This type represents a custom log file that you create with
- :func:`TSTextLogObjectCreate`.
-
- Your plugin writes entries into this log file using
- :func:`TSTextLogObjectWrite`.
-
-.. type:: TSThread
-
-.. type:: TSThreadFunc
-
-.. type:: TSThreadPool
-
-.. type:: TSVConn
-
-.. type:: TSVIO