git commit: TS-1301 Add a man page for the new TSHttpTxnMilestoneGet API

[zw...@apache.org]

Updated Branches:
  refs/heads/master 197931b59 -> 1e9080139


TS-1301 Add a man page for the new TSHttpTxnMilestoneGet API


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/1e908013
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/1e908013
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/1e908013

Branch: refs/heads/master
Commit: 1e9080139d2a37ed53d03eda40e204e05d18450c
Parents: 197931b
Author: Leif Hedstrom <zw...@apache.org>
Authored: Thu Feb 28 17:24:43 2013 -0700
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Thu Feb 28 17:24:43 2013 -0700

----------------------------------------------------------------------
 doc/sdk/TSHttpTxnMilestoneGet.3 |   68 ++++++++++++++++++++++++++++++++++
 1 files changed, 68 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/1e908013/doc/sdk/TSHttpTxnMilestoneGet.3
----------------------------------------------------------------------
diff --git a/doc/sdk/TSHttpTxnMilestoneGet.3 b/doc/sdk/TSHttpTxnMilestoneGet.3
new file mode 100644
index 0000000..c97e798
--- /dev/null
+++ b/doc/sdk/TSHttpTxnMilestoneGet.3
@@ -0,0 +1,68 @@
+.\"  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 .\"
+.Dd February 25, 2013
+.Dt TSHttpTxnMilestoneGet 3ts TSAPI
+.Sh NAME
+.Nm TSHttpTxnMilestoneGet
+.Nd Get a specified milestone timer value for the current transaction.
+.Sh LIBRARY
+Apache Traffic Server plugin API
+.Sh SYNOPSIS
+.In ts/ts.h
+.Ft "TSReturnCode"
+.Fo TSHttpTxnMilestoneGet
+.Fa "TSHttpTxn txnp"
+.Fa "TSMilestonesType milestone"
+.Fa "TSHRTime *time"
+.Fc
+.Sh DESCRIPTION
+The TSHttpTxnMilestoneGet API will fetch a specific milestone timer value
+for the current request (txnp). These timers are calculated during the lifetime
+of a transaction, and are all in TSHRTime (nanosecons), meassured from the
+beginning of the transaction. The time argument is a pointer to a valid
+TSHRtime storage, and is set upon success.
+.Pp
+The supported TSMilestonesType milestone types are
+.Pp
+.Bl -tag -width "TS_MILESTONE_SERVER_READ_HEADER_DONE" -compact -offset indent
+.It TS_MILESTONE_UA_BEGIN
+.It TS_MILESTONE_UA_READ_HEADER_DONE
+.It TS_MILESTONE_UA_BEGIN_WRITE
+.It TS_MILESTONE_UA_CLOSE
+.It TS_MILESTONE_SERVER_FIRST_CONNECT
+.It TS_MILESTONE_SERVER_CONNECT
+.It TS_MILESTONE_SERVER_CONNECT_END
+.It TS_MILESTONE_SERVER_BEGIN_WRITE
+.It TS_MILESTONE_SERVER_FIRST_READ
+.It TS_MILESTONE_SERVER_READ_HEADER_DONE
+.It TS_MILESTONE_SERVER_CLOSE
+.It TS_MILESTONE_CACHE_OPEN_READ_BEGIN
+.It TS_MILESTONE_CACHE_OPEN_READ_END
+.It TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN
+.It TS_MILESTONE_CACHE_OPEN_WRITE_END
+.It TS_MILESTONE_DNS_LOOKUP_BEGIN
+.It TS_MILESTONE_DNS_LOOKUP_END
+.It TS_MILESTONE_SM_START
+.It TS_MILESTONE_SM_FINISH
+.It TS_MILESTONE_LAST_ENTRY
+.El
+.Sh RETURN VALUES
+Success or error.
+.Sh EXAMPLES
+.nf
+#include <ts/ts.h>
+.fi
+.Sh SEE ALSO
+.Xr TSAPI 3ts