ibm/libpldmresponder/file_table.hpp

25  *  PLDM File I/O. The file handle is used to uniquely identify the file. The
26  *  traits provide information whether the file is Read only, Read/Write and
31     Handle handle;       //!< File handle
32     fs::path fsPath;     //!< File path
33     bitfield32_t traits; //!< File traits
39  *  File I/O and provides interfaces to lookup files information based on the
40  *  file handle and extract the file attribute table. The file attribute table
41  *  comprises of metadata for files. Metadata includes the file handle, file
42  *  name, current file size and file traits.
47     /** @brief The file table is initialised by parsing the config file
50      * @param[in] fileTableConfigPath - path to the json file containing
61     /** @brief Get the file attribute table
63      * @return Table- contents of the file attribute table
67     /** @brief Get the FileEntry at the file handle
69      * @param[in] handle - file handle
71      * @return FileEntry - file entry at the handle
78     /** @brief Check is file attribute table is empty
80      * @return bool - true if file attribute table is empty, false otherwise.
87     /** @brief Clear the file table contents
99     /** @brief handle to FileEntry mappings for lookups based on file handle */
102     /** @brief file attribute table including the pad bytes, except the checksum
106     /** @brief the pad count of the file attribute table, the number of pad
110     /** @brief the checksum of the file attribute table */
114 /** @brief Build the file attribute table if not already built using the
115  *         file table config.
117  *  @param[in] fileTablePath - path of the file table config
119  *  @return FileTable& - Reference to instance of file table