drifty/comaps
1
0
Fork 0
mirror of https://codeberg.org/comaps/comaps synced 2025-12-23 22:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source 
Signed-off-by: mvglasow <michael -at- vonglasow.com>
This commit is contained in:
mvglasow
2025-06-08 20:01:35 +03:00
parent d47713516d
commit b98fe1999c
6 changed files with 168 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
indexer/mwm_set.hpp
View File

@@ -141,8 +141,10 @@ public:
explicit MwmSet(size_t cacheSize = 64) : m_cacheSize(cacheSize) {}
virtual ~MwmSet() = default;
// Mwm handle, which is used to refer to mwm and prevent it from
// deletion when its FileContainer is used.
/**
* @brief Mwm handle, which is used to refer to mwm and prevent it from deletion when its
* FileContainer is used.
*/
class MwmHandle
{
public:
@@ -230,19 +232,26 @@ public:
BadFile
};
// An Observer interface to MwmSet. Note that these functions can
// be called from *ANY* thread because most signals are sent when
// some thread releases its MwmHandle, so overrides must be as fast
// as possible and non-blocking when it's possible.
/**
* @brief An Observer interface to `MwmSet`.
*
* Note that these functions can be called from *ANY* thread because most signals are sent when
* some thread releases its MwmHandle, so overrides must be as fast as possible and non-blocking
* when it's possible.
*/
class Observer
{
public:
virtual ~Observer() = default;
// Called when a map is registered for the first time and can be used.
/**
* @brief Called when a map is registered for the first time and can be used.
*/
virtual void OnMapRegistered(platform::LocalCountryFile const & /* localFile */) {}
// Called when a map is deregistered and can no longer be used.
/**
* @brief Called when a map is deregistered and can no longer be used.
*/
virtual void OnMapDeregistered(platform::LocalCountryFile const & /* localFile */) {}
};
@@ -290,7 +299,14 @@ public:
/// @todo In fact, std::shared_ptr<MwmInfo> is a MwmId. Seems like better to make vector<MwmId> interface.
void GetMwmsInfo(std::vector<std::shared_ptr<MwmInfo>> & info) const;
// Clears caches and mwm's registry. All known mwms won't be marked as DEREGISTERED.
/**
* @brief Clears caches and mwm's registry.
*
* All known mwms won't be marked as DEREGISTERED.
*
* @todo what does “all won’t be marked” mean? Not all will be marked/some might not be marked?
* Or all will be unmarked?
*/
void Clear();
void ClearCache();
@@ -334,10 +350,18 @@ private:
ProcessEventList(events);
}
// Sets |status| in |info|, adds corresponding event to |event|.
/**
* @brief Sets `status` in `info`, adds corresponding event to `event`.
* @param info
* @param status
* @param events
*/
void SetStatus(MwmInfo & info, MwmInfo::Status status, EventList & events);
// Triggers observers on each event in |events|.
/**
* @brief Triggers observers on each event in `events`.
* @param events
*/
void ProcessEventList(EventList & events);
/// @precondition This function is always called under mutex m_lock.