-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathccnxPing_Stats.h
161 lines (154 loc) · 6.32 KB
/
ccnxPing_Stats.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/*
* Copyright (c) 2016, Xerox Corporation (Xerox) and Palo Alto Research Center, Inc (PARC)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL XEROX OR PARC BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* ################################################################################
* #
* # PATENT NOTICE
* #
* # This software is distributed under the BSD 2-clause License (see LICENSE
* # file). This BSD License does not make any patent claims and as such, does
* # not act as a patent grant. The purpose of this section is for each contributor
* # to define their intentions with respect to intellectual property.
* #
* # Each contributor to this source code is encouraged to state their patent
* # claims and licensing mechanisms for any contributions made. At the end of
* # this section contributors may each make their own statements. Contributor's
* # claims and grants only apply to the pieces (source code, programs, text,
* # media, etc) that they have contributed directly to this software.
* #
* # There is no guarantee that this section is complete, up to date or accurate. It
* # is up to the contributors to maintain their portion of this section and up to
* # the user of the software to verify any claims herein.
* #
* # Do not remove this header notification. The contents of this section must be
* # present in all distributions of the software. You may only modify your own
* # intellectual property statements. Please provide contact information.
*
* - Palo Alto Research Center, Inc
* This software distribution does not grant any rights to patents owned by Palo
* Alto Research Center, Inc (PARC). Rights to these patents are available via
* various mechanisms. As of January 2016 PARC has committed to FRAND licensing any
* intellectual property used by its contributions to this software. You may
* contact PARC at [email protected] for more information or visit http://www.ccnx.org
*/
/**
* @author Nacho Solis, Christopher A. Wood, Palo Alto Research Center (Xerox PARC)
* @copyright (c) 2016, Xerox Corporation (Xerox) and Palo Alto Research Center, Inc (PARC). All rights reserved.
*/
#ifndef ccnxPing_Stats_h
#define ccnxPing_Stats_h
/**
* Structure to collect and display the performance statistics.
*/
struct ping_stats;
typedef struct ping_stats CCNxPingStats;
/**
* Create an empty `CCNxPingStats` instance.
*
* The returned result must be freed via {@link ccnxPingStats_Release}
*
* @return A newly allocated `CCNxPingStats`.
*
* Example
* @code
* {
* CCNxPingStats *stats = ccnxPingStats_Create();
* }
* @endcode
*/
CCNxPingStats *ccnxPingStats_Create(void);
/**
* Increase the number of references to a `CCNxPingStats`.
*
* Note that new `CCNxPingStats` is not created,
* only that the given `CCNxPingStats` reference count is incremented.
* Discard the reference by invoking `ccnxPingStats_Release`.
*
* @param [in] clock A pointer to a `CCNxPingStats` instance.
*
* @return The input `CCNxPingStats` pointer.
*
* Example:
* @code
* {
* CCNxPingStats *stats = ccnxPingStats_Create();
* CCNxPingStats *copy = ccnxPingStats_Acquire(stats);
* ccnxPingStats_Release(&stats);
* ccnxPingStats_Release(©);
* }
* @endcode
*/
CCNxPingStats *ccnxPingStats_Acquire(const CCNxPingStats *stats);
/**
* Release a previously acquired reference to the specified instance,
* decrementing the reference count for the instance.
*
* The pointer to the instance is set to NULL as a side-effect of this function.
*
* If the invocation causes the last reference to the instance to be released,
* the instance is deallocated and the instance's implementation will perform
* additional cleanup and release other privately held references.
*
* @param [in,out] clockPtr A pointer to a pointer to the instance to release.
*
* Example:
* @code
* {
* CCNxPingStats *stats = ccnxPingStats_Create();
* CCNxPingStats *copy = ccnxPingStats_Acquire(stats);
* ccnxPingStats_Release(&stats);
* ccnxPingStats_Release(©);
* }
* @endcode
*/
void ccnxPingStats_Release(CCNxPingStats **statsPtr);
/**
* Record the name and time for a request (e.g., interest).
*
* @param [in] stats The `CCNxPingStats` instance.
* @param [in] name The `CCNxName` name structure.
* @param [in] timeInUs The send time (in microseconds).
*/
void ccnxPingStats_RecordRequest(CCNxPingStats *stats, CCNxName *name, uint64_t timeInUs);
/**
* Record the name and time for a response (e.g., content object).
*
* @param [in] stats The `CCNxPingStats` instance.
* @param [in] name The `CCNxName` name structure.
* @param [in] timeInUs The send time (in microseconds).
* @param [in] message The response `CCNxMetaMessage`.
*
* @return The delta between the request and response (in microseconds).
*/
size_t ccnxPingStats_RecordResponse(CCNxPingStats *stats, CCNxName *name, uint64_t timeInUs, CCNxMetaMessage *message);
/**
* Display the average statistics stored in this `CCNxPingStats` instance.
*
* @param [in] stats The `CCNxPingStats` instance from which to draw the average data.
*
* @retval true If the stats were displayed correctly
* @retval false Otherwise
*/
bool ccnxPingStats_Display(CCNxPingStats *stats);
#endif // ccnxPing_Stats_h