TPProto::Category Class Reference

A Frame to hold Categories from the server. More...

#include <category.h>

Inheritance diagram for TPProto::Category:

List of all members.

Public Member Functions
	Category ()
	Default constructor.
virtual	~Category ()
	Required virtual destructor.
void	packBuffer (Buffer *buf)
	Pack into a Buffer, asserts.
bool	unpackBuffer (Buffer *buf)
	Unpack from a Buffer. Unpacks the Category frame from the buffer.
uint32_t	getCategoryId () const
	Gets the Category id.
uint64_t	getModTime () const
	Gets the last modification time of this Category.
std::string	getName () const
	Gets the name of this Category.
std::string	getDescription () const
	Gets the description of this Category.

---

Detailed Description

A Frame to hold Categories from the server.

---

Member Function Documentation

void TPProto::Category::packBuffer

(

Buffer *

buf

)

[virtual]

Pack into a Buffer, asserts.

Packs this Category frame into the buffer. Since the frame only comes from the server, this method assert(0).

Parameters:

buf

Buffer to pack into, ignored.

Implements TPProto::Frame.

bool TPProto::Category::unpackBuffer

(

Buffer *

buf

)

[virtual]

Unpack from a Buffer. Unpacks the Category frame from the buffer.

Parameters:

buf

The Buffer to unpack out of.

Returns:

True if sucessful, false otherwise.

Implements TPProto::Frame.

uint32_t TPProto::Category::getCategoryId

(

)

const

Gets the Category id.

Returns:

The Category id number.

uint64_t TPProto::Category::getModTime

(

)

const

Gets the last modification time of this Category.

Returns:

The modtime.

std::string TPProto::Category::getName

(

)

const

Gets the name of this Category.

Returns:

The name of the Category.

std::string TPProto::Category::getDescription

(

)

const

Gets the description of this Category.

Returns:

The description of the Category.

---

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

• tpproto/category.h
• tpproto/category.cpp

---