sa/tcfile_cache.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef TCFILE_CACHE_H
#define TCFILE_CACHE_H

#include <pom/pom/pom.h>
#include <ss/ss_const.h>
#include <ss/ss_types.h>
#include <sa/libsa_exports.h>

#define  NO_SECURITY  0
#define  SOCKET_MODE  1

enum file_location_type{
    FC_cache,
    FC_temp,
    FC_volume
};

typedef struct IMF_file_data_s{
    tag_t                   fileTag;
    tag_t                   volumeTag;
    char*                   pathName;
    enum file_location_type file_loc;
    char*                   osfile_name;
    char*                   read_ticket;
    logical                 is_transient;
    char*                   orig_file_name;
}IMF_file_data_t;

typedef struct IMF_file_data_s* IMF_file_data_p_t;

#ifdef __cplusplus
extern "C"{
#endif

extern SA_API int IMF_get_cache_size (
    float*        cache_size    
    );

extern SA_API int IMF_update_cache_size (
    float         bytes_to_add, 
    float*        cache_size    
    );

extern SA_API void IMF_initialize_file_cache( );

extern SA_API int IMF_get_file_access(
    tag_t               file_tag,       
    int                 date_offset,    
    IMF_file_data_p_t*  file_data       
    );

extern SA_API int IMF_fms_get_file_access(
    tag_t               file_tag,       
    int                 date_offset,    
    logical             using_fms,      
    IMF_file_data_p_t*  file_data       
    );

extern SA_API int IMF_get_filename(
    IMF_file_data_p_t   file_data,      
    char**              osfilename      
    );

extern SA_API int IMF_fms_get_filename(
    IMF_file_data_p_t   file_data,      
    logical             using_fms,      
    char**              osfilename,     
    char**              read_ticket,    
    logical*            is_transient,   
    char**              orig_file_name  
    );

extern SA_API int IMF_release_file_access(
    IMF_file_data_p_t*  file_data   
    );

#ifdef __cplusplus
}
#endif

#include <sa/libsa_undef.h>

#endif

---