retry_utils.h

Go to the documentation of this file.

/*
 * AWS IoT Device SDK for Embedded C V202011.00
 * 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.
 */
 
#ifndef RETRY_UTILS_H_
#define RETRY_UTILS_H_
 
/* Standard include. */
#include <stdint.h>
 
#define MAX_RETRY_ATTEMPTS               4U
 
#define INITIAL_RETRY_BACKOFF_SECONDS    1U
 
#define MAX_RETRY_BACKOFF_SECONDS        128U
 
#define MAX_JITTER_VALUE_SECONDS         5U
 
typedef enum RetryUtilsStatus
{
    RetryUtilsSuccess = 0,     
    RetryUtilsRetriesExhausted 
} RetryUtilsStatus_t;
 
typedef struct RetryUtilsParams
{
    uint32_t attemptsDone;
 
    uint32_t nextJitterMax;
} RetryUtilsParams_t;
 
 
/* @[define_retryutils_paramsreset] */
void RetryUtils_ParamsReset( RetryUtilsParams_t * pRetryParams );
/* @[define_retryutils_paramsreset] */
 
/* @[define_retryutils_backoffandsleep] */
RetryUtilsStatus_t RetryUtils_BackoffAndSleep( RetryUtilsParams_t * pRetryParams );
/* @[define_retryutils_backoffandsleep] */
 
#endif /* ifndef RETRY_UTILS_H_ */