MemoryMappedFile.h

Go to the documentation of this file.

#ifndef CARMA_UI_RTD_MEMORYMAPPEDFILE_H_
#define CARMA_UI_RTD_MEMORYMAPPEDFILE_H_

#include <sys/mman.h>
#include <iostream>
#include <string>




namespace carma {
    namespace ui {
        namespace rtd { 

 
struct MapfileHeader;

class MemoryMappedFileException {};

class MemoryMappedFile {
public:
    enum Protection_t {
        NoAccess = PROT_NONE, 
        Read     = PROT_READ, 
        Write    = PROT_WRITE, 
        Exec     = PROT_EXEC
    };
  
    MemoryMappedFile(const char* map_file_name, 
                      size_t client_size, 
                      bool reuse,
                      Protection_t p_mask = Protection_t (Read | Write),
                      bool persistent = true);
    MemoryMappedFile(const std::string& map_file_name, 
                      size_t client_size, 
                      bool reuse,
                      Protection_t p_mask = Protection_t (Read | Write),
                      bool persistent = true);

    ~MemoryMappedFile();
    bool        lockRead();
    bool        lockWrite();
    bool        unlock();
    void*       getClientArea();
    const char* getFileName();
    int getFileDescriptor() const;

private:
    void init(const char* map_file_name, 
                      size_t client_size, 
                      bool reuse,
                      Protection_t p_mask = Protection_t (Read | Write),
                      bool persistent = true);
    MapfileHeader* header;
    void* client_data;
    char* file_name;
    int   fd;
    bool  realFile;
    bool  debug;
};



}}} // End namespace carma::ui::rtd


#endif // _MEMORYMAPPEDFILE_H_