AWS IoT Device SDK C: Platform
Platform portability layer
Return to main page ↑
iot_metrics.h
Go to the documentation of this file.
1 /*
2  * IoT Platform V1.1.0
3  * Copyright (C) 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a copy of
6  * this software and associated documentation files (the "Software"), to deal in
7  * the Software without restriction, including without limitation the rights to
8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9  * the Software, and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in all
13  * copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  */
22 
31 #ifndef IOT_METRICS_H_
32 #define IOT_METRICS_H_
33 
34 /* The config header is always included first. */
35 #include "iot_config.h"
36 
37 /* Standard includes. */
38 #include <stdbool.h>
39 
40 /* Linear containers (lists and queues) include. */
41 #include "iot_linear_containers.h"
42 
68 /* @[declare_platform_metrics_init] */
69 bool IotMetrics_Init( void );
70 /* @[declare_platform_metrics_init] */
71 
81 /* @[declare_platform_metrics_cleanup] */
82 void IotMetrics_Cleanup( void );
83 /* @[declare_platform_metrics_cleanup] */
84 
95 /* @[declare_platform_metrics_gettcpconnections] */
96 void IotMetrics_GetTcpConnections( void * pContext,
97  void ( * metricsCallback )( void *, const IotListDouble_t * ) );
98 /* @[declare_platform_metrics_gettcpconnections] */
99 
100 #endif /* ifndef IOT_METRICS_H_ */
bool IotMetrics_Init(void)
One-time initialization function for the platform metrics component.
void IotMetrics_Cleanup(void)
One-time deinitialization function for the platform metrics component.
void IotMetrics_GetTcpConnections(void *pContext, void(*metricsCallback)(void *, const IotListDouble_t *))
Retrieve a list of active TCP connections from the system.