openbmc/phosphor-ipmi-blobs/manager.hpp

52                       uint16_t* session) = 0;
56     virtual bool stat(uint16_t session, BlobMeta* meta) = 0;
58     virtual bool commit(uint16_t session, const std::vector<uint8_t>& data) = 0;
60     virtual bool close(uint16_t session) = 0;
62     virtual std::vector<uint8_t> read(uint16_t session, uint32_t offset,
65     virtual bool write(uint16_t session, uint32_t offset,
70     virtual bool writeMeta(uint16_t session, uint32_t offset,
121      * Attempts to open the file specified and associates with a session.
125      * @param[in,out] session - pointer to store the session on success.
129               uint16_t* session) override;
141      * Attempts to retrieve a BlobMeta for a given session.
143      * @param[in] session - the session for this command.
147     bool stat(uint16_t session, BlobMeta* meta) override;
150      * Attempt to commit a blob for a given session.
152      * @param[in] session - the session for this command.
156     bool commit(uint16_t session, const std::vector<uint8_t>& data) override;
159      * Attempt to close a session.  If the handler returns a failure
160      * in closing, the session is kept open.
162      * @param[in] session - the session for this command.
163      * @return bool - true if the session was closed.
165     bool close(uint16_t session) override;
171      * @param[in] session - the session for this command.
176     std::vector<uint8_t> read(uint16_t session, uint32_t offset,
181      * the session opened the file for writing.
183      * @param[in] session - the session for this command.
188     bool write(uint16_t session, uint32_t offset,
211      * @param[in] session - the session for this command.
216     bool writeMeta(uint16_t session, uint32_t offset,
220      * Attempts to return a valid unique session id.
222      * @param[in,out] - pointer to the session.
225     bool getSession(uint16_t* session);
238      * Given a session id, update session time and return a handler to take
241      * @param[in] session - session ID
243      *            session contain these flags; defaults to any flag
244      * @return session handler, nullptr if cannot get handler
247         uint16_t session,
251      * Helper method to erase a session from all maps
254      * @param[in] session - session ID for lookup
257     void eraseSession(GenericBlobInterface* const handler, uint16_t session);
260      * For each session owned by this handler, call expire if it is stale
267     /* How long a session has to be inactive to be considered stale */
269     /* The next session ID to use */
275     /* Mapping of session ids to blob handlers and the path used with open.