trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jpe...@apache.org
Subject [26/51] trafficserver git commit: Documentation reorganization
Date Tue, 03 Nov 2015 06:10:02 GMT
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrClone.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrClone.en.rst b/doc/developer-guide/api/functions/TSHttpHdrClone.en.rst
new file mode 100644
index 0000000..ab7ee2a
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrClone.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrClone
+**************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpHdrClone(TSMBuffer dest_bufp, TSMBuffer src_bufp, TSMLoc src_hdr, TSMLoc * locp)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrCopy.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrCopy.en.rst b/doc/developer-guide/api/functions/TSHttpHdrCopy.en.rst
new file mode 100644
index 0000000..3054395
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrCopy.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
+
+.. default-domain:: c
+
+TSHttpHdrCopy
+*************
+
+Copies the contents of the HTTP header located at src_loc within
+src_bufp to the HTTP header located at dest_loc within dest_bufp.
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpHdrCopy(TSMBuffer dest_bufp, TSMLoc dest_offset, TSMBuffer src_bufp, TSMLoc src_offset)
+
+Description
+===========
+
+:c:func:`TSHttpHdrCopy` works correctly even if :arg:`src_bufp` and
+:arg:`dest_bufp` point to different :ref:`developer-plugins-marshal-buffers`.
+Make sure that you create the destination HTTP header before copying into it.
+
+.. note::
+
+   :c:func:`TSHttpHdrCopy` appends the port number to the domain of
+   the URL portion of the header. For example, a copy of
+   http://www.example.com appears as http://www.example.com:80 in the
+   destination buffer.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrCreate.en.rst b/doc/developer-guide/api/functions/TSHttpHdrCreate.en.rst
new file mode 100644
index 0000000..a4a7a82
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrCreate.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrCreate
+***************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSMLoc TSHttpHdrCreate(TSMBuffer bufp)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrDestroy.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrDestroy.en.rst b/doc/developer-guide/api/functions/TSHttpHdrDestroy.en.rst
new file mode 100644
index 0000000..2bf8254
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrDestroy.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
+
+.. default-domain:: c
+
+TSHttpHdrDestroy
+****************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: void TSHttpHdrDestroy(TSMBuffer bufp, TSMLoc offset)
+
+Description
+===========
+
+Destroys the HTTP header located at :arg:`hdr_loc` within the marshal buffer
+:arg:`bufp`.
+
+.. important::
+
+   Do not forget to release the handle :arg:`hdr_loc` with a call to
+   :c:func:`TSHandleMLocRelease`.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrHostGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrHostGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrHostGet.en.rst
new file mode 100644
index 0000000..0e70c37
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrHostGet.en.rst
@@ -0,0 +1,43 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrHostGet
+****************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: const char* TSHttpHdrHostGet(TSMBuffer bufp, TSMLoc offset, int * length)
+
+Description
+===========
+
+Get the host for the request. :arg:`bufp` and :arg:`offset` must reference an
+HTTP request header. A pointer to the host is returned and the length is stored
+in the ``int`` pointed at by :arg:`length`. Note the returned text may not
+be null terminated. The URL in the request is checked first then the ``Host``
+header field.
+
+.. note::
+
+   This is much faster than calling :c:func:`TSHttpEffectiveUrlStringGet` and
+   extracting the host from the result.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrLengthGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrLengthGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrLengthGet.en.rst
new file mode 100644
index 0000000..9db63fd
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrLengthGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrLengthGet
+******************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: int TSHttpHdrLengthGet(TSMBuffer bufp, TSMLoc offset)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrMethodGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrMethodGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrMethodGet.en.rst
new file mode 100644
index 0000000..f3eaec8
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrMethodGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrMethodGet
+******************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: const char* TSHttpHdrMethodGet(TSMBuffer bufp, TSMLoc offset, int * length)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrMethodSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrMethodSet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrMethodSet.en.rst
new file mode 100644
index 0000000..bded2e1
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrMethodSet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrMethodSet
+******************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpHdrMethodSet(TSMBuffer bufp, TSMLoc offset, const char * value, int length)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrPrint.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrPrint.en.rst b/doc/developer-guide/api/functions/TSHttpHdrPrint.en.rst
new file mode 100644
index 0000000..1f6c1d7
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrPrint.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrPrint
+**************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: void TSHttpHdrPrint(TSMBuffer bufp, TSMLoc offset, TSIOBuffer iobufp)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrReasonGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrReasonGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrReasonGet.en.rst
new file mode 100644
index 0000000..b356519
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrReasonGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrReasonGet
+******************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: const char* TSHttpHdrReasonGet(TSMBuffer bufp, TSMLoc offset, int * length)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrReasonLookup.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrReasonLookup.en.rst b/doc/developer-guide/api/functions/TSHttpHdrReasonLookup.en.rst
new file mode 100644
index 0000000..9b85b15
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrReasonLookup.en.rst
@@ -0,0 +1,30 @@
+.. 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.
+
+
+TSHttpHdrReasonLookup
+=====================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: const char* TSHttpHdrReasonLookup(TSHttpStatus status)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrReasonSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrReasonSet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrReasonSet.en.rst
new file mode 100644
index 0000000..a1b1524
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrReasonSet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrReasonSet
+******************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpHdrReasonSet(TSMBuffer bufp, TSMLoc offset, const char * value, int length)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrStatusGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrStatusGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrStatusGet.en.rst
new file mode 100644
index 0000000..50b2f1d
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrStatusGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrStatusGet
+******************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSHttpStatus TSHttpHdrStatusGet(TSMBuffer bufp, TSMLoc offset)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrStatusSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrStatusSet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrStatusSet.en.rst
new file mode 100644
index 0000000..bccc5e4
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrStatusSet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrStatusSet
+******************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpHdrStatusSet(TSMBuffer bufp, TSMLoc offset, TSHttpStatus status)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrTypeGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrTypeGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrTypeGet.en.rst
new file mode 100644
index 0000000..c0adeeb
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrTypeGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrTypeGet
+****************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSHttpType TSHttpHdrTypeGet(TSMBuffer bufp, TSMLoc offset)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrTypeSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrTypeSet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrTypeSet.en.rst
new file mode 100644
index 0000000..edfada4
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrTypeSet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrTypeSet
+****************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpHdrTypeSet(TSMBuffer bufp, TSMLoc offset, TSHttpType type)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrUrlGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrUrlGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrUrlGet.en.rst
new file mode 100644
index 0000000..c6dbd0e
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrUrlGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrUrlGet
+***************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpHdrUrlGet(TSMBuffer bufp, TSMLoc offset, TSMLoc * locp)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrUrlSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrUrlSet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrUrlSet.en.rst
new file mode 100644
index 0000000..5a10097
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrUrlSet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrUrlSet
+***************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpHdrUrlSet(TSMBuffer bufp, TSMLoc offset, TSMLoc url)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrVersionGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrVersionGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrVersionGet.en.rst
new file mode 100644
index 0000000..6dfcead
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrVersionGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrVersionGet
+*******************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: int TSHttpHdrVersionGet(TSMBuffer bufp, TSMLoc offset)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHdrVersionSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHdrVersionSet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrVersionSet.en.rst
new file mode 100644
index 0000000..a63cbd8
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHdrVersionSet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHdrVersionSet
+*******************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpHdrVersionSet(TSMBuffer bufp, TSMLoc offset, int ver)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpHookAdd.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpHookAdd.en.rst b/doc/developer-guide/api/functions/TSHttpHookAdd.en.rst
new file mode 100644
index 0000000..d256321
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpHookAdd.en.rst
@@ -0,0 +1,118 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpHookAdd
+*************
+
+Intercept Traffic Server events.
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: void TSHttpHookAdd(TSHttpHookID id, TSCont contp)
+.. function:: void TSHttpSsnHookAdd(TSHttpSsn ssnp, TSHttpHookID id, TSCont contp)
+.. function:: void TSHttpTxnHookAdd(TSHttpTxn txnp, TSHttpHookID id, TSCont contp)
+
+Description
+===========
+
+Hooks are points in Apache Traffic Server transaction HTTP processing
+where plugins can step in and do some work. Registering a plugin
+function for callback amounts to adding the function to a hook. You
+can register your plugin to be called back for every single
+transaction, or for specific transactions only.
+
+HTTP :term:`transaction` hooks are set on a global basis using the function
+:func:`TSHttpHookAdd`. This means that the continuation specified
+as the parameter to :func:`TSHttpHookAdd` is called for every
+transaction. :func:`TSHttpHookAdd` is typically called from
+:func:`TSPluginInit` or :func:`TSRemapInit`.
+
+:func:`TSHttpSsnHookAdd` adds :arg:`contp` to
+the end of the list of HTTP :term:`session` hooks specified by :arg:`id`.
+This means that :arg:`contp` is called back for every transaction
+within the session, at the point specified by the hook ID. Since
+:arg:`contp` is added to a session, it is not possible to call
+:func:`TSHttpSsnHookAdd` from the plugin initialization routine;
+the plugin needs a handle to an HTTP session.
+
+:func:`TSHttpTxnHookAdd` adds :arg:`contp`
+to the end of the list of HTTP transaction hooks specified by
+:arg:`id`. Since :arg:`contp` is added to a transaction, it is
+not possible to call :func:`TSHttpTxnHookAdd` from the plugin
+initialization routine but only when the plugin has a handle to an
+HTTP transaction.
+
+Return Values
+=============
+
+None. Adding hooks is always successful.
+
+Examples
+========
+
+The following example demonstrates how to add global, session and
+transaction hooks::
+
+    #include <ts/ts.h>
+
+    static int
+    handler(TSCont contp, TSEvent event, void *edata)
+    {
+        TSHttpSsn ssnp;
+        TSHttpTxn txnp;
+
+        switch (event){
+        case TS_EVENT_HTTP_SSN_START:
+            ssnp = (TSHttpSsn) edata;
+            // Add a session hook ...
+            TSHttpSsnHookAdd(ssnp, TS_HTTP_TXN_START_HOOK, contp);
+            TSHttpSsnReenable(ssnp, TS_EVENT_HTTP_CONTINUE);
+            return 0;
+        case TS_EVENT_HTTP_TXN_START:
+            txnp = (TSHttpTxn) edata;
+            // Add a transaction hook ...
+            TSHttpTxnHookAdd(ssnp, TS_HTTP_READ_REQUEST_HDR_HOOK, contp);
+            TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE);
+            return 0;
+        default:
+             break;
+        }
+
+        return 0;
+    }
+
+    void
+    TSPluginInit (int argc, const char *argv[])
+    {
+        TSCont contp;
+        contp = TSContCreate(handler, NULL);
+        TSHttpHookAdd(TS_HTTP_SSN_START_HOOK, contp);
+    }
+
+See Also
+========
+
+:manpage:`TSAPI(3ts)`,
+:manpage:`TSContCreate(3ts)`,
+:manpage:`TSLifecycleHookAdd(3ts)`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpIsInternalRequest.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpIsInternalRequest.en.rst b/doc/developer-guide/api/functions/TSHttpIsInternalRequest.en.rst
new file mode 100644
index 0000000..648382b
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpIsInternalRequest.en.rst
@@ -0,0 +1,70 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpIsInternalRequest
+***********************
+
+Test whether a request is internally-generated.
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpIsInternalRequest(TSHttpTxn txnp)
+.. function:: TSReturnCode TSHttpIsInternalSession(TSHttpSsn ssnp)
+
+Description
+===========
+
+:func:`TSHttpIsInternalRequest` tests whether a HTTP transaction
+was originated within Traffic Server.
+
+.. admonition:: Deprecated
+
+   Deprecated
+
+:func:`TSHttpIsInternalSession` tests whether a HTTP session
+was originated within Traffic Server.
+
+.. admonition:: Deprecated
+
+   Deprecated
+
+Return Values
+=============
+
+Both these APIs returns a :type:`TSReturnCode`, indicating whether the
+object was internal (:data:`TS_SUCCESS`) or not (:data:`TS_ERROR`).
+
+Examples
+========
+
+The ESI plugin uses :func:`TSHttpIsInternalRequest` to ignore requests that it
+had generated while fetching portions of an ESI document:
+
+.. literalinclude:: ../../../plugins/experimental/esi/esi.cc
+  :language: c
+  :lines: 1395-1398
+
+See Also
+========
+
+:manpage:`TSAPI(3ts)`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst
new file mode 100644
index 0000000..298124d
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpOverridableConfig.en.rst
@@ -0,0 +1,162 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpOverridableConfig
+***********************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. type:: TSOverridableConfigKey
+
+.. function:: TSReturnCode TSHttpTxnConfigIntSet(TSHttpTxn txnp, TSOverridableConfigKey key, TSMgmtInt value)
+.. function:: TSReturnCode TSHttpTxnConfigIntGet(TSHttpTxn txnp, TSOverridableConfigKey key, TSMgmtInt* value)
+.. function:: TSReturnCode TSHttpTxnConfigFloatSet(TSHttpTxn txnp, TSOverridableConfigKey key, TSMgmtFloat value)
+.. function:: TSReturnCode TSHttpTxnConfigFloatGet(TSHttpTxn txnp, TSOverridableConfigKey key, TSMgmtFloat* value)
+.. function:: TSReturnCode TSHttpTxnConfigStringSet(TSHttpTxn txnp, TSOverridableConfigKey key, const char* value, int length)
+.. function:: TSReturnCode TSHttpTxnConfigStringGet(TSHttpTxn txnp, TSOverridableConfigKey key, const char** value, int* length)
+.. function:: TSReturnCode TSHttpTxnConfigFind(const char* name, int length, TSOverridableConfigKey* key, TSRecordDataType* type)
+
+Description
+===========
+
+Some of the values that are set in :file:`records.config` can be changed for a
+specific transaction. It is important to note that these functions change the
+configuration values stored for the transation, which is not quite the same as
+changing the actual operating values of the transaction. The critical effect is
+the value must be changed before it is used by the transaction - after that,
+changes will not have any effect.
+
+All of the ``...Get`` functions store the internal value in the storage
+indicated by the :arg:`value` argument. For strings :arg:`length*` will receive
+the length of the string.
+
+The values are identified by the enumeration :type:`TSOverridableConfigKey`.
+String values can be used indirectly by first passing them to
+:func:`TSHttpTxnConfigFind` which, if the string matches an overridable value,
+return the key and data type.
+
+Configurations
+==============
+
+The following configurations (from ``records.config``) are overridable.
+
+|   :ts:cv:`proxy.config.url_remap.pristine_host_hdr`
+|   :ts:cv:`proxy.config.http.chunking_enabled`
+|   :ts:cv:`proxy.config.http.negative_caching_enabled`
+|   :ts:cv:`proxy.config.http.negative_caching_lifetime`
+|   :ts:cv:`proxy.config.http.cache.when_to_revalidate`
+|   :ts:cv:`proxy.config.http.keep_alive_enabled_in`
+|   :ts:cv:`proxy.config.http.keep_alive_enabled_out`
+|   :ts:cv:`proxy.config.http.keep_alive_post_out`
+|   :ts:cv:`proxy.config.net.sock_recv_buffer_size_out`
+|   :ts:cv:`proxy.config.net.sock_send_buffer_size_out`
+|   :ts:cv:`proxy.config.net.sock_option_flag_out`
+|   :ts:cv:`proxy.config.http.forward.proxy_auth_to_parent`
+|   :ts:cv:`proxy.config.http.anonymize_remove_from`
+|   :ts:cv:`proxy.config.http.anonymize_remove_referer`
+|   :ts:cv:`proxy.config.http.anonymize_remove_user_agent`
+|   :ts:cv:`proxy.config.http.anonymize_remove_cookie`
+|   :ts:cv:`proxy.config.http.anonymize_remove_client_ip`
+|   :ts:cv:`proxy.config.http.anonymize_insert_client_ip`
+|   :ts:cv:`proxy.config.http.response_server_enabled`
+|   :ts:cv:`proxy.config.http.insert_squid_x_forwarded_for`
+|   :ts:cv:`proxy.config.http.server_tcp_init_cwnd`
+|   :ts:cv:`proxy.config.http.send_http11_requests`
+|   :ts:cv:`proxy.config.http.cache.http`
+|   :ts:cv:`proxy.config.http.cache.cluster_cache_local`
+|   :ts:cv:`proxy.config.http.cache.ignore_client_no_cache`
+|   :ts:cv:`proxy.config.http.cache.ignore_client_cc_max_age`
+|   :ts:cv:`proxy.config.http.cache.ims_on_client_no_cache`
+|   :ts:cv:`proxy.config.http.cache.ignore_server_no_cache`
+|   :ts:cv:`proxy.config.http.cache.cache_responses_to_cookies`
+|   :ts:cv:`proxy.config.http.cache.ignore_authentication`
+|   :ts:cv:`proxy.config.http.cache.cache_urls_that_look_dynamic`
+|   :ts:cv:`proxy.config.http.cache.required_headers`
+|   :ts:cv:`proxy.config.http.insert_request_via_str`
+|   :ts:cv:`proxy.config.http.insert_response_via_str`
+|   :ts:cv:`proxy.config.http.cache.heuristic_min_lifetime`
+|   :ts:cv:`proxy.config.http.cache.heuristic_max_lifetime`
+|   :ts:cv:`proxy.config.http.cache.guaranteed_min_lifetime`
+|   :ts:cv:`proxy.config.http.cache.guaranteed_max_lifetime`
+|   :ts:cv:`proxy.config.http.cache.max_stale_age`
+|   :ts:cv:`proxy.config.http.keep_alive_no_activity_timeout_in`
+|   :ts:cv:`proxy.config.http.keep_alive_no_activity_timeout_out`
+|   :ts:cv:`proxy.config.http.transaction_no_activity_timeout_in`
+|   :ts:cv:`proxy.config.http.transaction_no_activity_timeout_out`
+|   :ts:cv:`proxy.config.http.transaction_active_timeout_out`
+|   :ts:cv:`proxy.config.http.origin_max_connections`
+|   :ts:cv:`proxy.config.http.connect_attempts_max_retries`
+|   :ts:cv:`proxy.config.http.connect_attempts_max_retries_dead_server`
+|   :ts:cv:`proxy.config.http.connect_attempts_rr_retries`
+|   :ts:cv:`proxy.config.http.connect_attempts_timeout`
+|   :ts:cv:`proxy.config.http.post_connect_attempts_timeout`
+|   :ts:cv:`proxy.config.http.down_server.cache_time`
+|   :ts:cv:`proxy.config.http.down_server.abort_threshold`
+|   :ts:cv:`proxy.config.http.cache.fuzz.time`
+|   :ts:cv:`proxy.config.http.cache.fuzz.min_time`
+|   :ts:cv:`proxy.config.http.doc_in_cache_skip_dns`
+|   :ts:cv:`proxy.config.http.background_fill_active_timeout`
+|   :ts:cv:`proxy.config.http.response_server_str`
+|   :ts:cv:`proxy.config.http.cache.heuristic_lm_factor`
+|   :ts:cv:`proxy.config.http.cache.fuzz.probability`
+|   :ts:cv:`proxy.config.http.background_fill_completed_threshold`
+|   :ts:cv:`proxy.config.net.sock_packet_mark_out`
+|   :ts:cv:`proxy.config.net.sock_packet_tos_out`
+|   :ts:cv:`proxy.config.http.insert_age_in_response`
+|   :ts:cv:`proxy.config.http.chunking.size`
+|   :ts:cv:`proxy.config.http.flow_control.enabled`
+|   :ts:cv:`proxy.config.http.flow_control.low_water`
+|   :ts:cv:`proxy.config.http.flow_control.high_water`
+|   :ts:cv:`proxy.config.http.cache.range.lookup`
+|   :ts:cv:`proxy.config.http.normalize_ae_gzip`
+|   :ts:cv:`proxy.config.http.default_buffer_size`
+|   :ts:cv:`proxy.config.http.default_buffer_water_mark`
+|   :ts:cv:`proxy.config.http.request_header_max_size`
+|   :ts:cv:`proxy.config.http.response_header_max_size`
+|   :ts:cv:`proxy.config.http.negative_revalidating_enabled`
+|   :ts:cv:`proxy.config.http.negative_revalidating_lifetime`
+|   :ts:cv:`proxy.config.http.accept_encoding_filter_enabled`
+|   :ts:cv:`proxy.config.http.cache.range.write`
+|   :ts:cv:`proxy.config.http.global_user_agent_header`
+|   :ts:cv:`proxy.config.http.slow.log.threshold`
+
+Examples
+========
+
+Enable :ref:`transaction buffer control <transaction-buffering-control>` with a
+high water mark of :literal:`262144` and a low water mark of :literal:`65536`. ::
+
+   int callback(TSCont contp, TSEvent event, void* data)
+   {
+      TSHttpTxn txnp = static_cast<TSHttpTxn>(data);
+      TSHttpTxnConfigIntSet(txnp, TS_CONFIG_HTTP_FLOW_CONTROL_ENABLED, 1);
+      TSHttpTxnConfigIntSet(txnp, TS_CONFIG_HTTP_FLOW_CONTROL_HIGH_WATER_MARK, 262144);
+      TSHttpTxnConfigIntSet(txnp, TS_CONFIG_HTTP_FLOW_CONTROL_LOWER_WATER_MARK, 65536);
+      return 0;
+   }
+
+See Also
+========
+
+:manpage:`TSAPI(3ts)`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpParserCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpParserCreate.en.rst b/doc/developer-guide/api/functions/TSHttpParserCreate.en.rst
new file mode 100644
index 0000000..8d7c2da
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpParserCreate.en.rst
@@ -0,0 +1,91 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpParserCreate
+******************
+
+Parse HTTP headers from memory buffers.
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSHttpParser TSHttpParserCreate(void)
+.. function:: void TSHttpParserClear(TSHttpParser parser)
+.. function:: void TSHttpParserDestroy(TSHttpParser parser)
+.. function:: TSParseResult TSHttpHdrParseReq(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)
+.. function:: TSParseResult TSHttpHdrParseResp(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)
+
+Description
+===========
+
+:func:`TSHttpParserCreate` creates an HTTP parser object. The
+parser's data structure contains information about the header being
+parsed. A single HTTP parser can be used multiple times, though not
+simultaneously. Before being used again, the parser must be cleared
+by calling :func:`TSHttpParserClear`.
+
+:func:`TSHttpHdrParseReq` parses an HTTP request header. The HTTP
+header :arg:`offset` must already be created, and must reside
+inside the marshal buffer :arg:`bufp`. The :arg:`start` argument
+points to the current position of the string buffer being parsed
+and the :arg:`end` argument points to one byte after the end of
+the buffer to be parsed. On return, :arg:`start` is modified to
+point past the last character parsed.
+
+It is possible to parse an HTTP request header a single byte at a
+time using repeated calls to :func:`TSHttpHdrParseReq`. As long as
+an error does not occur, the :func:`TSHttpHdrParseReq` function
+will consume that single byte and ask for more. :func:`TSHttpHdrParseReq`
+should be called after :data:`TS_HTTP_READ_REQUEST_HDR_HOOK`.
+
+:func:`TSHttpHdrParseResp` operates in the same manner as
+:func:`TSHttpHdrParseReq` except it parses an HTTP response header.
+It should be called after :data:`TS_HTTP_READ_RESPONSE_HDR_HOOK`.
+
+:func:`TSHttpParserClear` clears the specified HTTP parser so it
+may be used again.
+
+:func:`TSHttpParserDestroy` destroys the TSHttpParser object pointed
+to by :arg:`parser`. The :arg:`parser` pointer must not be NULL.
+
+Return Salues
+=============
+
+:func:`TSHttpHdrParseReq` and :func:`TSHttpHdrParseResp` both return
+a :type:`TSParseResult` value. :data:`TS_PARSE_ERROR` is returned
+on error, :data:`TS_PARSE_CONT` is returned if parsing of the header
+stopped because the end of the buffer was reached, and
+:data:`TS_PARSE_DONE` or :data:`TS_PARSE_OK` when a \\r\\n\\r\\n
+pattern is encountered, indicating the end of the header.
+
+Known Bugs
+==========
+
+The distinction between the :data:`TS_PARSE_DONE` and :data:`TS_PARSE_OK`
+results is not well-defined. Plugins should expect both status codes and
+treat them equivalently.
+
+See Also
+========
+
+:manpage:`TSAPI(3ts)`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpSsnReenable.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpSsnReenable.en.rst b/doc/developer-guide/api/functions/TSHttpSsnReenable.en.rst
new file mode 100644
index 0000000..9dd0002
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpSsnReenable.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpSsnReenable
+*****************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: void TSHttpSsnReenable(TSHttpSsn ssnp, TSEvent event)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnCacheLookupStatusGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnCacheLookupStatusGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnCacheLookupStatusGet.en.rst
new file mode 100644
index 0000000..d9d1b6f
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnCacheLookupStatusGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnCacheLookupStatusGet
+*****************************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnCacheLookupStatusGet(TSHttpTxn txnp, int * lookup_status)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnCacheLookupUrlGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnCacheLookupUrlGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnCacheLookupUrlGet.en.rst
new file mode 100644
index 0000000..7f65459
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnCacheLookupUrlGet.en.rst
@@ -0,0 +1,59 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnCacheLookupUrlGet
+**************************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnCacheLookupUrlGet(TSHttpTxn txnp, TSMBuffer bufp, TSMLoc offset)
+
+Description
+===========
+
+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()`.
+
+TSHttpTxnCacheLookupUrlSet
+==========================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSReturnCode TSHttpTxnCacheLookupUrlSet(TSHttpTxn txnp, TSMBuffer bufp, TSMLoc offset)
+
+Description
+-----------
+
+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()`.
+
+This API can be called as early as ``TS_HTTP_READ_REQUEST_HDR_HOOK`` but no later than
+``TS_HTTP_POST_REMAP_HOOK``. This is the preferred and most efficient way to
+modify the cache key, but an alternative is to use the old
+:c:func:`TSCacheUrlSet()`, which takes a simple string as argument.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnCachedReqGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnCachedReqGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnCachedReqGet.en.rst
new file mode 100644
index 0000000..7fb6117
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnCachedReqGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnCachedReqGet
+*********************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnCachedReqGet(TSHttpTxn txnp, TSMBuffer * bufp, TSMLoc * offset)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnCachedRespGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnCachedRespGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnCachedRespGet.en.rst
new file mode 100644
index 0000000..1582303
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnCachedRespGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnCachedRespGet
+**********************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnCachedRespGet(TSHttpTxn txnp, TSMBuffer * bufp, TSMLoc * offset)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnClientPacketDscpSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnClientPacketDscpSet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnClientPacketDscpSet.en.rst
new file mode 100644
index 0000000..0370735
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnClientPacketDscpSet.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
+
+.. default-domain:: c
+
+TSHttpTxnClientPacketDscpSet
+****************************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnClientPacketDscpSet(TSHttpTxn txnp, int dscp)
+
+Description
+===========
+
+Change packet :arg:`dscp` for the client side connection.
+
+.. important::
+
+   Changes take effect immediately.
+
+See Also
+========
+
+`Traffic Shaping`_
+
+.. _Traffic Shaping:
+                 https://cwiki.apache.org/confluence/display/TS/Traffic+Shaping

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnClientPacketMarkSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnClientPacketMarkSet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnClientPacketMarkSet.en.rst
new file mode 100644
index 0000000..437f528
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnClientPacketMarkSet.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
+
+.. default-domain:: c
+
+TSHttpTxnClientPacketMarkSet
+****************************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnClientPacketMarkSet(TSHttpTxn txnp, int mark)
+
+Description
+===========
+
+Change packet firewall :arg:`mark` for the client side connection.
+
+.. note::
+
+   Changes take effect immediately.
+
+See Also
+========
+
+.. _Traffic Shaping:
+                 https://cwiki.apache.org/confluence/display/TS/Traffic+Shaping
+   :ts:cv:`proxy.config.net.sock_packet_mark_in` and TS-1090

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnClientPacketTosSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnClientPacketTosSet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnClientPacketTosSet.en.rst
new file mode 100644
index 0000000..f1b694b
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnClientPacketTosSet.en.rst
@@ -0,0 +1,50 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnClientPacketTosSet
+***************************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnClientPacketTosSet(TSHttpTxn txnp, int tos)
+
+Description
+===========
+
+Change packet :arg:`tos` for the client side connection.
+
+.. important::
+
+   Changes take effect immediately
+
+.. note::
+
+   TOS is deprecated and replaced by DSCP. This is still used to set
+   DSCP, however the first 2 bits of this value will be ignored as they
+   now belong to the ECN field.
+
+See Also
+========
+
+.. _Traffic Shaping:
+                 https://cwiki.apache.org/confluence/display/TS/Traffic+Shaping
+   :ts:cv:`proxy.config.net.sock_packet_tos_in` and TS-1090

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnClientReqGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnClientReqGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnClientReqGet.en.rst
new file mode 100644
index 0000000..96b8541
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnClientReqGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnClientReqGet
+*********************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnClientReqGet(TSHttpTxn txnp, TSMBuffer * bufp, TSMLoc * offset)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnClientRespGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnClientRespGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnClientRespGet.en.rst
new file mode 100644
index 0000000..cd93d94
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnClientRespGet.en.rst
@@ -0,0 +1,32 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnClientRespGet
+**********************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnClientRespGet(TSHttpTxn txnp, TSMBuffer * bufp, TSMLoc * offset)
+
+Description
+===========

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnErrorBodySet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnErrorBodySet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnErrorBodySet.en.rst
new file mode 100644
index 0000000..cee7207
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnErrorBodySet.en.rst
@@ -0,0 +1,39 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnErrorBodySet
+*********************
+
+Sets an error type body to a transaction.
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: void TSHttpTxnErrorBodySet(TSHttpTxn txnp, char * buf, size_t buflength, char * mimetype)
+
+Description
+===========
+
+Note that both string arguments must be allocated with :c:func:`TSmalloc` or
+:c:func:`TSstrdup`.  The :arg:`mimetype` is optional, and if not provided it
+defaults to :literal:`text/html`. Sending an empty string would prevent setting
+a content type header (but that is not adviced).

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnIntercept.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnIntercept.en.rst b/doc/developer-guide/api/functions/TSHttpTxnIntercept.en.rst
new file mode 100644
index 0000000..e221049
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnIntercept.en.rst
@@ -0,0 +1,51 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnIntercept
+******************
+
+Allows a plugin take over the servicing of the request as though it was the
+origin server.
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: void TSHttpTxnIntercept(TSCont contp, TSHttpTxn txnp)
+
+Description
+===========
+
+:arg:`contp` will be sent :data:`TS_EVENT_NET_ACCEPT`. The edata passed
+with :data:`TS_NET_EVENT_ACCEPT` is an :c:type:`TSVConn` just as it
+would be for a normal accept. The plugin must act as if it is an HTTP
+server and read the HTTP request and body off the :c:type:`TSVConn`
+and send an HTTP response header and body.
+
+:func:`TSHttpTxnIntercept` must be called be called from only
+:data:`TS_HTTP_READ_REQUEST_HOOK`.  Using
+:type:`TSHttpTxnIntercept` will bypass the Traffic Server cache.  If
+response sent by the plugin should be cached, use
+:func:`TSHttpTxnServerIntercept` instead.
+:func:`TSHttpTxnIntercept` primary use is allow plugins to serve
+data about their functioning directly.
+
+:func:`TSHttpTxnIntercept` must only be called once per transaction.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst
new file mode 100644
index 0000000..76f92fa
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst
@@ -0,0 +1,104 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnMilestoneGet
+*********************
+
+Get a specified :arg:`milestone` timer value for the current transaction.
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnMilestoneGet(TSHttpTxn txnp, TSMilestonesType milestone, TSHRTime * time)
+
+Description
+===========
+
+:func:`TSHttpTxnMilestoneGet` will fetch a specific :arg:`milestone` timer
+value for the transaction :arg:`txnp`. These timers are calculated during the
+lifetime of a transaction and are measured in nanoseconds from the beginning of
+the transaction. :arg:`time` is used a pointer to storage to update if the call
+is successful.
+
+.. type:: TSMilestonesType
+
+=============================================== ==========
+Value                                           Milestone
+=============================================== ==========
+:const:`TS_MILESTONE_UA_BEGIN`                  The client connection is accepted.
+:const:`TS_MILESTONE_UA_READ_HEADER_DONE`       The request header from the client has been read and parsed.
+:const:`TS_MILESTONE_UA_BEGIN_WRITE`            The response header write to the client starts.
+:const:`TS_MILESTONE_UA_CLOSE`                  Last I/O activity on the client socket, or connection abort.
+:const:`TS_MILESTONE_SERVER_FIRST_CONNECT`      First time origin server connect attempted or shared shared session attached.
+:const:`TS_MILESTONE_SERVER_CONNECT`            Most recent time origin server connect attempted or shared session attached.
+:const:`TS_MILESTONE_SERVER_CONNECT_END`        More recent time a connection attempt was resolved.
+:const:`TS_MILESTONE_SERVER_BEGIN_WRITE`        First byte is written to the origin server connection.
+:const:`TS_MILESTONE_SERVER_FIRST_READ`         First byte is read from connection to origin server.
+:const:`TS_MILESTONE_SERVER_READ_HEADER_DONE`   Origin server response has been read and parsed.
+:const:`TS_MILESTONE_SERVER_CLOSE`              Last I/O activity on origin server connection.
+:const:`TS_MILESTONE_CACHE_OPEN_READ_BEGIN`     Initiate read of the cache.
+:const:`TS_MILESTONE_CACHE_OPEN_READ_END`       Initial cache read has resolved.
+:const:`TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN`    Start open for cache write.
+:const:`TS_MILESTONE_CACHE_OPEN_WRITE_END`      Cache has been opened for write.
+:const:`TS_MILESTONE_DNS_LOOKUP_BEGIN`          Initiate host resolution in HostDB
+:const:`TS_MILESTONE_DNS_LOOKUP_END`            Host resolution resolves.
+:const:`TS_MILESTONE_SM_START`                  Transaction state machine is initialized.
+:const:`TS_MILESTONE_SM_FINISH`                 Transaction has finished, state machine final logging has started.
+:const:`TS_MILESTONE_PLUGIN_ACTIVE`             Amount of time plugins were active plus start time.
+:const:`TS_MILESTONE_PLUGIN_TOTAL`              Wall time while plugins were active plus start time.
+=============================================== ==========
+
+*  The server connect times predate the transmission of the `:literal:`SYN`
+   packet. That is, before a connection to the origin server is completed.
+
+*  A connection attempt is resolved when no more connection related activity
+   remains to be done, and the connection is either established or has failed.
+
+*  :const:`TS_MILESTONE_UA_CLOSE` and :const:`TS_MILESTONE_SERVER_CLOSE` are
+   updated continuously during the life of the transaction, every time there is
+   I/O activity. The updating stops when the corresponding connection is
+   closed, leaving the last I/O time as the final value.
+
+*  The cache :literal:`OPEN` milestones time only the initial setup, the
+   *open*, not the full read or write.
+
+*  :const:`TS_MILESTONE_PLUGIN_ACTIVE` and :const:`TS_MILESTONE_PLUGIN_TOTAL` are different from the other milestones as
+   they measure elapsed time, not event time. The value is the elapsed time *plus* :const:`TS_MILESTONE_SM_START`. This
+   was decided to be more convenient because then these milestones can be handled / displayed in the same way as the
+   other milestones, as offsets from :const:`TS_MILESTONE_SM_START`.
+
+   :const:`TS_MILESTONE_PLUGIN_ACTIVE` value is the amount of time the plugin was active, that is performing
+   computation. :const:`TS_MILESTONE_PLUGIN_TOTAL` is the wall time which includes any time the transaction was blocked
+   while a plugin was active. For instance if a plugin waits on an external event, that waiting time will be in
+   :const:`TS_MILESTONE_PLUGIN_TOTAL` but not in :const:`TS_MILESTONE_PLUGIN_ACTIVE`.
+
+Return Values
+=============
+
+:const:`TS_SUCCESS` if successful and :arg:`time` was updated, otherwise
+:const:`TS_ERROR`.
+
+See Also
+========
+
+:manpage:`TSAPI(3ts)`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnNextHopAddrGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnNextHopAddrGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnNextHopAddrGet.en.rst
new file mode 100644
index 0000000..366acdb
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnNextHopAddrGet.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
+
+.. default-domain:: c
+
+TSHttpTxnNextHopAddrGet
+***********************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: sockaddr const * TSHttpTxnNextHopAddrGet(TSHttpTxn txnp)
+
+Description
+===========
+
+Get the next hop address for transaction :arg:`txnp`.
+
+.. note::
+
+   The pointer is valid only for the current callback. Clients that
+   need to keep the value across callbacks must maintain their own
+   storage.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnParentProxySet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnParentProxySet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnParentProxySet.en.rst
new file mode 100644
index 0000000..daae59a
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnParentProxySet.en.rst
@@ -0,0 +1,37 @@
+.. 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
+
+.. default-domain:: c
+
+TSHttpTxnParentProxySet
+***********************
+
+Sets the parent proxy :arg:`hostname` and :arg:`port`.
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: void TSHttpTxnParentProxySet(TSHttpTxn txnp, char * hostname, int port)
+
+Description
+===========
+
+The string :arg:`hostname` is copied into the :c:type:`TSHttpTxn`. You can
+modify or delete the string after calling :c:func:`TSHttpTxnParentProxySet`.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnReenable.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnReenable.en.rst b/doc/developer-guide/api/functions/TSHttpTxnReenable.en.rst
new file mode 100644
index 0000000..4fc364a
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnReenable.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
+
+.. default-domain:: c
+
+TSHttpTxnReenable
+*****************
+
+Notifies the HTTP transaction txnp that the plugin is finished
+processing the current hook.
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: void TSHttpTxnReenable(TSHttpTxn txnp, TSEvent event)
+
+Description
+===========
+
+The plugin tells the transaction :arg:`txnp` to either continue
+(:data:`TS_EVENT_HTTP_CONTINUE`) or stop (:data:`TS_EVENT_HTTP_ERROR`).
+
+.. important::
+
+   You must always reenable the HTTP transaction after the processing of
+   each transaction event.  However, never reenable twice.  Reenabling
+   twice is a serious error.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/developer-guide/api/functions/TSHttpTxnServerAddrGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/developer-guide/api/functions/TSHttpTxnServerAddrGet.en.rst b/doc/developer-guide/api/functions/TSHttpTxnServerAddrGet.en.rst
new file mode 100644
index 0000000..102c30f
--- /dev/null
+++ b/doc/developer-guide/api/functions/TSHttpTxnServerAddrGet.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
+
+.. default-domain:: c
+
+TSHttpTxnServerAddrGet
+**********************
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: sockaddr const* TSHttpTxnServerAddrGet(TSHttpTxn txnp)
+
+Description
+===========
+
+Get the origin server address for transaction :arg:`txnp`.
+
+.. note::
+
+   The pointer is valid only for the current callback. Clients that
+   need to keep the value across callbacks must maintain their own
+   storage.


Mime
View raw message