TPProto::Login Class Reference

The Frame for logging into a player on the server. More...

#include <login.h>

Inheritance diagram for TPProto::Login:

List of all members.

Public Member Functions
	Login ()
	Default constructor.
virtual	~Login ()
	Required virtual destructor.
void	packBuffer (Buffer *buf)
	Pack the login into a Buffer.
bool	unpackBuffer (Buffer *buf)
	Unpack from a Buffer, always false.
void	setUser (const std::string &name)
	Sets the username to login as.
void	setPass (const std::string &word)
	Sets the password to login with.

---

Detailed Description

The Frame for logging into a player on the server.

---

Member Function Documentation

void TPProto::Login::packBuffer

(

Buffer *

buf

)

[virtual]

Pack the login into a Buffer.

Parameters:

buf

The Buffer to pack into.

Implements TPProto::Frame.

bool TPProto::Login::unpackBuffer

(

Buffer *

buf

)

[virtual]

Unpack from a Buffer, always false.

Since Login frames are only sent to the server, we should not receive them and therefore this method always returns false.

Parameters:

buf

The Buffer, ignored.

Returns:

False always.

Implements TPProto::Frame.

void TPProto::Login::setUser

(

const std::string &

name

)

Sets the username to login as.

Parameters:

name

The username.

void TPProto::Login::setPass

(

const std::string &

word

)

Sets the password to login with.

Parameters:

word

The password.

---

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

• tpproto/login.h
• tpproto/login.cpp

---