mirror of
https://github.com/worldforge/cyphesis
synced 2026-08-13 12:26:04 -04:00
65bd6125d5
* index.dox, common/BaseWorld.cpp, common/BaseWorld.h, common/PropertyFactory.h, common/PropertyManager.h, common/const.h, rulesets/ActivePropertyFactory.h, rulesets/Entity.h, rulesets/Py_Vector3D.h, rulesets/Py_World.h, rulesets/Py_WorldTime.h, rulesets/PythonMindScript.cpp, rulesets/PythonMindScript.h, rulesets/PythonScript.h, rulesets/PythonThingScript.h, rulesets/PythonWrapper.cpp, rulesets/PythonWrapper.h, rulesets/Script.cpp, rulesets/Script.h, server/ArithmeticFactory.h, server/CommServer.h, server/CommSocket.h, server/ScriptFactory.cpp, server/TaskFactory.cpp, server/TaskFactory.h, server/WorldRouter.cpp, tools/AdminClient.h, tools/cyaddrules.cpp, tools/cycmd.cpp, tools/cyconfig.cpp, tools/cydumprules.cpp, tools/cyloadrules.cpp: Add a truck load of inline docs. * tools/cywatchdog.cpp: Mark obsolete file as removed from the build. * tools/cyloadrules.cpp, tools/cyconfig.cpp, tools/cyaddrules.cpp: Rename some overly generic types so they have more indicative and unique names. * FIXME, server/ScriptFactory.cpp, server/TaskFactory.h: Add a couple of formal FIXMEs to sort out the code for loading modules and classes. * rulesets/PythonThingScript.h: Remove some commented out code.
77 lines
3.2 KiB
C++
77 lines
3.2 KiB
C++
// Cyphesis Online RPG Server and AI Engine
|
|
// Copyright (C) 2000-2004 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: CommSocket.h,v 1.12 2006-12-24 14:42:06 alriddoch Exp $
|
|
|
|
#ifndef SERVER_COMM_SOCKET_H
|
|
#define SERVER_COMM_SOCKET_H
|
|
|
|
class CommServer;
|
|
|
|
/// \brief Base class for all classes for handling socket communication.
|
|
/// \ingroup ServerSockets
|
|
class CommSocket {
|
|
protected:
|
|
explicit CommSocket(CommServer & svr);
|
|
public:
|
|
/// Reference to the object that manages all socket communication.
|
|
CommServer & m_commServer;
|
|
|
|
/// \brief Destructor.
|
|
virtual ~CommSocket();
|
|
|
|
/// \brief Get the socket file descriptor.
|
|
///
|
|
/// Used to determine if this socket required attention using select().
|
|
virtual int getFd() const = 0;
|
|
|
|
/// \brief Determine whether this socket is open.
|
|
/// @return true if the socket conneciton is open, false otherwise.
|
|
virtual bool isOpen() const = 0;
|
|
|
|
/// \brief Determine whether this socket has hung up.
|
|
/// @return true if the socket conneciton has hung up, false otherwise.
|
|
virtual bool eof() = 0;
|
|
|
|
/// \brief Read data from the socket.
|
|
///
|
|
/// Called when select has determined that this socket requires attention.
|
|
/// This function should read data from the socket and do any initial
|
|
/// processing required, but must not write to the socket. Writing to
|
|
/// to the socket during this function could result in a timeout
|
|
/// which could result in the server locking up. An processing of the
|
|
/// incoming date which might result in a write to the socket must
|
|
/// be performed in the dispatch() memeber function.
|
|
/// @return true if some exceptional circumstance occured meaning this
|
|
/// socket is no longer usable, false otherwise.
|
|
virtual int read() = 0;
|
|
|
|
/// \brief Post process data read from the socket.
|
|
///
|
|
/// Called after read(), this function should perform post any processing
|
|
/// or dispatch on data that has been read which might result in
|
|
/// writing to the client. A typical example is an Atlas operation
|
|
/// from the client which might have a reply. The Atlas decode is performed
|
|
/// in read(), but the dispatch is delayed until dispatch(). It is
|
|
/// important to use this function correctly, as allowing interaction with
|
|
/// the socket during the read() call can cause the socket to change state
|
|
/// while the data is still being read. This can a cause hangs or
|
|
/// unpredictable behavior especially in the Atlas::Codec code.
|
|
virtual void dispatch() = 0;
|
|
};
|
|
|
|
#endif // SERVER_COMM_SOCKET_H
|