mirror of
https://github.com/worldforge/cyphesis
synced 2026-08-13 12:26:04 -04:00
e7c7e232ac
* client/CharacterClient.cpp, client/ClientConnection.h, rulesets/Character.cpp, rulesets/Character.h, tools/cyaddrules.cpp, tools/cyconfig.cpp, tools/cyconvertrules.cpp, tools/cyctrl.cpp, tools/cydumprules.cpp, tools/cyloadrules.cpp, tools/cypasswd.cpp: Add inline documentation. * client/CharacterClient.h, client/CharacterClient.cpp: Remove overriden sight operation handlers, as they are no longer present in the base class, and will never be called. * client/ClientConnection.h: Remove obsolete unimplemented template declaration. * rulesets/Entity.cpp: Remove documentation for an argument that was never there. * tools/cyctrl.cpp: Mark as removed from the build. * Add a FIXME about removing hard coded gender property
110 lines
3.5 KiB
C++
110 lines
3.5 KiB
C++
// Cyphesis Online RPG Server and AI Engine
|
|
// Copyright (C) 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: ClientConnection.h,v 1.22 2006-12-26 18:24:25 alriddoch Exp $
|
|
|
|
#ifndef CLIENT_CONNECTION_H
|
|
#define CLIENT_CONNECTION_H
|
|
|
|
#include <Atlas/Objects/Decoder.h>
|
|
#include <Atlas/Objects/ObjectsFwd.h>
|
|
#include <Atlas/Objects/SmartPtr.h>
|
|
#include <Atlas/Objects/Root.h>
|
|
#include <Atlas/Codec.h>
|
|
|
|
#include <skstream/skstream.h>
|
|
|
|
#include <deque>
|
|
|
|
namespace Atlas {
|
|
class Codec;
|
|
namespace Objects {
|
|
class ObjectsEncoder;
|
|
}
|
|
}
|
|
|
|
/// \brief Class to handle socket connection to a cyphesis server from an
|
|
/// an admin client
|
|
class ClientConnection : public Atlas::Objects::ObjectsDecoder {
|
|
private:
|
|
/// \brief Flag to indicate that a reply has been received from the server
|
|
bool reply_flag;
|
|
/// \brief Flag to indicate that an error has been received from the server
|
|
bool error_flag;
|
|
/// \brief File descriptor used to communicate with the server
|
|
int client_fd;
|
|
/// \brief iostream used to communicate with the server
|
|
tcp_socket_stream ios;
|
|
/// \brief Atlas codec used to communicate with the server
|
|
Atlas::Codec * codec;
|
|
/// \brief Atlas encoder used to serialise messages for the server
|
|
Atlas::Objects::ObjectsEncoder * encoder;
|
|
/// \brief Store for reply data from the server
|
|
Atlas::Objects::Root reply;
|
|
/// \brief Counter used to track serial numbers sent to the server
|
|
int serialNo;
|
|
|
|
/// \brief Store for operations arrived from the server
|
|
std::deque<Atlas::Objects::Operation::RootOperation> operationQueue;
|
|
|
|
void operation(const Atlas::Objects::Operation::RootOperation&);
|
|
|
|
int negotiate();
|
|
|
|
virtual void objectArrived(const Atlas::Objects::Root &);
|
|
|
|
void errorArrived(const Atlas::Objects::Operation::RootOperation &);
|
|
void infoArrived(const Atlas::Objects::Operation::RootOperation &);
|
|
|
|
public:
|
|
ClientConnection();
|
|
~ClientConnection();
|
|
|
|
int read();
|
|
int connectLocal(const std::string &);
|
|
int connect(const std::string &);
|
|
void login(const std::string &, const std::string &);
|
|
void create(const std::string &, const std::string &);
|
|
int wait();
|
|
void send(const Atlas::Objects::Operation::RootOperation & op);
|
|
|
|
/// \brief Check the iostream for waiting data
|
|
int peek() {
|
|
return ios.peek();
|
|
}
|
|
|
|
/// \brief Check the iostream to see if it is disconnected
|
|
int eof() {
|
|
return ios.eof();
|
|
}
|
|
|
|
/// \brief Accessor to the server file descriptor
|
|
int get_fd() {
|
|
return client_fd;
|
|
}
|
|
|
|
/// \brief Read only accessor for Info reply data from the server
|
|
const Atlas::Objects::Root & getReply() {
|
|
return reply;
|
|
}
|
|
|
|
void poll(int timeOut = 0);
|
|
Atlas::Objects::Operation::RootOperation pop();
|
|
bool pending();
|
|
};
|
|
|
|
#endif // CLIENT_CONNECTION_H
|