handle.h

Go to the documentation of this file.

/* Copyright (c) 2021 Connected Way, LLC. All rights reserved.
 * Use of this source code is governed by a Creative Commons 
 * Attribution-NoDerivatives 4.0 International license that can be
 * found in the LICENSE file.
 */
#if !defined(__OFC_HANDLE_H__)
#define __OFC_HANDLE_H__
 
#include "ofc/core.h"
#include "ofc/types.h"
 
typedef OFC_DWORD_PTR OFC_HANDLE;
typedef OFC_UINT16 OFC_HANDLE16;
 
#define OFC_INVALID_HANDLE_VALUE ((OFC_HANDLE)-1)
#define OFC_HANDLE16_INVALID (OFC_HANDLE16)0xFFFF
#define OFC_HANDLE16_NULL ((OFC_HANDLE16) 0)
#define OFC_HANDLE_NULL ((OFC_HANDLE) 0)
 
typedef enum {
    OFC_HANDLE_UNKNOWN,    
    OFC_HANDLE_WAIT_SET,    
    OFC_HANDLE_QUEUE,        
    OFC_HANDLE_FILE,        
    OFC_HANDLE_FSWIN32_FILE,    
    OFC_HANDLE_FSWIN32_OVERLAPPED, 
    OFC_HANDLE_FSWINCE_OVERLAPPED, 
    OFC_HANDLE_FSSMB_OVERLAPPED, 
    OFC_HANDLE_FSDARWIN_OVERLAPPED, 
    OFC_HANDLE_FSLINUX_OVERLAPPED, 
    OFC_HANDLE_FSFILEX_OVERLAPPED, 
    OFC_HANDLE_FSNUFILE_OVERLAPPED, 
    OFC_HANDLE_FSANDROID_OVERLAPPED, 
    OFC_HANDLE_FSRESOLVER_OVERLAPPED, 
    OFC_HANDLE_FSDARWIN_FILE,    
    OFC_HANDLE_FSLINUX_FILE,    
    OFC_HANDLE_FSFILEX_FILE,    
    OFC_HANDLE_FSANDROID_FILE,    
    OFC_HANDLE_FSRESOLVER_FILE,    
    OFC_HANDLE_FSNUFILE_FILE,  
    OFC_HANDLE_FSOTHER_FILE,   
    OFC_HANDLE_FSBROWSER_FILE, 
    OFC_HANDLE_FSBOOKMARK_FILE, 
    OFC_HANDLE_SCHED,        
    OFC_HANDLE_APP,        
    OFC_HANDLE_THREAD,        
    OFC_HANDLE_SOCKET,         
    OFC_HANDLE_SOCKET_IMPL,    
    OFC_HANDLE_EVENT,        
    OFC_HANDLE_TIMER,        
    OFC_HANDLE_PIPE,        
    OFC_HANDLE_WAIT_QUEUE,    
    OFC_HANDLE_TRANSACTION,    
    OFC_HANDLE_SMB_FILE,    
    OFC_HANDLE_MAILSLOT,    
    OFC_HANDLE_PROCESS,    
    OFC_HANDLE_NUM        
} OFC_HANDLE_TYPE;
 
#if defined(__cplusplus)
extern "C"
{
#endif
OFC_CORE_LIB OFC_HANDLE
ofc_handle_create(OFC_HANDLE_TYPE hType, OFC_VOID *context);
OFC_CORE_LIB OFC_VOID *
ofc_handle_lock(OFC_HANDLE handle);
OFC_CORE_LIB OFC_VOID *
ofc_handle_lock_ex(OFC_HANDLE handle, OFC_HANDLE_TYPE type);
OFC_CORE_LIB OFC_VOID
ofc_handle_unlock(OFC_HANDLE handle);
OFC_CORE_LIB OFC_VOID
ofc_handle_destroy(OFC_HANDLE handle);
OFC_CORE_LIB OFC_VOID
ofc_handle_set_app(OFC_HANDLE hHandle, OFC_HANDLE hApp, OFC_HANDLE hSet);
OFC_CORE_LIB OFC_HANDLE
ofc_handle_get_app(OFC_HANDLE hHandle);
OFC_CORE_LIB OFC_HANDLE
ofc_handle_get_wait_set(OFC_HANDLE hHandle);
OFC_CORE_LIB OFC_HANDLE_TYPE
ofc_handle_get_type(OFC_HANDLE hHandle);
OFC_CORE_LIB OFC_VOID
ofc_handle16_init(OFC_VOID);
OFC_CORE_LIB OFC_VOID
ofc_handle16_free(OFC_VOID);
OFC_CORE_LIB OFC_HANDLE16
ofc_handle16_create(OFC_VOID *context);
OFC_CORE_LIB OFC_VOID
ofc_handle16_destroy(OFC_HANDLE16 hHandle);
OFC_CORE_LIB OFC_VOID *
ofc_handle16_lock(OFC_HANDLE16 hHandle);
OFC_CORE_LIB OFC_VOID
ofc_handle16_unlock(OFC_HANDLE16 hHandle);
 
#if defined(OFC_HANDLE_DEBUG)
OFC_CORE_LIB OFC_VOID ofc_handle_measure (OFC_HANDLE hHandle) ;
OFC_CORE_LIB OFC_MSTIME ofc_handle_get_avg_interval (OFC_HANDLE hHandle,
                            OFC_UINT32 *count,
                            OFC_HANDLE_TYPE *type) ;
OFC_CORE_LIB OFC_VOID ofc_handle_print_interval_header (OFC_VOID) ;
OFC_CORE_LIB OFC_VOID ofc_handle_print_interval (OFC_CHAR *prefix,
                         OFC_HANDLE hHandle) ;
OFC_CORE_LIB OFC_VOID OfcHandle16DebugDump(OFC_VOID);
#endif
#if defined(__cplusplus)
}
#endif
#endif