trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jpe...@apache.org
Subject [1/3] docs: Add stubs for references that currently contribute warnings to the Sphinx build
Date Mon, 12 May 2014 21:28:28 GMT
Repository: trafficserver
Updated Branches:
  refs/heads/master 4361cd46a -> a549c3126


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSThreadSelf.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSThreadSelf.en.rst b/doc/reference/api/TSThreadSelf.en.rst
new file mode 100644
index 0000000..efeed83
--- /dev/null
+++ b/doc/reference/api/TSThreadSelf.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.
+
+
+TSThreadSelf
+============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSThread TSThreadSelf(void)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSTransformCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTransformCreate.en.rst b/doc/reference/api/TSTransformCreate.en.rst
new file mode 100644
index 0000000..3950eb4
--- /dev/null
+++ b/doc/reference/api/TSTransformCreate.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.
+
+
+TSTransformCreate
+=================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSVConn TSTransformCreate(TSEventFunc event_funcp, TSHttpTxn txnp)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSTransformOutputVConnGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTransformOutputVConnGet.en.rst b/doc/reference/api/TSTransformOutputVConnGet.en.rst
new file mode 100644
index 0000000..8ff170a
--- /dev/null
+++ b/doc/reference/api/TSTransformOutputVConnGet.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.
+
+
+TSTransformOutputVConnGet
+=========================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSVConn TSTransformOutputVConnGet(TSVConn connp)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSTypes.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSTypes.en.rst b/doc/reference/api/TSTypes.en.rst
index 4c4641e..a3f5a14 100644
--- a/doc/reference/api/TSTypes.en.rst
+++ b/doc/reference/api/TSTypes.en.rst
@@ -35,13 +35,18 @@ function group, but others are used more widely. Those are described on this pag
 
    An opaque type that represents a Traffic Server :term:`continuation`.
 
-.. type:: TSHttpHookID
+.. type:: TSEvent
 
-   An enumeration that identifies a specific type of hook for HTTP transactions.
+   :type:`TSEvents` are sent to continuations when they are called
+   back.
 
-.. type:: TSHttpSsn
+   The :type:`TSEvent` provides the continuation's handler function
+   with information about the callback.  Based on the event it
+   receives, the handler function can decide what to do.
 
-   An opaque type that represents a Traffic Server :term:`session`.
+.. type:: TSEventFunc
+
+.. type:: TSHostLookupResult
 
 .. type:: TSHRTime
 
@@ -49,29 +54,86 @@ function group, but others are used more widely. Those are described on this pag
 
    A 64 bit time value, measured in nanoseconds.
 
+.. type:: TSHttpHookID
+
+   An enumeration that identifies a specific type of hook for HTTP transactions.
+
+.. type:: TSHttpParser
+
+.. type:: TSHttpSsn
+
+   An opaque type that represents a Traffic Server :term:`session`.
+
 .. type:: TSHttpTxn
 
    An opaque type that represents a Traffic Server HTTP :term:`transaction`.
 
+.. type:: TSIOBuffer
+
+.. type:: TSIOBufferReader
+
+.. type:: TSIOBufferSizeIndex
+
 .. type:: TSLifecycleHookID
 
    An enumeration that identifies a :ref:`life cycle hook <ts-lifecycle-hook-add>`.
 
+.. type:: TSMBuffer
+
+.. type:: TSMgmtFloat
+
+   The type used internally for a floating point value. This corresponds to the value :const:`TS_RECORDDATATYPE_FLOAT` for
+   :type:`TSRecordDataType`.
+
+.. type:: TSMgmtInt
+
+   The type used internally for an integer. This corresponds to the value :const:`TS_RECORDDATATYPE_INT` for
+   :type:`TSRecordDataType`.
+
+.. type:: TSMLoc
+
+.. type:: TSMutex
+
+.. type:: TSParseResult
+
+   This set of enums are possible values returned by
+   :func:`TSHttpHdrParseReq` and :func:`TSHttpHdrParseResp`.
+
+.. type:: TSPluginRegistrationInfo
+
+   The following struct is used by :func:`TSPluginRegister`.
+
+   It stores registration information about the plugin.
+
+.. type:: TSRecordDataType
+
+   An enumeration that specifies the type of a value in an internal data structure that is accessible via the API.
+
+.. type:: TSRemapInterface
+
+.. type:: TSRemapRequestInfo
+
+.. type:: TSRemapStatus
+
 .. type:: TSReturnCode
 
    An indicator of the results of an API call. A value of :const:`TS_SUCCESS` means the call was successful. Any other value
    indicates a failure and is specific to the API call.
 
