TPProto::CommandDescCache Class Reference

A Cache that caches OrderDescriptions. More...

#include <commanddesccache.h>

Inheritance diagram for TPProto::CommandDescCache:

List of all members.

Public Member Functions
	CommandDescCache ()
	Default Constructor.
virtual	~CommandDescCache ()
	Destructor.
void	requestCommandDescription (uint32_t cmdtype, const CommandDescCallback &cb)
	Request a command description.
boost::signals::connection	watchCommandDescription (uint32_t cmdtype, const CommandDescCallback &cb)
	Watch a command description.
void	requestCommandTypes (const IdSetCallback &cb)
	Request a list of command type IDs.
boost::signals::connection	watchCommandTypes (const IdSetCallback &cb)
	Watch the list of command type IDs.
virtual GetIdSequence *	createGetIdSequenceFrame ()
	Create a Get Command Type IDs frame.
virtual GetById *	createGetByIdFrame ()
	Create a Get Command Description frame.
virtual uint32_t	getIdFromFrame (Frame *frame)
	Get the command type ID from a Command Description frame.
virtual uint64_t	getModTimeFromFrame (Frame *frame)
	Get the modification time from a Command Description frame.
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 OrderDescriptions.

---

Member Function Documentation

void TPProto::CommandDescCache::requestCommandDescription	(	uint32_t	cmdtype,
		const CommandDescCallback &	cb
	)

Request a command description.

Parameters:

	cmdtype	The command type ID.
	cb	The callback function for the description.

boost::signals::connection TPProto::CommandDescCache::watchCommandDescription	(	uint32_t	cmdtype,
		const CommandDescCallback &	cb
	)

Watch a command description.

Parameters:

	cmdtype	The command type ID.
	cb	The callback function for the description.

Returns:

The connection for the callback.

void TPProto::CommandDescCache::requestCommandTypes

(

const IdSetCallback &

cb

)

Request a list of command type IDs.

Parameters:

cb

The callback function for the sequence.

boost::signals::connection TPProto::CommandDescCache::watchCommandTypes

(

const IdSetCallback &

cb

)

Watch the list of command type IDs.

Parameters:

cb

The callback function for the sequence.

Returns:

The connection for the callback.

GetIdSequence * TPProto::CommandDescCache::createGetIdSequenceFrame

(

)

[virtual]

Create a Get Command Type IDs frame.

Returns:

The Get Command Type IDs frame.

Implements TPProto::Cache.

GetById * TPProto::CommandDescCache::createGetByIdFrame

(

)

[virtual]

Create a Get Command Description frame.

Returns:

The Get Command Description frame.

Implements TPProto::Cache.

uint32_t TPProto::CommandDescCache::getIdFromFrame

(

Frame *

frame

)

[virtual]

Get the command type ID from a Command Description frame.

Parameters:

frame

The Command Description frame.

Returns:

The command type ID.

Implements TPProto::Cache.

uint64_t TPProto::CommandDescCache::getModTimeFromFrame

(

Frame *

frame

)

[virtual]

Get the modification time from a Command Description frame.

Parameters:

frame

The Command Description frame.

Returns:

The modification time.

Implements TPProto::Cache.

void TPProto::CommandDescCache::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::CommandDescCache::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/commanddesccache.h
• tpproto/commanddesccache.cpp

---