~ps10gel/ubuntu/xenial/trafficserver/6.2.0

« back to all changes in this revision

Viewing changes to doc/sdk/TSHttpTxnMilestoneGet.3

  • Committer: Package Import Robot
  • Author(s): Aron Xu
  • Date: 2013-05-09 01:00:04 UTC
  • mto: (1.1.11) (5.3.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 15.
  • Revision ID: package-import@ubuntu.com-20130509010004-9fqq9n0adseg3f8w
Tags: upstream-3.3.2
ImportĀ upstreamĀ versionĀ 3.3.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"  Licensed to the Apache Software Foundation (ASF) under one .\"
 
2
.\"  or more contributor license agreements.  See the NOTICE file .\"
 
3
.\"  distributed with this work for additional information .\"
 
4
.\"  regarding copyright ownership.  The ASF licenses this file .\"
 
5
.\"  to you under the Apache License, Version 2.0 (the .\"
 
6
.\"  "License"); you may not use this file except in compliance .\"
 
7
.\"  with the License.  You may obtain a copy of the License at .\"
 
8
.\" .\"
 
9
.\"      http://www.apache.org/licenses/LICENSE-2.0 .\"
 
10
.\" .\"
 
11
.\"  Unless required by applicable law or agreed to in writing, software .\"
 
12
.\"  distributed under the License is distributed on an "AS IS" BASIS, .\"
 
13
.\"  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\"
 
14
.\"  See the License for the specific language governing permissions and .\"
 
15
.Dd February 25, 2013
 
16
.Dt TSHttpTxnMilestoneGet 3ts TSAPI
 
17
.Sh NAME
 
18
.Nm TSHttpTxnMilestoneGet
 
19
.Nd Get a specified milestone timer value for the current transaction.
 
20
.Sh LIBRARY
 
21
Apache Traffic Server plugin API
 
22
.Sh SYNOPSIS
 
23
.In ts/ts.h
 
24
.Ft "TSReturnCode"
 
25
.Fo TSHttpTxnMilestoneGet
 
26
.Fa "TSHttpTxn txnp"
 
27
.Fa "TSMilestonesType milestone"
 
28
.Fa "TSHRTime *time"
 
29
.Fc
 
30
.Sh DESCRIPTION
 
31
The TSHttpTxnMilestoneGet API will fetch a specific milestone timer value
 
32
for the current request (txnp). These timers are calculated during the lifetime
 
33
of a transaction, and are all in TSHRTime (nanosecons), meassured from the
 
34
beginning of the transaction. The time argument is a pointer to a valid
 
35
TSHRtime storage, and is set upon success.
 
36
.Pp
 
37
The supported TSMilestonesType milestone types are
 
38
.Pp
 
39
.Bl -tag -width "TS_MILESTONE_SERVER_READ_HEADER_DONE" -compact -offset indent
 
40
.It TS_MILESTONE_UA_BEGIN
 
41
.It TS_MILESTONE_UA_READ_HEADER_DONE
 
42
.It TS_MILESTONE_UA_BEGIN_WRITE
 
43
.It TS_MILESTONE_UA_CLOSE
 
44
.It TS_MILESTONE_SERVER_FIRST_CONNECT
 
45
.It TS_MILESTONE_SERVER_CONNECT
 
46
.It TS_MILESTONE_SERVER_CONNECT_END
 
47
.It TS_MILESTONE_SERVER_BEGIN_WRITE
 
48
.It TS_MILESTONE_SERVER_FIRST_READ
 
49
.It TS_MILESTONE_SERVER_READ_HEADER_DONE
 
50
.It TS_MILESTONE_SERVER_CLOSE
 
51
.It TS_MILESTONE_CACHE_OPEN_READ_BEGIN
 
52
.It TS_MILESTONE_CACHE_OPEN_READ_END
 
53
.It TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN
 
54
.It TS_MILESTONE_CACHE_OPEN_WRITE_END
 
55
.It TS_MILESTONE_DNS_LOOKUP_BEGIN
 
56
.It TS_MILESTONE_DNS_LOOKUP_END
 
57
.It TS_MILESTONE_SM_START
 
58
.It TS_MILESTONE_SM_FINISH
 
59
.It TS_MILESTONE_LAST_ENTRY
 
60
.El
 
61
.Sh RETURN VALUES
 
62
Success or error.
 
63
.Sh EXAMPLES
 
64
.nf
 
65
#include <ts/ts.h>
 
66
.fi
 
67
.Sh SEE ALSO
 
68
.Xr TSAPI 3ts