handle_manager.h

/******************************************************************************
 * Copyright 2022 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
/* etcpal/handle_manager.h: A utility to manage handing out integer handles to resources. */
 
#ifndef ETCPAL_HANDLE_MANAGER_H_
#define ETCPAL_HANDLE_MANAGER_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef bool (*HandleValueInUseFunction)(int handle_val, void* context);
 
typedef struct IntHandleManager
{
  int last_handle;
  int max_value;
  bool check_value_in_use;
  HandleValueInUseFunction value_in_use;
  void* context;
} IntHandleManager;
 
void init_int_handle_manager(IntHandleManager*        manager,
                             int                      max_value,
                             HandleValueInUseFunction value_in_use_func,
                             void*                    context);
int  get_next_int_handle(IntHandleManager* manager);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ETCPAL_HANDLE_MANAGER_H_ */