dali/internal/system/common/shared-file.h

   1 #ifndef DALI_INTERNAL_ADAPTOR_SHARED_FILE_H
   2 #define DALI_INTERNAL_ADAPTOR_SHARED_FILE_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <sys/types.h>
  23 #include <string>
  24
  25 namespace Dali
  26 {
  27 namespace Internal
  28 {
  29 namespace Adaptor
  30 {
  31 class SharedFile
  32 {
  33 public:
  34   /**
  35    * Open an existing shared file for read/write
  36    * @return The shared file, or NULL if a file could not be opened and mapped.
  37    */
  38   static SharedFile* New(const char* filename, int size, bool isSystem);
  39
  40   /**
  41    * Constructor
  42    */
  43   SharedFile();
  44
  45   /**
  46    * Destructor
  47    */
  48   virtual ~SharedFile();
  49
  50   /**
  51    * Opens a file descriptor to shared memory segment
  52    * @return The file descriptor
  53    */
  54   int Open(const char* filename, int size, int oflag, mode_t mode);
  55
  56   /**
  57    * Opens a file for read/write
  58    * @return true if opened, false on error.
  59    */
  60   bool OpenFile(const char* filename, int size, bool isSystem);
  61
  62   /**
  63    * Close the shared file
  64    */
  65   void Close();
  66
  67   /**
  68    * Get the memory address of the shared file
  69    * @return the memory address
  70    */
  71   unsigned char* GetAddress();
  72
  73 private:
  74   int         mFileDescriptor;
  75   int         mSize;
  76   void*       mAddress;
  77   std::string mFilename;
  78 };
  79
  80 } // namespace Adaptor
  81 } // namespace Internal
  82 } // namespace Dali
  83
  84 #endif // DALI_INTERNAL_ADAPTOR_SHARED_FILE_H