TPProto::CategoryCache Class Reference

A Cache that caches Categories. More...

#include <categorycache.h>

Inheritance diagram for TPProto::CategoryCache:

List of all members.

Public Member Functions
	CategoryCache ()
	Default Constructor.
virtual	~CategoryCache ()
	Destructor.
void	requestCategory (uint32_t catid, const CategoryCallback &cb)
boost::signals::connection	watchCategory (uint32_t catid, const CategoryCallback &cb)
void	addCategory (Category *cat)
	Adds a Category to the server.
void	removeCategory (uint32_t catid)
	Removes a category from the server.
void	invalidateCategory (uint32_t catid)
	Set an Category Id as invalid and mark to be refetched.
void	requestCategoryIds (const IdSetCallback &cb)
boost::signals::connection	watchCategoryIds (const IdSetCallback &cb)
virtual GetIdSequence *	createGetIdSequenceFrame ()
	Create a GetIdsSequence subclass frame for the CacheMethod to use. Must return the correct type of frame for this Cache.
virtual GetById *	createGetByIdFrame ()
	Create a GetById subclass frame for the CacheMethod to use. Must return the correct type of frame for this Cache.
virtual uint32_t	getIdFromFrame (Frame *frame)
	Get the Id from the Frame provided. The Frame is of the correct type. For example, for the Object cache, the Frame will be an Object.
virtual uint64_t	getModTimeFromFrame (Frame *frame)
	Get the Modification time from the Frame provided. The Frame is of the correct type. For example, for the Object cache, the Frame will be an Object.
virtual void	newItem (boost::shared_ptr< Frame > item)
	Receive a new or updated version of an item from the CacheMethod.
virtual void	existingItem (boost::shared_ptr< Frame > item)
	Receive an existing item from the CacheMethod.

---

Detailed Description

A Cache that caches Categories.

---

Member Function Documentation

void TPProto::CategoryCache::addCategory

(

Category *

cat

)

Adds a Category to the server.

Parameters:

cat

The Category to add.

void TPProto::CategoryCache::removeCategory

(

uint32_t

catid

)

Removes a category from the server.

Sends the RemoveCategory frame and receives the reply.

Parameters:

catid

The Category Id to remove.

void TPProto::CategoryCache::invalidateCategory

(

uint32_t

catid

)

Set an Category Id as invalid and mark to be refetched.

Parameters:

catid

The id of the Category to invalidate.

uint32_t TPProto::CategoryCache::getIdFromFrame

(

Frame *

frame

)

[virtual]

Get the Id from the Frame provided. The Frame is of the correct type. For example, for the Object cache, the Frame will be an Object.

Parameters:

frame

The Frame to get the Id from.

Returns:

The id of the frame.

Implements TPProto::Cache.

uint64_t TPProto::CategoryCache::getModTimeFromFrame

(

Frame *

frame

)

[virtual]

Get the Modification time from the Frame provided. The Frame is of the correct type. For example, for the Object cache, the Frame will be an Object.

Parameters:

frame

The Frame to get the Modtime from.

Returns:

The modtime of the frame.

Implements TPProto::Cache.

void TPProto::CategoryCache::newItem

(

boost::shared_ptr< Frame >

item

)

[virtual]

Receive a new or updated version of an item from the CacheMethod.

Parameters:

item

The existing item in a Frame

Implements TPProto::Cache.

void TPProto::CategoryCache::existingItem

(

boost::shared_ptr< Frame >

item

)

[virtual]

Receive an existing item from the CacheMethod.

Parameters:

item

The existing item in a Frame

Implements TPProto::Cache.

---

The documentation for this class was generated from the following files:

• tpproto/categorycache.h
• tpproto/categorycache.cpp

---