TPProto::ObjectDescCache Class Reference

A Cache that caches ObjectDescriptions. More...

#include <objectdesccache.h>

Inheritance diagram for TPProto::ObjectDescCache:

List of all members.

Public Member Functions
	ObjectDescCache ()
	Default Constructor.
virtual	~ObjectDescCache ()
	Destructor.
void	requestObjectDescription (uint32_t objtype, const ObjectDescCallback &cb)
boost::signals::connection	watchObjectDescription (uint32_t objtype, const ObjectDescCallback &cb)
void	requestObjectTypes (const IdSetCallback &cb)
boost::signals::connection	watchObjectTypes (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 ObjectDescriptions.

---

Member Function Documentation

uint32_t TPProto::ObjectDescCache::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::ObjectDescCache::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::ObjectDescCache::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::ObjectDescCache::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/objectdesccache.h
• tpproto/objectdesccache.cpp

---