Mana
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
Net::LoginHandler Class Referenceabstract

#include <loginhandler.h>

Inheritance diagram for Net::LoginHandler:
ManaServ::LoginHandler TmwAthena::LoginHandler

Public Types

enum  OptionalAction { Unregister = 0x1 , ChangeEmail = 0x2 , SetEmailOnRegister = 0x4 , SetGenderOnRegister = 0x8 }
 This enum describes options specific to either eAthena or Manaserv. More...
 

Public Member Functions

void setServer (const ServerInfo &server)
 
ServerInfo getServer () const
 
virtual void connect ()=0
 
virtual bool isConnected ()=0
 
virtual void disconnect ()=0
 
virtual int supportedOptionalActions () const =0
 
virtual bool isRegistrationEnabled ()=0
 
virtual void getRegistrationDetails ()=0
 
virtual unsigned int getMinUserNameLength () const
 
virtual unsigned int getMaxUserNameLength () const
 
virtual unsigned int getMinPasswordLength () const
 
virtual unsigned int getMaxPasswordLength () const
 
virtual void loginAccount (LoginData *loginData)=0
 
virtual void logout ()=0
 
virtual void changeEmail (const std::string &email)=0
 
virtual void changePassword (const std::string &username, const std::string &oldPassword, const std::string &newPassword)=0
 
virtual void chooseServer (unsigned int server)=0
 
virtual void registerAccount (LoginData *loginData)=0
 
virtual void unregisterAccount (const std::string &username, const std::string &password)=0
 
virtual Worlds getWorlds () const =0
 
virtual ~LoginHandler ()=default
 

Protected Attributes

ServerInfo mServer
 

Detailed Description

Definition at line 30 of file loginhandler.h.

Member Enumeration Documentation

◆ OptionalAction

enum Net::LoginHandler::OptionalAction

This enum describes options specific to either eAthena or Manaserv.

By querying for these flags, the GUI can adapt to the current server type dynamically.

Enumerator
Unregister 
ChangeEmail 
SetEmailOnRegister 
SetGenderOnRegister 

Definition at line 38 of file loginhandler.h.

Constructor & Destructor Documentation

◆ ~LoginHandler()

virtual Net::LoginHandler::~LoginHandler ( )
virtualdefault

Reimplemented in TmwAthena::LoginHandler.

Member Function Documentation

◆ changeEmail()

virtual void Net::LoginHandler::changeEmail ( const std::string &  email)
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ changePassword()

virtual void Net::LoginHandler::changePassword ( const std::string &  username,
const std::string &  oldPassword,
const std::string &  newPassword 
)
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ chooseServer()

virtual void Net::LoginHandler::chooseServer ( unsigned int  server)
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ connect()

virtual void Net::LoginHandler::connect ( )
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ disconnect()

virtual void Net::LoginHandler::disconnect ( )
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ getMaxPasswordLength()

virtual unsigned int Net::LoginHandler::getMaxPasswordLength ( ) const
inlinevirtual

Reimplemented in TmwAthena::LoginHandler.

Definition at line 72 of file loginhandler.h.

◆ getMaxUserNameLength()

virtual unsigned int Net::LoginHandler::getMaxUserNameLength ( ) const
inlinevirtual

Reimplemented in ManaServ::LoginHandler.

Definition at line 68 of file loginhandler.h.

◆ getMinPasswordLength()

virtual unsigned int Net::LoginHandler::getMinPasswordLength ( ) const
inlinevirtual

Definition at line 70 of file loginhandler.h.

◆ getMinUserNameLength()

virtual unsigned int Net::LoginHandler::getMinUserNameLength ( ) const
inlinevirtual

Reimplemented in ManaServ::LoginHandler.

Definition at line 66 of file loginhandler.h.

◆ getRegistrationDetails()

virtual void Net::LoginHandler::getRegistrationDetails ( )
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ getServer()

ServerInfo Net::LoginHandler::getServer ( ) const
inline

Definition at line 48 of file loginhandler.h.

◆ getWorlds()

virtual Worlds Net::LoginHandler::getWorlds ( ) const
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ isConnected()

virtual bool Net::LoginHandler::isConnected ( )
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ isRegistrationEnabled()

virtual bool Net::LoginHandler::isRegistrationEnabled ( )
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ loginAccount()

virtual void Net::LoginHandler::loginAccount ( LoginData *  loginData)
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ logout()

virtual void Net::LoginHandler::logout ( )
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ registerAccount()

virtual void Net::LoginHandler::registerAccount ( LoginData *  loginData)
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ setServer()

void Net::LoginHandler::setServer ( const ServerInfo &  server)
inline

Definition at line 45 of file loginhandler.h.

◆ supportedOptionalActions()

virtual int Net::LoginHandler::supportedOptionalActions ( ) const
pure virtual
See also
OptionalAction

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

◆ unregisterAccount()

virtual void Net::LoginHandler::unregisterAccount ( const std::string &  username,
const std::string &  password 
)
pure virtual

Implemented in ManaServ::LoginHandler, and TmwAthena::LoginHandler.

Member Data Documentation

◆ mServer

ServerInfo Net::LoginHandler::mServer
protected

Definition at line 96 of file loginhandler.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8