Change some class naming conventions

This commit is contained in:
2023-09-15 13:28:18 -04:00
parent 40881ec284
commit cd3c82f2c4
20 changed files with 160 additions and 157 deletions

View File

@@ -4,7 +4,7 @@
#include "LockedWrapper.h"
#include <string>
// Class FLpxSockets
// Class FlxSockets
//
// This class is responsible for creating outgoing and incoming
// sockets for the Luprex engine. It then relays data into and out
@@ -13,39 +13,39 @@
// It only has one interesting method: Update(). This one method
// does all the communication for the Luprex engine. Note that
// there aren't any methods where Unreal can query the state
// of the FLpxSockets. That's because this class is for
// of the FlxSockets. That's because this class is for
// communication between Luprex and outside servers and clients,
// NOT for communication with Unreal.
//
// The FLpxSockets keeps a pointer to the EngineWrapper.
// The EngineWrapper must outlive the FLpxSockets.
// The FlxSockets keeps a pointer to the EngineWrapper.
// The EngineWrapper must outlive the FlxSockets.
//
// This class is an abstract base class. A derived class
// implements all the behavior.
//
class FLpxSockets;
class FlxSockets;
struct EngineWrapper;
class FLpxSockets
class FlxSockets
{
protected:
FLpxSockets() {}
FlxSockets() {}
public:
// Create the Luprex socket system.
static FLpxSockets* Create(FLockedWrapper &w);
static FlxSockets* Create(FlxLockedWrapper &w);
// Close all sockets.
virtual void ForceCloseEverything(FLockedWrapper& w) = 0;
virtual void ForceCloseEverything(FlxLockedWrapper& w) = 0;
// The update routine relays data into and out of
// luprex via TCP/IP sockets.
virtual void Update(FLockedWrapper& w) = 0;
virtual void Update(FlxLockedWrapper& w) = 0;
// Delete the luprex socket system.
// You must call ForceCloseEverything first.
virtual ~FLpxSockets() {}
virtual ~FlxSockets() {}
// Obtain any error status report.
virtual std::string GetError() = 0;