TPProto::OkFrame Class Reference

The OkFrame is sent from the server to say that an operation was successful. More...

#include <okframe.h>

Inheritance diagram for TPProto::OkFrame:

List of all members.

Public Member Functions
	OkFrame ()
	Default constructor.
virtual	~OkFrame ()
	Required virtual destructor.
void	packBuffer (Buffer *buf)
	Pack into a Buffer, Assert(0).
bool	unpackBuffer (Buffer *buf)
	Unpack from a Buffer.
std::string	getInfo ()
	Gets the informational string sent in the OKFrame.
Protected Attributes
std::string	info
	The information string sent by the server.

---

Detailed Description

The OkFrame is sent from the server to say that an operation was successful.

---

Member Function Documentation

void TPProto::OkFrame::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::OkFrame::unpackBuffer

(

Buffer *

buf

)

[virtual]

Unpack from a Buffer.

Parameters:

buf

The Buffer to unpack out of.

Returns:

True if successful, false otherwise.

Implements TPProto::Frame.

std::string TPProto::OkFrame::getInfo

(

)

Gets the informational string sent in the OKFrame.

Returns:

The informational string.

---

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

• tpproto/okframe.h
• tpproto/okframe.cpp

---