This is an automated email from the ASF dual-hosted git repository.
amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new fa8b73c Doc: Fixup milestones documentation.
fa8b73c is described below
commit fa8b73c600763c6ac3669ba712ae2ef488e969ce
Author: Alan M. Carroll <[email protected]>
AuthorDate: Sun May 21 18:24:56 2017 -0500
Doc: Fixup milestones documentation.
---
.../api/functions/TSHttpTxnMilestoneGet.en.rst | 141 ++++++++++++++++-----
.../api/types/TSMilestonesType.en.rst | 78 ------------
2 files changed, 107 insertions(+), 112 deletions(-)
diff --git a/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst
b/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst
index c806321..e0cd0ac 100644
--- a/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpTxnMilestoneGet.en.rst
@@ -42,31 +42,104 @@ is successful.
.. type:: TSMilestonesType
-=============================================== ==========
-Value Milestone
-=============================================== ==========
-:const:`TS_MILESTONE_SM_START` Transaction state machine is
initialized.
-:const:`TS_MILESTONE_UA_BEGIN` The client connection is
accepted.
-: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.
-:const:`TS_MILESTONE_UA_READ_HEADER_DONE` The request header from the
client has been read and parsed.
-: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_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_UA_BEGIN_WRITE` The response header write to
the client starts.
-:const:`TS_MILESTONE_SERVER_CLOSE` Last I/O activity on origin
server connection.
-:const:`TS_MILESTONE_UA_CLOSE` Last I/O activity on the
client socket, or connection abort.
-:const:`TS_MILESTONE_SM_FINISH` Transaction has finished,
state machine final logging has started.
-=============================================== ==========
+ An enumeration of the valid indices of transaction milestone data.
+
+ .. macro:: TS_MILESTONE_SM_START
+
+ Transaction state machine is initialized.
+
+ .. macro:: TS_MILESTONE_UA_BEGIN
+
+ The client connection is accepted.
+
+ .. macro:: TS_MILESTONE_PLUGIN_ACTIVE
+
+ Amount of time plugins were active plus start time.
+
+ .. macro:: TS_MILESTONE_PLUGIN_TOTAL
+
+ Wall time while plugins were active plus start time.
+
+ .. macro:: TS_MILESTONE_UA_READ_HEADER_DONE
+
+ The request header from the client has been read and parsed.
+
+ .. macro:: TS_MILESTONE_CACHE_OPEN_READ_BEGIN
+
+ Initiate read of the cache.
+
+ .. macro:: TS_MILESTONE_CACHE_OPEN_READ_END
+
+ Initial cache read has resolved.
+
+ .. macro:: TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN
+
+ Start open for cache write.
+
+ .. macro:: TS_MILESTONE_CACHE_OPEN_WRITE_END
+
+ Cache has been opened for write.
+
+ .. macro:: TS_MILESTONE_DNS_LOOKUP_BEGIN
+
+ Initiate host resolution in HostDB
+
+ .. macro:: TS_MILESTONE_DNS_LOOKUP_END
+
+ Host resolution resolves.
+
+ .. macro:: TS_MILESTONE_SERVER_FIRST_CONNECT
+
+ First time origin server connect attempted or shared shared
session attached.
+
+ .. macro:: TS_MILESTONE_SERVER_CONNECT
+
+ Most recent time origin server connect attempted or shared
session attached.
+
+ .. macro:: TS_MILESTONE_SERVER_CONNECT_END
+
+ More recent time a connection attempt was resolved.
+
+ .. macro:: TS_MILESTONE_SERVER_BEGIN_WRITE
+
+ First byte is written to the origin server connection.
+
+ .. macro:: TS_MILESTONE_SERVER_FIRST_READ
+
+ First byte is read from connection to origin server.
+
+ .. macro:: TS_MILESTONE_SERVER_READ_HEADER_DONE
+
+ Origin server response has been read and parsed.
+
+ .. macro:: TS_MILESTONE_UA_BEGIN_WRITE
+
+ The response header write to the client starts.
+
+ .. macro:: TS_MILESTONE_SERVER_CLOSE
+
+ Last I/O activity on origin server connection.
+
+ .. macro:: TS_MILESTONE_UA_CLOSE
+
+ Last I/O activity on the client socket, or connection abort.
+
+ .. macro:: TS_MILESTONE_SM_FINISH
+
+ Transaction has finished, state machine final logging has
started.
+
+ .. macro:: TS_MILESTONE_PLUGIN_ACTIVE
+
+ Amount of time plugins were active (running plugin code).
+
+ .. macro:: TS_MILESTONE_PLUGIN_TOTAL
+
+ Amount of time spent in or waiting for plugins.
+
+ .. macro:: TS_MILESTONE_LAST_ENTRY
+
+ A psuedo index which is set to be one more than the last valid
index. This is useful for looping over the data.
+
* The server connect times predate the transmission of the :literal:`SYN`
packet. That is, before a connection to the origin server is completed.
@@ -74,7 +147,7 @@ Value Milestone
* 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
+* :macro:`TS_MILESTONE_UA_CLOSE` and :macro:`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.
@@ -82,21 +155,21 @@ Value Milestone
* 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
+* :macro:`TS_MILESTONE_PLUGIN_ACTIVE` and :macro:`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* :macro:`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`.
+ other milestones, as offsets from :macro:`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
+ :macro:`TS_MILESTONE_PLUGIN_ACTIVE` value is the amount of time the plugin
was active, that is performing
+ computation. :macro:`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`.
+ :macro:`TS_MILESTONE_PLUGIN_TOTAL` but not in
:macro:`TS_MILESTONE_PLUGIN_ACTIVE`.
Return Values
=============
-:const:`TS_SUCCESS` if successful and :arg:`time` was updated, otherwise
-:const:`TS_ERROR`.
+:macro:`TS_SUCCESS` if successful and :arg:`time` was updated, otherwise
+:macro:`TS_ERROR`.
See Also
========
diff --git a/doc/developer-guide/api/types/TSMilestonesType.en.rst
b/doc/developer-guide/api/types/TSMilestonesType.en.rst
deleted file mode 100644
index 93a7c0b..0000000
--- a/doc/developer-guide/api/types/TSMilestonesType.en.rst
+++ /dev/null
@@ -1,78 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed
- with this work for additional information regarding copyright
- ownership. The ASF licenses this file to you under the Apache
- License, Version 2.0 (the "License"); you may not use this file
- except in compliance with the License. You may obtain a copy of
- the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied. See the License for the specific language governing
- permissions and limitations under the License.
-
-.. include:: ../../../common.defs
-
-TSMilestonesType
-***************
-
-Synopsis
-========
-
-`#include <ts/apidefs.h>`
-
-.. c:type:: TSMilestonesType
-
-Enum typedef.
-
-Enumeration Members
-===================
-
-.. c:member:: TSMilestonesType TS_MILESTONE_NULL
-
-.. c:member:: TSMilestonesType TS_MILESTONE_UA_BEGIN
-
-.. c:member:: TSMilestonesType TS_MILESTONE_UA_READ_HEADER_DONE
-
-.. c:member:: TSMilestonesType TS_MILESTONE_UA_BEGIN_WRITE
-
-.. c:member:: TSMilestonesType TS_MILESTONE_UA_CLOSE
-
-.. c:member:: TSMilestonesType TS_MILESTONE_SERVER_FIRST_CONNECT
-
-.. c:member:: TSMilestonesType TS_MILESTONE_SERVER_CONNECT
-
-.. c:member:: TSMilestonesType TS_MILESTONE_SERVER_CONNECT_END
-
-.. c:member:: TSMilestonesType TS_MILESTONE_SERVER_BEGIN_WRITE
-
-.. c:member:: TSMilestonesType TS_MILESTONE_SERVER_FIRST_READ
-
-.. c:member:: TSMilestonesType TS_MILESTONE_SERVER_READ_HEADER_DONE
-
-.. c:member:: TSMilestonesType TS_MILESTONE_SERVER_CLOSE
-
-.. c:member:: TSMilestonesType TS_MILESTONE_CACHE_OPEN_READ_BEGIN
-
-.. c:member:: TSMilestonesType TS_MILESTONE_CACHE_OPEN_READ_END
-
-.. c:member:: TSMilestonesType TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN
-
-.. c:member:: TSMilestonesType TS_MILESTONE_CACHE_OPEN_WRITE_END
-
-.. c:member:: TSMilestonesType TS_MILESTONE_DNS_LOOKUP_BEGIN
-
-.. c:member:: TSMilestonesType TS_MILESTONE_DNS_LOOKUP_END
-
-.. c:member:: TSMilestonesType TS_MILESTONE_SM_START
-
-.. c:member:: TSMilestonesType TS_MILESTONE_SM_FINISH
-
-.. c:member:: TSMilestonesType TS_MILESTONE_LAST_ENTRY
-
-Description
-===========
-
--
To stop receiving notification emails like this one, please contact
['"[email protected]" <[email protected]>'].
