-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2009 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * This file is part of InspIRCd. InspIRCd 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, version 2.
*
- * ---------------------------------------------------
+ * 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, see <http://www.gnu.org/licenses/>.
*/
-#ifndef __PROTOCOL_H__
-#define __PROTOCOL_H__
+
+#ifndef PROTOCOL_H
+#define PROTOCOL_H
#include "hashcomp.h"
-class InspIRCd;
class User;
-typedef std::deque<std::string> parameterlist;
+typedef std::vector<std::string> parameterlist;
class ProtoServer
{
typedef std::list<ProtoServer> ProtoServerList;
-class ProtocolInterface : public Extensible
+class ProtocolInterface
{
- protected:
- InspIRCd* ServerInstance;
public:
- ProtocolInterface(InspIRCd* Instance) : ServerInstance(Instance) { }
+ ProtocolInterface() { }
virtual ~ProtocolInterface() { }
/** Send an ENCAP message to one or more linked servers.
* @param encap This is a list of string parameters, the first of which must be a server ID or glob matching servernames.
* The second must be a subcommand. All subsequent parameters are dependant on the subcommand.
* ENCAP (should) be used instead of creating new protocol messages for easier third party application support.
+ * @return True if the message was sent out (target exists)
*/
- virtual void SendEncapsulatedData(parameterlist &encap) { }
+ virtual bool SendEncapsulatedData(const parameterlist &encap) { return false; }
/** Send metadata for an object to other linked servers.
* @param target The object to send metadata for.
- * @param type The type of metadata to send (TYPE_USER, TYPE_CHANNEL, etc)
* @param key The 'key' of the data, e.g. "swhois" for swhois desc on a user
* @param data The string representation of the data
*/
- virtual void SendMetaData(void* target, TargetTypeFlags type, const std::string &key, const std::string &data) { }
+ virtual void SendMetaData(Extensible* target, const std::string &key, const std::string &data) { }
/** Send a topic change for a channel
* @param channel The channel to change the topic for.
/** Send mode changes for an object.
* @param target The channel name or user to send mode changes for.
- * @param The mode changes to send.
+ * @param modedata The mode changes to send.
+ * @param translate A list of translation types
*/
- virtual void SendMode(const std::string &target, const parameterlist &modedata, const std::deque<TranslateType> &translate) { }
+ virtual void SendMode(const std::string &target, const parameterlist &modedata, const std::vector<TranslateType> &translate) { }
/** Convenience function, string wrapper around the above.
*/
{
irc::spacesepstream x(modeline);
parameterlist n;
- std::deque<TranslateType> types;
+ std::vector<TranslateType> types;
std::string v;
while (x.GetToken(v))
{
SendMode(target, n, types);
}
- /** Send a notice to users with a given mode(s).
- * @param modes The modes required for the message to be sent.
- * @param text The message to send.
- */
- virtual void SendModeNotice(const std::string &modes, const std::string &text) { }
-
/** Send a notice to users with a given snomask.
* @param snomask The snomask required for the message to be sent.
* @param text The message to send.
* XXX: document me properly, this is shit.
*/
virtual void GetServerList(ProtoServerList &sl) { }
-
- /** Send information about a user connection to linked servers.
- * @param u The user to send information about.
- */
- virtual void Introduce(User* u) { }
};
#endif