TPProto::FailFrame Class Reference

Represenation of fail or error Frame from the server. More...

#include <failframe.h>

Inheritance diagram for TPProto::FailFrame:

List of all members.

Public Member Functions
	FailFrame ()
	Default constructor.
virtual	~FailFrame ()
	Required virtual destructor.
void	packBuffer (Buffer *buf)
	Assets(0).
bool	unpackBuffer (Buffer *buf)
	Unpack FailFrame from Buffer.
int	getErrorCode ()
	Gets the error code.
std::string	getErrorString ()
	Gets the error string.
std::map< int32_t, uint32_t >	getReferences ()

---

Detailed Description

Represenation of fail or error Frame from the server.

---

Member Function Documentation

void TPProto::FailFrame::packBuffer

(

Buffer *

buf

)

[virtual]

Assets(0).

This method asserts 0 because it should never be sent to the server.

Parameters:

buf

The Buffer (ignored).

Implements TPProto::Frame.

bool TPProto::FailFrame::unpackBuffer

(

Buffer *

buf

)

[virtual]

Unpack FailFrame from Buffer.

Unpacks the FrameErrorCode and error string from the buffer.

Parameters:

buf

The Buffer to unpack from.

Returns:

True if successful.

Implements TPProto::Frame.

int TPProto::FailFrame::getErrorCode

(

)

Gets the error code.

Returns:

The error code.

std::string TPProto::FailFrame::getErrorString

(

)

Gets the error string.

Returns:

The error string.

---

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

• tpproto/failframe.h
• tpproto/failframe.cpp

---