framework/c/inc/le_fileLock.h

Go to the documentation of this file.

 //--------------------------------------------------------------------------------------------------
#ifndef LEGATO_FLOCK_INCLUDE_GUARD
#define LEGATO_FLOCK_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_FLOCK_READ,              
    LE_FLOCK_WRITE,             
    LE_FLOCK_APPEND,            

    LE_FLOCK_READ_AND_WRITE,    
    LE_FLOCK_READ_AND_APPEND    

}
le_flock_AccessMode_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_FLOCK_OPEN_IF_EXIST,     
    LE_FLOCK_REPLACE_IF_EXIST,  
    LE_FLOCK_FAIL_IF_EXIST      
}
le_flock_CreateMode_t;


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_flock_Create
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_flock_CreateMode_t createMode,   
    mode_t permissions                  

);


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_flock_TryCreate
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_flock_CreateMode_t createMode,   
    mode_t permissions                  

);


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
FILE* le_flock_OpenStream
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_result_t* resultPtr              

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
FILE* le_flock_CreateStream
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_flock_CreateMode_t createMode,   
    mode_t permissions,                 

    le_result_t* resultPtr              

);


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


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
FILE* le_flock_TryCreateStream
(
    const char* pathNamePtr,            
    le_flock_AccessMode_t accessMode,   
    le_flock_CreateMode_t createMode,   
    mode_t permissions,                 

    le_result_t* resultPtr              
);


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


#endif //LEGATO_FLOCK_INCLUDE_GUARD