Класс QCache

Класс QCache — это шаблонный класс, предоставляющий кэш. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются реентерабельными.

Открытые функции

Подробное описание

QCache<Key, T> определяет кэш, который хранит объекты типа T, связанные с ключами типа Key. Например, вот определение кэша, который хранит объекты типа Employee, связанные с целочисленным ключом:

QCache<int, Employee> cache;

Вот как вставить объект в кэш:

Employee *employee = new Employee;
employee->setId(37);
employee->setName("Richard Schmit");
...
cache.insert(employee->id(), employee);

Преимущества использования QCache по сравнению с другими структурами данных на основе ключей (такими как QMap или QHash) заключаются в том, что QCache автоматически принимает владение объектами, которые вставляются в кэш, и удаляет их, чтобы освободить место для новых объектов, при необходимости. При вставке объекта в кэш вы можете указать стоимость, которая должна иметь некоторое приблизительное отношение к объему памяти, занимаемой объектом. Когда сумма стоимости всех объектов (totalCost()) превышает предел кэша (maxCost()), QCache начинает удалять объекты в кэше, чтобы поддерживать предел, начиная с менее недавно обращённых объектов.

По умолчанию maxCost() QCache составляет 100. Вы можете указать другое значение в конструкторе QCache:

QCache<int, MyDataStructure> cache(5000);

Каждый раз, когда вы вызываете insert(), вы можете указать стоимость в качестве третьего аргумента (после ключа и указателя на объект для вставки). После вызова вставленный объект принадлежит QCache, который может удалить его в любое время, чтобы освободить место для других объектов.

Чтобы найти объекты в кэше, используйте object() или оператор []. Эта функция находит объект по его ключу и возвращает либо указатель на кэшированный объект (который принадлежит кэшу), либо nullptr.

Если вы хотите удалить объект из кэша для определённого ключа, вызовите remove(). Это также удалит объект. Если вы хотите удалить объект из кэша без удаления его QCache, используйте take().

См. также QPixmapCache, QHash и QMap.

Документация по членам-функциям

QCache::QCache(int maxCost = ...)

Конструирует кэш, содержимое которого никогда не будет иметь суммарную стоимость, превышающую maxCost.

QCache::~QCache()

Удаляет кэш. Удаляет все объекты в кэше.

void QCache::clear()

Удаляет все объекты в кэше.

См. также remove() и take().

bool QCache::contains(const Key &key) const

Возвращает true если в кэше есть объект, связанный с ключом key; в противном случае возвращает false.

См. также take() и remove().

int QCache::count() const

То же, что и size().

bool QCache::insert(const Key &key, T *object, int cost = ...)

Вставляет object в кэш с ключом key и связанной стоимостью cost. Любой объект с тем же ключом, уже находящийся в кэше, будет удалён.

После этого вызова object принадлежит QCache и может быть удалён в любое время. В частности, если cost больше, чем maxCost(), объект будет удалён немедленно.

Функция возвращает true если объект был вставлен в кэш; в противном случае она возвращает false.

См. также take() и remove().

bool QCache::isEmpty() const

Возвращает true если кэш не содержит объектов; в противном случае возвращает false.

См. также size().

QList<Key> QCache::keys() const

Возвращает список ключей в кэше.

int QCache::maxCost() const

Возвращает максимальную разрешённую суммарную стоимость кэша.

См. также setMaxCost() и totalCost().

T *QCache::object(const Key &key) const

Возвращает объект, связанный с ключом key, или nullptr если ключ не существует в кэше.

Предупреждение: Возвращаемый объект принадлежит QCache и может быть удалён в любое время.

См. также take() и remove().

bool QCache::remove(const Key &key)

Удаляет объект, связанный с ключом key. Возвращает true если объект был найден в кэше; в противном случае возвращает false.

См. также take() и clear().

void QCache::setMaxCost(int cost)

Устанавливает максимальную разрешённую суммарную стоимость кэша на cost. Если текущая суммарная стоимость больше cost, некоторые объекты удаляются немедленно.

См. также maxCost() и totalCost().

int QCache::size() const

Возвращает количество объектов в кэше.

См. также isEmpty().

T *QCache::take(const Key &key)

Извлекает объект, связанный с ключом key, из кэша без его удаления. Возвращает указатель на извлечённый объект или 0, если ключ не существует в кэше.

Владение возвращённым объектом передаётся вызывающему коду.

См. также remove().

int QCache::totalCost() const

Возвращает суммарную стоимость объектов в кэше.

Это значение обычно ниже maxCost(), но QCache делает исключение для неявного совместного использования в Qt. Если кэшированный объект разделяет свои внутренние данные с другой инстанцией, QCache может оставить объект, возможно, увеличивая totalCost() больше, чем maxCost().

См. также setMaxCost().

T *QCache::operator[](const Key &key) const

Возвращает объект, связанный с ключом key, или nullptr если ключ не существует в кэше.

Это то же самое, что и object().

Предупреждение: Возвращаемый объект принадлежит QCache и может быть удалён в любое время.