le_atomFile.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
#ifndef LEGATO_ATOMFILE_INCLUDE_GUARD
#define LEGATO_ATOMFILE_INCLUDE_GUARD

#include "le_fileLock.h"


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_atomFile_Open
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_atomFile_Create
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_flock_CreateMode_t createMode,   
    mode_t permissions                  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_atomFile_TryOpen
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_atomFile_TryCreate
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_flock_CreateMode_t createMode,   
    mode_t permissions                  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_atomFile_Cancel
(
    int fd                              
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_atomFile_Close
(
    int fd                              
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
FILE* le_atomFile_OpenStream
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_result_t* resultPtr              
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
FILE* le_atomFile_CreateStream
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_flock_CreateMode_t createMode,   
    mode_t permissions,                 
    le_result_t* resultPtr              
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
FILE* le_atomFile_TryOpenStream
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_result_t* resultPtr              
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
FILE* le_atomFile_TryCreateStream
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_flock_CreateMode_t createMode,   
    mode_t permissions,                 
    le_result_t* resultPtr              
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_atomFile_CancelStream
(
    FILE* fileStreamPtr               
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_atomFile_CloseStream
(
    FILE* fileStreamPtr             
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_atomFile_Delete
(
    const char* pathNamePtr            
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_atomFile_TryDelete
(
    const char* pathNamePtr            
);


#endif //LEGATO_ATOMIC_INCLUDE_GUARD