Merge pull request #1018 from SaberUK/insp20+hidekills

[user/henk/code/inspircd.git] / include / protocol.h

diff --git a/include/protocol.h b/include/protocol.h
index 94b34ce390e13e3916216f93cddc0b113470d9de..aabb5b022c7d444be244b08ffe40313f1a866c1e 100644 (file)
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -1,18 +1,25 @@
-/*       +------------------------------------+
- *       | 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"
 
@@ -44,8 +51,9 @@ class ProtocolInterface
         * @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.
@@ -62,7 +70,8 @@ class ProtocolInterface
 
        /** 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::vector<TranslateType> &translate) { }