timeout.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef CDI_TIMEOUT_H__
#define CDI_TIMEOUT_H__
 
#include <stdbool.h>
 
#include "cdi_core_api.h"
#include "cdi_logger_api.h"
#include "cdi_os_api.h"
#include "cdi_pool_api.h"
#include "fifo_api.h"
#include "list_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
#define MAX_TIMERS      25
#define MAX_TIMERS_GROW  5
 
typedef struct TimeoutDataState {
    CdiListEntry list_entry;
    uint64_t deadline_us;
    void* cb_ptr;
    void* user_data_ptr;
    //struct TimeoutDataState*  next_handle;
    //struct TimeoutDataState*  prev_handle;
} TimeoutDataState;
 
typedef struct TimeoutDataState* TimeoutHandle;
 
typedef struct TimeoutInstanceState {
    CdiThreadID    main_thread_id;
    CdiThreadID    cb_thread_id;
    CdiFifoHandle  cb_fifo_handle;
    CdiSignalType  go_signal;
    CdiSignalType  shutdown_signal;
    CdiSignalType  stop_signal;
    CdiList        timeout_list;
    CdiPoolHandle  mem_pool_handle;
    CdiCsID        critical_section;
    CdiLogHandle log_handle;
} TimeoutInstanceState;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
typedef struct TimeoutInstanceState* CdiTimeoutInstanceHandle;
 
typedef struct {
    TimeoutHandle handle; 
    void *user_data_ptr; 
} CdiTimeoutCbData;
 
typedef void (*CdiTimeoutCallback)(const CdiTimeoutCbData* data_ptr);
 
CdiReturnStatus CdiTimeoutCreate(CdiLogHandle log_handle, CdiTimeoutInstanceHandle* ret_handle);
 
void CdiTimeoutDestroy(CdiTimeoutInstanceHandle handle);
 
bool CdiTimeoutAdd(CdiTimeoutInstanceHandle instance_handle, CdiTimeoutCallback cb_ptr, int timeout_us,
                   void* user_data_ptr, TimeoutHandle* ret_handle);
 
bool CdiTimeoutRemove(TimeoutHandle handle, CdiTimeoutInstanceHandle instance_handle);
 
#endif // CDI_TIMEOUT_H__