mirror of
https://github.com/DarkflameUniverse/DarkflameServer.git
synced 2024-12-24 06:23:35 +00:00
64 lines
2.8 KiB
C++
64 lines
2.8 KiB
C++
/// \file
|
|
/// \brief Contains ConsoleServer , used to plugin to your game to accept remote console-based connections
|
|
///
|
|
/// This file is part of RakNet Copyright 2003 Kevin Jenkins.
|
|
///
|
|
/// Usage of RakNet is subject to the appropriate license agreement.
|
|
/// Creative Commons Licensees are subject to the
|
|
/// license found at
|
|
/// http://creativecommons.org/licenses/by-nc/2.5/
|
|
/// Single application licensees are subject to the license found at
|
|
/// http://www.jenkinssoftware.com/SingleApplicationLicense.html
|
|
/// Custom license users are subject to the terms therein.
|
|
/// GPL license users are subject to 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.
|
|
|
|
#ifndef __CONSOLE_SERVER_H
|
|
#define __CONSOLE_SERVER_H
|
|
|
|
class TransportInterface;
|
|
class CommandParserInterface;
|
|
|
|
#include "RakMemoryOverride.h"
|
|
#include "DS_List.h"
|
|
#include "RakNetTypes.h"
|
|
#include "Export.h"
|
|
|
|
/// \brief The main entry point for the server portion of your remote console application support.
|
|
/// ConsoleServer takes one TransportInterface and one or more CommandParserInterface (s)
|
|
/// The TransportInterface will be used to send data between the server and the client. The connecting client must support the
|
|
/// protocol used by your derivation of TransportInterface . TelnetTransport and RakNetTransport are two such derivations .
|
|
/// When a command is sent by a remote console, it will be processed by your implementations of CommandParserInterface
|
|
class RAK_DLL_EXPORT ConsoleServer : public RakNet::RakMemoryOverride
|
|
{
|
|
public:
|
|
ConsoleServer();
|
|
~ConsoleServer();
|
|
|
|
/// Call this with a derivation of TransportInterface so that the console server can send and receive commands
|
|
/// \param[in] transportInterface Your interface to use.
|
|
/// \param[in] port The port to host on. Telnet uses port 23 by default. RakNet can use whatever you want.
|
|
void SetTransportProvider(TransportInterface *transportInterface, unsigned short port);
|
|
|
|
/// Add an implementation of CommandParserInterface to the list of command parsers.
|
|
/// \param[in] commandParserInterface The command parser referred to
|
|
void AddCommandParser(CommandParserInterface *commandParserInterface);
|
|
|
|
/// Remove an implementation of CommandParserInterface previously added with AddCommandParser()
|
|
/// \param[in] commandParserInterface The command parser referred to
|
|
void RemoveCommandParser(CommandParserInterface *commandParserInterface);
|
|
|
|
/// Call update to read packet sent from your TransportInterface.
|
|
/// You should do this fairly frequently.
|
|
void Update(void);
|
|
protected:
|
|
void ListParsers(SystemAddress systemAddress);
|
|
TransportInterface *transport;
|
|
DataStructures::List<CommandParserInterface *> commandParserList;
|
|
char* password[256];
|
|
};
|
|
|
|
#endif
|