/*
 * FreeRTOS STM32 Reference Integration
 * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef __METRICS_COLLECTOR_H__
#define __METRICS_COLLECTOR_H__

/* Standard includes. */
#include <stdint.h>
#include <stddef.h>
#include "cbor.h"

/**
 * @brief Get network stats.
 *
 * @param[out] pOutNetworkStats The network stats.
 *
 * @return #MetricsCollectorSuccess if the network stats are successfully obtained;
 * #MetricsCollectorBadParameter if invalid parameters are passed;
 * #MetricsCollectorCollectionFailed if the collection methods failed.
 */
CborError xGetNetworkStats( CborEncoder * pxEncoder );

/**
 * @brief Get a list of the open TCP ports.
 */
CborError xGetListeningTcpPorts( CborEncoder * pxMetricsEncoder );

/**
 * @brief Get a list of the open UDP ports.
 */
CborError xGetListeningUdpPorts( CborEncoder * pxMetricsEncoder );

/**
 * @brief Get a list of established connections.
 */
CborError xGetEstablishedConnections( CborEncoder * pxMetricsEncoder );

#endif /* __METRICS_COLLECTOR_H__ */