framework.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_FRAMEWORK_H__)
#define __OFC_FRAMEWORK_H__
 
#include "ofc/types.h"
#include "ofc/config.h"
#include "ofc/core.h"
#include "ofc/net.h"
#include "ofc/path.h"
#include "ofc/file.h"
 
typedef struct {
  OFC_INT num_wins;     
  OFC_IPADDR *winsaddr;     
} OFC_FRAMEWORK_WINSLIST;
 
typedef enum {
    OFC_CONFIG_BMODE = 0,    
    OFC_CONFIG_PMODE,        
    OFC_CONFIG_MMODE,        
    OFC_CONFIG_HMODE,        
    OFC_CONFIG_MODE_MAX    
} OFC_CONFIG_MODE;
 
typedef struct {
    OFC_CONFIG_MODE netBiosMode; 
    OFC_IPADDR ip;       
    OFC_IPADDR bcast;        
    OFC_IPADDR mask;         
    OFC_LPCSTR lmb;      
    OFC_FRAMEWORK_WINSLIST wins; 
} OFC_FRAMEWORK_INTERFACE;
 
typedef struct {
    OFC_UINT16 num_interfaces;  
    OFC_FRAMEWORK_INTERFACE *iface; 
} OFC_FRAMEWORK_INTERFACES;
 
typedef struct {
    OFC_LPTSTR prefix;      
    OFC_LPTSTR desc;        
    OFC_LPTSTR path;        
    OFC_FST_TYPE type;      
    OFC_BOOL thumbnail;     
} OFC_FRAMEWORK_MAP;
 
typedef struct {
    OFC_UINT16 numMaps;     
    OFC_FRAMEWORK_MAP *map; 
} OFC_FRAMEWORK_MAPS;
 
#if defined(__cplusplus)
extern "C"
{
#endif
OFC_CORE_LIB OFC_VOID
ofc_framework_init(OFC_VOID);
 
OFC_CORE_LIB OFC_VOID
ofc_framework_destroy(OFC_VOID);
 
OFC_CORE_LIB OFC_VOID
ofc_framework_startup(OFC_VOID);
 
OFC_CORE_LIB OFC_VOID
ofc_framework_startup_ev(OFC_HANDLE hScheduler, OFC_HANDLE hEvent);
 
OFC_CORE_LIB OFC_VOID
ofc_framework_shutdown(OFC_VOID);
OFC_CORE_LIB OFC_VOID ofc_framework_load(OFC_LPCTSTR filename);
OFC_CORE_LIB OFC_VOID ofc_framework_loadbuf(OFC_LPVOID buf, OFC_SIZET len);
OFC_CORE_LIB OFC_VOID ofc_framework_save(OFC_LPCTSTR filename);
OFC_CORE_LIB OFC_VOID ofc_framework_savebuf(OFC_LPVOID *buf, OFC_SIZET *len);
 
OFC_CORE_LIB OFC_BOOL ofc_get_config_dir(OFC_TCHAR *config_dir,
                     OFC_SIZET len);
OFC_CORE_LIB OFC_VOID ofc_set_config_path(OFC_TCHAR *filename);
 
OFC_CORE_LIB OFC_VOID
ofc_framework_set_netbios(OFC_BOOL enabled);
OFC_CORE_LIB OFC_VOID
ofc_framework_set_host_name(OFC_LPCTSTR name, OFC_LPCTSTR workgroup,
                            OFC_LPCTSTR desc);
OFC_CORE_LIB OFC_LPTSTR ofc_framework_get_host_name(OFC_VOID);
OFC_CORE_LIB OFC_VOID ofc_framework_free_host_name(OFC_LPTSTR str);
OFC_CORE_LIB OFC_LPTSTR ofc_framework_get_workgroup(OFC_VOID);
OFC_CORE_LIB OFC_VOID ofc_framework_free_workgroup(OFC_LPTSTR str);
OFC_CORE_LIB OFC_LPTSTR ofc_framework_get_description(OFC_VOID);
OFC_CORE_LIB OFC_VOID ofc_framework_free_description(OFC_LPTSTR str);
 
OFC_VOID ofc_framework_set_realm(const OFC_CHAR *realm);
 
OFC_CCHAR *ofc_framework_get_realm(OFC_VOID);
OFC_VOID ofc_framework_set_uuid(const OFC_CHAR *cuuid);
 
OFC_CHAR *ofc_framework_get_uuid(OFC_VOID);
OFC_CORE_LIB OFC_VOID ofc_framework_free_uuid(OFC_LPSTR str);
OFC_CORE_LIB OFC_LPTSTR ofc_framework_get_root_dir(OFC_VOID);
OFC_CORE_LIB OFC_VOID ofc_framework_free_root_dir(OFC_LPTSTR str);
 
OFC_CORE_LIB OFC_VOID ofc_framework_set_logging(OFC_UINT log_level, OFC_BOOL log_console);
OFC_VOID ofc_framework_set_interface_discovery(OFC_BOOL on);
OFC_VOID ofc_framework_set_network_handle(OFC_UINT64 network_handle);
OFC_BOOL ofc_framework_get_interface_discovery(OFC_VOID);
 
OFC_VOID ofc_framework_add_interface(OFC_FRAMEWORK_INTERFACE *iface);
 
OFC_VOID ofc_framework_remove_interface(OFC_IPADDR *ip);
 
OFC_FRAMEWORK_INTERFACES *ofc_framework_get_interfaces(OFC_VOID);
 
OFC_VOID ofc_framework_free_interfaces(OFC_FRAMEWORK_INTERFACES *ifaces);
 
OFC_BOOL ofc_framework_add_map(OFC_FRAMEWORK_MAP *map);
 
OFC_FRAMEWORK_MAPS *ofc_framework_get_maps(OFC_VOID);
 
OFC_VOID ofc_framework_free_maps(OFC_FRAMEWORK_MAPS *maps);
OFC_VOID ofc_framework_remove_map(OFC_LPCTSTR tszPrefix);
 
OFC_VOID ofc_framework_update(OFC_VOID);
 
OFC_VOID ofc_framework_dump_heap(OFC_VOID);
OFC_VOID ofc_framework_set_wifi_ip(OFC_INT);
OFC_INT ofc_framework_get_wifi_ip(OFC_VOID);
OFC_VOID ofc_framework_stats_heap(OFC_VOID);
 
#if defined(__cplusplus)
}
#endif
#endif