ext/amazon-freertos/libraries/c_sdk/standard/common/include/iot_init.h

/*
 * FreeRTOS Common V1.1.1
 * Copyright (C) 2020 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
 */

/**
 * @file iot_init.h
 * @brief Provides function signatures for common initialization and cleanup of
 * this SDK.
 */

#ifndef IOT_INIT_H_
#define IOT_INIT_H_

/* The config header is always included first. */
#include "iot_config.h"

/* Standard includes. */
#include <stdbool.h>

/**
 * @brief One-time initialization function for this SDK.
 *
 * This function initializes common libraries, such as static memory and task
 * pool. <b>It must be called once (and only once) before calling any other
 * function in this SDK.</b> Calling this function more than once without first
 * calling `IotSdk_Cleanup` may result in a crash.
 *
 * @return `true` if initialization succeeded; `false` otherwise. Logs may be
 * printed in case of failure.
 *
 * @warning No thread-safety guarantees are provided for this function.
 */
bool IotSdk_Init( void );

/**
 * @brief One-time deinitialization function for all common libraries.
 *
 * This function frees resources taken in `IotSdk_Init`. No other function
 * in this SDK may be called after calling this function unless `IotSdk_Init`
 * is called again.
 *
 * @warning No thread-safety guarantees are provided for this function.
 */
void IotSdk_Cleanup( void );

#endif /* IOT_INIT_H_ */