TPProto::CommandResult Class Reference

Command result. More...

#include <commandresult.h>

Inheritance diagram for TPProto::CommandResult:

List of all members.

Public Member Functions
	CommandResult ()
	Default constructor.
virtual	~CommandResult ()
	Required virtual destructor.
void	packBuffer (Buffer *buf)
	Pack into a Buffer, Assert(0).
bool	unpackBuffer (Buffer *buf)
	Unpack from a Buffer.
uint32_t	getStatus ()
	Gets the return status of the command.
std::string	getMessage ()
	Gets the command output message string.

---

Detailed Description

Command result.

---

Member Function Documentation

void TPProto::CommandResult::packBuffer

(

Buffer *

buf

)

[virtual]

Pack into a Buffer, Assert(0).

This Frame does not get sent to the server, so this method asserts zero.

Parameters:

buf

Buffer to pack into, ignored.

Implements TPProto::Frame.

bool TPProto::CommandResult::unpackBuffer

(

Buffer *

buf

)

[virtual]

Unpack from a Buffer.

Parameters:

buf

The Buffer to unpack from.

Returns:

True if successful.

Implements TPProto::Frame.

uint32_t TPProto::CommandResult::getStatus

(

)

Gets the return status of the command.

Returns:

The return status.

std::string TPProto::CommandResult::getMessage

(

)

Gets the command output message string.

Returns:

The output message string.

---

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

• tpproto/commandresult.h
• tpproto/commandresult.cpp

---