cyphesis/client/BaseClient.h
Al Riddoch 0f44eff410 2006-12-26 Al Riddoch <alriddoch@zepler.org>
* client/BaseClient.cpp, client/BaseClient.h,
	  client/ClientConnection.cpp, common/AtlasFileLoader.cpp,
	  common/AtlasFileLoader.h, common/BaseEntity.cpp, common/BaseEntity.h,
	  common/Property.h, common/accountbase.cpp, common/accountbase.h,
	  rulesets/ActivePropertyFactory.h,
	  rulesets/ActivePropertyFactory_impl.h, rulesets/Area.cpp,
	  rulesets/Area.h, rulesets/AreaProperty.cpp, rulesets/AreaProperty.h,
	  rulesets/BaseMind.cpp, rulesets/BaseMind.h, server/Account.cpp,
	  server/Admin.cpp, server/Admin.h, server/ArithmeticFactory.h,
	  tests/Makefile.am, tools/AdminClient.cpp, tools/AdminClient.h,
	  tools/cycmd.cpp: Add inline documentation.

	* rulesets/ActivePropertyFactory.h: Use handler function pointer
	  typedef for readability.

	* rulesets/AreaProperty.cpp, rulesets/AreaProperty.h: Fix PropertyBase
	  overriding by adding const to the right methods.
2006-12-26 14:30:42 +00:00

78 lines
2.6 KiB
C++

// Cyphesis Online RPG Server and AI Engine
// Copyright (C) 2000,2001 Alistair Riddoch
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
// $Id: BaseClient.h,v 1.21 2006-12-26 14:30:43 alriddoch Exp $
#ifndef CLIENT_BASE_CLIENT_H
#define CLIENT_BASE_CLIENT_H
#include "ClientConnection.h"
class CreatorClient;
/// \brief Base class for classes that implement clients used to connect to a
/// cyphesis server
class BaseClient {
protected:
/// \brief Low level connection to the server
ClientConnection m_connection;
/// \brief Client object that manages the creator avatar
CreatorClient * m_character;
/// \brief Store for details of the account after login
Atlas::Message::MapType m_player;
/// \brief Name used for the username of the account and the name of avatars
std::string m_playerName;
/// \brief Identifier of the Account on the server after login
std::string m_playerId;
public:
BaseClient();
virtual ~BaseClient();
Atlas::Message::MapType createPlayer(const std::string & name,
const std::string & pword);
CreatorClient * createCharacter(const std::string & name);
void handleNet();
/// \brief Function called when nothing else is going on
virtual void idle() = 0;
/// \brief Connect to a local server via a unix socket
int connectLocal(const std::string & socket = "") {
return m_connection.connectLocal(socket);
}
/// \brief Connect to a remote server using a network socket
int connect(const std::string & server = "localhost") {
return m_connection.connect(server);
}
/// \brief Send an operation to the server
void send(const Atlas::Objects::Operation::RootOperation & op) {
m_connection.send(op);
}
/// \brief Default client main loop
void run(const bool loop = true) {
while (loop) {
handleNet();
idle();
};
}
};
#endif // CLIENT_BASE_CLIENT_H