-.. type:: TSRecordDataType
+.. type:: TSSDKVersion
 
-   An enumeration that specifies the type of a value in an internal data structure that is accessible via the API.
+   Starting 2.0, SDK now follows same versioning as Traffic Server.
 
-.. type:: TSMgmtInt
+.. type:: TSServerState
 
-   The type used internally for an integer. This corresponds to the value :const:`TS_RECORDDATATYPE_INT` for
-   :type:`TSRecordDataType`.
+.. type:: TSTextLogObject
 
-.. type:: TSMgmtFloat
+   This type represents a custom log file that you create with
+   :func:`TSTextLogObjectCreate`.
 
-   The type used internally for a floating point value. This corresponds to the value :const:`TS_RECORDDATATYPE_FLOAT` for
-   :type:`TSRecordDataType`.
+   Your plugin writes entries into this log file using
+   :func:`TSTextLogObjectWrite`.
+
+.. type:: TSVConn
+
+.. type:: TSVIO

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSUrlDestroy.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlDestroy.en.rst b/doc/reference/api/TSUrlDestroy.en.rst
new file mode 100644
index 0000000..68cebbc
--- /dev/null
+++ b/doc/reference/api/TSUrlDestroy.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.
+
+
+TSUrlDestroy
+============
+
+Destroys the URL located at url_loc within the marshal buffer bufp.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSReturnCode TSUrlDestroy(TSMBuffer bufp, TSMLoc offset)
+
+
+Description
+-----------
+
+Do not forget to release the :c:type:`TSMLoc` url_loc with a call to
+:c:func:`TSHandleMLocRelease`.
+
+.. admonition:: Deprecated
+
+   There is no reason to destroy the URL, just release the marshal
+   buffers.
+
+Should be removed for v5.0.0

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSUrlFtpTypeGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlFtpTypeGet.en.rst b/doc/reference/api/TSUrlFtpTypeGet.en.rst
new file mode 100644
index 0000000..f95355a
--- /dev/null
+++ b/doc/reference/api/TSUrlFtpTypeGet.en.rst
@@ -0,0 +1,33 @@
+.. 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.
+
+
+TSUrlFtpTypeGet
+===============
+
+Retrieves the FTP type of the URL located at url_loc within bufp.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: int TSUrlFtpTypeGet(TSMBuffer bufp, TSMLoc offset)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSUrlFtpTypeSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSUrlFtpTypeSet.en.rst b/doc/reference/api/TSUrlFtpTypeSet.en.rst
new file mode 100644
index 0000000..8880bf7
--- /dev/null
+++ b/doc/reference/api/TSUrlFtpTypeSet.en.rst
@@ -0,0 +1,34 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed
+   with this work for additional information regarding copyright
+   ownership.  The ASF licenses this file to you under the Apache
+   License, Version 2.0 (the "License"); you may not use this file
+   except in compliance with the License.  You may obtain a copy of
+   the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied.  See the License for the specific language governing
+   permissions and limitations under the License.
+
+
+TSUrlFtpTypeSet
+===============
+
+Sets the FTP type portion of the URL located at url_loc within bufp to
+the value type.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSReturnCode TSUrlFtpTypeSet(TSMBuffer bufp, TSMLoc offset, int type)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVConnAbort.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnAbort.en.rst b/doc/reference/api/TSVConnAbort.en.rst
new file mode 100644
index 0000000..8eebdbf
--- /dev/null
+++ b/doc/reference/api/TSVConnAbort.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.
+
+
+TSVConnAbort
+============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: void TSVConnAbort(TSVConn connp, int error)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVConnCacheObjectSizeGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnCacheObjectSizeGet.en.rst b/doc/reference/api/TSVConnCacheObjectSizeGet.en.rst
new file mode 100644
index 0000000..8c29974
--- /dev/null
+++ b/doc/reference/api/TSVConnCacheObjectSizeGet.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.
+
+
+TSVConnCacheObjectSizeGet
+=========================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: int64_t TSVConnCacheObjectSizeGet(TSVConn connp)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVConnClose.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnClose.en.rst b/doc/reference/api/TSVConnClose.en.rst
new file mode 100644
index 0000000..8b2baaa
--- /dev/null
+++ b/doc/reference/api/TSVConnClose.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.
+
+
+TSVConnClose
+============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: void TSVConnClose(TSVConn connp)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVConnClosedGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnClosedGet.en.rst b/doc/reference/api/TSVConnClosedGet.en.rst
new file mode 100644
index 0000000..0c14479
--- /dev/null
+++ b/doc/reference/api/TSVConnClosedGet.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.
+
+
+TSVConnClosedGet
+================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: int TSVConnClosedGet(TSVConn connp)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVConnRead.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnRead.en.rst b/doc/reference/api/TSVConnRead.en.rst
new file mode 100644
index 0000000..369d004
--- /dev/null
+++ b/doc/reference/api/TSVConnRead.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.
+
+
+TSVConnRead
+===========
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSVIO TSVConnRead(TSVConn connp, TSCont contp, TSIOBuffer bufp, int64_t nbytes)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVConnReadVIOGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnReadVIOGet.en.rst b/doc/reference/api/TSVConnReadVIOGet.en.rst
new file mode 100644
index 0000000..ec2e7d2
--- /dev/null
+++ b/doc/reference/api/TSVConnReadVIOGet.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.
+
+
+TSVConnReadVIOGet
+=================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSVIO TSVConnReadVIOGet(TSVConn connp)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVConnShutdown.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnShutdown.en.rst b/doc/reference/api/TSVConnShutdown.en.rst
new file mode 100644
index 0000000..c53b210
--- /dev/null
+++ b/doc/reference/api/TSVConnShutdown.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.
+
+
+TSVConnShutdown
+===============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: void TSVConnShutdown(TSVConn connp, int read, int write)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVConnWrite.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnWrite.en.rst b/doc/reference/api/TSVConnWrite.en.rst
new file mode 100644
index 0000000..0080577
--- /dev/null
+++ b/doc/reference/api/TSVConnWrite.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.
+
+
+TSVConnWrite
+============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSVIO TSVConnWrite(TSVConn connp, TSCont contp, TSIOBufferReader readerp, int64_t nbytes)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVConnWriteVIOGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVConnWriteVIOGet.en.rst b/doc/reference/api/TSVConnWriteVIOGet.en.rst
new file mode 100644
index 0000000..3963a28
--- /dev/null
+++ b/doc/reference/api/TSVConnWriteVIOGet.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.
+
+
+TSVConnWriteVIOGet
+==================
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSVIO TSVConnWriteVIOGet(TSVConn connp)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIOBufferGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOBufferGet.en.rst b/doc/reference/api/TSVIOBufferGet.en.rst
new file mode 100644
index 0000000..529b658
--- /dev/null
+++ b/doc/reference/api/TSVIOBufferGet.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.
+
+
+TSVIOBufferGet
+==============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSIOBuffer TSVIOBufferGet(TSVIO viop)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIOContGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOContGet.en.rst b/doc/reference/api/TSVIOContGet.en.rst
new file mode 100644
index 0000000..fe2afd7
--- /dev/null
+++ b/doc/reference/api/TSVIOContGet.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.
+
+
+TSVIOContGet
+============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSCont TSVIOContGet(TSVIO viop)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIOMutexGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOMutexGet.en.rst b/doc/reference/api/TSVIOMutexGet.en.rst
new file mode 100644
index 0000000..1dc30be
--- /dev/null
+++ b/doc/reference/api/TSVIOMutexGet.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.
+
+
+TSVIOMutexGet
+=============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSMutex TSVIOMutexGet(TSVIO viop)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIONBytesGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONBytesGet.en.rst b/doc/reference/api/TSVIONBytesGet.en.rst
new file mode 100644
index 0000000..fcddfb6
--- /dev/null
+++ b/doc/reference/api/TSVIONBytesGet.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.
+
+
+TSVIONBytesGet
+==============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: int64_t TSVIONBytesGet(TSVIO viop)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIONBytesSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONBytesSet.en.rst b/doc/reference/api/TSVIONBytesSet.en.rst
new file mode 100644
index 0000000..f04a2ba
--- /dev/null
+++ b/doc/reference/api/TSVIONBytesSet.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.
+
+
+TSVIONBytesSet
+==============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: void TSVIONBytesSet(TSVIO viop, int64_t nbytes)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIONDoneGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONDoneGet.en.rst b/doc/reference/api/TSVIONDoneGet.en.rst
new file mode 100644
index 0000000..6eec3ea
--- /dev/null
+++ b/doc/reference/api/TSVIONDoneGet.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.
+
+
+TSVIONDoneGet
+=============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: int64_t TSVIONDoneGet(TSVIO viop)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIONDoneSet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONDoneSet.en.rst b/doc/reference/api/TSVIONDoneSet.en.rst
new file mode 100644
index 0000000..a4e7365
--- /dev/null
+++ b/doc/reference/api/TSVIONDoneSet.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.
+
+
+TSVIONDoneSet
+=============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: void TSVIONDoneSet(TSVIO viop, int64_t ndone)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIONTodoGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIONTodoGet.en.rst b/doc/reference/api/TSVIONTodoGet.en.rst
new file mode 100644
index 0000000..14fe707
--- /dev/null
+++ b/doc/reference/api/TSVIONTodoGet.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.
+
+
+TSVIONTodoGet
+=============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: int64_t TSVIONTodoGet(TSVIO viop)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIOReaderGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOReaderGet.en.rst b/doc/reference/api/TSVIOReaderGet.en.rst
new file mode 100644
index 0000000..3b630a4
--- /dev/null
+++ b/doc/reference/api/TSVIOReaderGet.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.
+
+
+TSVIOReaderGet
+==============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSIOBufferReader TSVIOReaderGet(TSVIO viop)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIOReenable.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOReenable.en.rst b/doc/reference/api/TSVIOReenable.en.rst
new file mode 100644
index 0000000..79e8d7b
--- /dev/null
+++ b/doc/reference/api/TSVIOReenable.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.
+
+
+TSVIOReenable
+=============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: void TSVIOReenable(TSVIO viop)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSVIOVConnGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSVIOVConnGet.en.rst b/doc/reference/api/TSVIOVConnGet.en.rst
new file mode 100644
index 0000000..441ab95
--- /dev/null
+++ b/doc/reference/api/TSVIOVConnGet.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.
+
+
+TSVIOVConnGet
+=============
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSVConn TSVIOVConnGet(TSVIO viop)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSfclose.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfclose.en.rst b/doc/reference/api/TSfclose.en.rst
new file mode 100644
index 0000000..4aafd8f
--- /dev/null
+++ b/doc/reference/api/TSfclose.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.
+
+
+TSfclose
+========
+
+Closes the file to which filep points and frees the data structures
+and buffers associated with it.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: void TSfclose(TSFile filep)
+
+
+Description
+-----------
+
+If the file was opened for writing, any pending data is flushed.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSfflush.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfflush.en.rst b/doc/reference/api/TSfflush.en.rst
new file mode 100644
index 0000000..db83b10
--- /dev/null
+++ b/doc/reference/api/TSfflush.en.rst
@@ -0,0 +1,34 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed
+   with this work for additional information regarding copyright
+   ownership.  The ASF licenses this file to you under the Apache
+   License, Version 2.0 (the "License"); you may not use this file
+   except in compliance with the License.  You may obtain a copy of
+   the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied.  See the License for the specific language governing
+   permissions and limitations under the License.
+
+
+TSfflush
+========
+
+Flushes pending data that has been buffered up in memory from previous
+calls to :c:func:`TSfwrite`.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: void TSfflush(TSFile filep)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSfgets.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfgets.en.rst b/doc/reference/api/TSfgets.en.rst
new file mode 100644
index 0000000..6dbbd95
--- /dev/null
+++ b/doc/reference/api/TSfgets.en.rst
@@ -0,0 +1,38 @@
+.. 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.
+
+
+TSfgets
+=======
+
+Reads a line from the file pointed to by filep into the buffer buf.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: char* TSfgets(TSFile filep, char *buf, size_t length)
+
+
+Description
+-----------
+
+Lines are terminated by a line feed character, ' '.  The line placed
+in the buffer includes the line feed character and is terminated with
+a NULL.  If the line is longer than length bytes then only the first
+length-minus-1 bytes are placed in buf.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSfopen.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfopen.en.rst b/doc/reference/api/TSfopen.en.rst
new file mode 100644
index 0000000..76f6f96
--- /dev/null
+++ b/doc/reference/api/TSfopen.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.
+
+
+TSfopen
+=======
+
+Opens a file for reading or writing and returns a descriptor for
+accessing the file.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: TSFile TSfopen(const char *filename, const char *mode)
+
+
+Description
+-----------
+
+The current implementation cannot open a file for both reading or
+writing.  See the SDK Programmer's Guide for sample code.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSfread.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfread.en.rst b/doc/reference/api/TSfread.en.rst
new file mode 100644
index 0000000..ba40c16
--- /dev/null
+++ b/doc/reference/api/TSfread.en.rst
@@ -0,0 +1,34 @@
+.. Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed
+   with this work for additional information regarding copyright
+   ownership.  The ASF licenses this file to you under the Apache
+   License, Version 2.0 (the "License"); you may not use this file
+   except in compliance with the License.  You may obtain a copy of
+   the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied.  See the License for the specific language governing
+   permissions and limitations under the License.
+
+
+TSfread
+=======
+
+Attempts to read length bytes of data from the file pointed to by
+filep into the buffer buf.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: size_t TSfread(TSFile filep, void *buf, size_t length)
+
+
+Description
+-----------

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/TSfwrite.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSfwrite.en.rst b/doc/reference/api/TSfwrite.en.rst
new file mode 100644
index 0000000..64d3e1e
--- /dev/null
+++ b/doc/reference/api/TSfwrite.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.
+
+
+TSfwrite
+========
+
+Attempts to write length bytes of data from the buffer buf to the file
+filep.
+
+
+Synopsis
+--------
+
+`#include <ts/ts.h>`
+
+.. c:function:: size_t TSfwrite(TSFile filep, const void *buf, size_t length)
+
+
+Description
+-----------
+
+Make sure that filep is open for writing.  You might want to check the
+number of bytes written (:c:func:`TSfwrite` returns this value)
+against the value of length.  If it is less, there might be
+insufficient space on disk, for example.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a549c312/doc/reference/api/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/index.en.rst b/doc/reference/api/index.en.rst
index b706934..1725164 100644
--- a/doc/reference/api/index.en.rst
+++ b/doc/reference/api/index.en.rst
@@ -19,28 +19,7 @@ API Reference
   under the License.
 
 .. toctree::
-  :maxdepth: 1
+   :glob:
+   :maxdepth: 1
 
-  TSAPI.en
-  TSDebug.en
-  TSHttpHookAdd.en
-  TSHttpOverridableConfig.en
-  TSHttpParserCreate.en
-  TSHttpTxnMilestoneGet.en
-  TSHttpTxnServerIntercept.en
-  TSIOBufferCreate.en
-  TSInstallDirGet.en
-  TSLifecycleHookAdd.en
-  TSMBufferCreate.en
-  TSMimeHdrFieldValueStringGet.en
-  TSPluginInit.en
-  TSRemap.en
-  TSTextLogObjectCreate.en
-  TSTrafficServerVersionGet.en
-  TSTypes.en
-  TSUrlCreate.en
-  TSUrlHostGet.en
-  TSUrlHostSet.en
-  TSUrlPercentEncode.en
-  TSUrlStringGet.en
-  TSmalloc.en
+   *


Mime
View raw message