Doc: Add glossary, fix type API reference page.
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/216ecdab Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/216ecdab Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/216ecdab Branch: refs/heads/5.0.x Commit: 216ecdabf3b69cc2fefd1d864c86a228d0c26819 Parents: a1d747e Author: Alan M. Carroll <a...@network-geographics.com> Authored: Mon Aug 26 14:12:15 2013 -0500 Committer: Alan M. Carroll <a...@network-geographics.com> Committed: Mon Aug 26 14:12:15 2013 -0500 ---------------------------------------------------------------------- doc/glossary.en.rst | 36 ++++++++++++++++++ doc/index.rst | 27 ++++++------- doc/reference/api/TSHttpHookAdd.en.rst | 33 +++++++--------- doc/reference/api/TSPluginInit.en.rst | 6 +-- doc/reference/api/TSTypes.en.rst | 59 +++++++++++++++++++++++++++++ 5 files changed, 125 insertions(+), 36 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/216ecdab/doc/glossary.en.rst ---------------------------------------------------------------------- diff --git a/doc/glossary.en.rst b/doc/glossary.en.rst new file mode 100644 index 0000000..d33bf19 --- /dev/null +++ b/doc/glossary.en.rst @@ -0,0 +1,36 @@ +.. 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. + +============= +Glossary +============= + +.. glossary:: + + continuation + A callable object that contains state. These are are mechanism used by Traffic Server to implement callbacks and + continued computations. Continued computations are critical to efficient processing of traffic because by avoiding + any blocking operations that wait on external events. In any such case a continuation is used so that other + processing can continue until the external event occurs. At that point the continuation is invoked to continue the + suspended processing. This can be considered similar to co-routines. + + session + A single connection from a client to Traffic Server, covering all requests and responses on that connection. + + transaction + A client request and response, either from the origin server or from the cache. + http://git-wip-us.apache.org/repos/asf/trafficserver/blob/216ecdab/doc/index.rst ---------------------------------------------------------------------- diff --git a/doc/index.rst b/doc/index.rst index a665ea1..aed32f0 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,20 +3,20 @@ Apache Traffic Server .. 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 - + 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. + + 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. Apache Traffic Server⢠speeds Internet access, enhances website @@ -44,6 +44,7 @@ bandwidth. reference/plugins/index.en reference/api/index.en arch/index.en + glossary.en Indices and tables ================== http://git-wip-us.apache.org/repos/asf/trafficserver/blob/216ecdab/doc/reference/api/TSHttpHookAdd.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/api/TSHttpHookAdd.en.rst b/doc/reference/api/TSHttpHookAdd.en.rst index 27b2de1..1c4fa08 100644 --- a/doc/reference/api/TSHttpHookAdd.en.rst +++ b/doc/reference/api/TSHttpHookAdd.en.rst @@ -1,19 +1,19 @@ .. 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 - + 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. + + 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 @@ -29,13 +29,6 @@ Synopsis .. function:: void TSHttpSsnHookAdd(TSHttpSsn ssnp, TSHttpHookID id, TSCont contp) .. function:: void TSHttpTxnHookAdd(TSHttpTxn txnp, TSHttpHookID id, TSCont contp) -.. rubric:: Opaque types - -.. type:: TSHttpTxn -.. type:: TSHttpSsn -.. type:: TSHttpHookID -.. type:: TSCont - Description =========== http://git-wip-us.apache.org/repos/asf/trafficserver/blob/216ecdab/doc/reference/api/TSPluginInit.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/api/TSPluginInit.en.rst b/doc/reference/api/TSPluginInit.en.rst index ad75d9b..db84bda 100644 --- a/doc/reference/api/TSPluginInit.en.rst +++ b/doc/reference/api/TSPluginInit.en.rst @@ -5,9 +5,9 @@ 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. @@ -47,7 +47,7 @@ is running supports the plugin. Return values ============= -:func:`TSPluginRegister` returns :data:`TS_ERROR` if the plugin registration failed. +:func:`TSPluginRegister` returns :const:`TS_ERROR` if the plugin registration failed. Examples ======== http://git-wip-us.apache.org/repos/asf/trafficserver/blob/216ecdab/doc/reference/api/TSTypes.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/api/TSTypes.en.rst b/doc/reference/api/TSTypes.en.rst new file mode 100644 index 0000000..adc8b38 --- /dev/null +++ b/doc/reference/api/TSTypes.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. + +.. 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. + +.. type:: TSCont + + An opaque type that represents a Traffic Server :term:`continuation`. + +.. type:: TSHttpHookID + + An enumeration that identifies a specific type of hook for HTTP transactions. + +.. type:: TSHttpSsn + + An opaque type that represents a Traffic Server :term:`session`. + +.. type:: TSHRTime + + "High Resolution Time" + + A 64 bit time value, measured in nanoseconds. + +.. type:: TSHttpTxn + + An opaque type that represents a Traffic Server HTTP :term:`transaction`. + +.. 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. +
