TPProto::ComponentCache Class Reference

A Cache that caches Components. More...

#include <componentcache.h>

Inheritance diagram for TPProto::ComponentCache:

List of all members.

Public Member Functions
	ComponentCache ()
	Default Constructor.
virtual	~ComponentCache ()
	Destructor.
void	requestComponent (uint32_t compid, const ComponentCallback &cb)
	Gets an Component from the cache.
boost::signals::connection	watchComponent (uint32_t compid, const ComponentCallback &cb)
void	requestComponentIds (const IdSetCallback &cb)
boost::signals::connection	watchComponentIds (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 Components.

---

Member Function Documentation

void TPProto::ComponentCache::requestComponent	(	uint32_t	compid,
		const ComponentCallback &	cb
	)

Gets an Component from the cache.

Parameters:

	compid	The id of the Component to get.
	cb	The ComponentCallback to call to return the Component.

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

---