Fix Doxygen syntax errors.

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

diff --git a/include/usermanager.h b/include/usermanager.h
index 8b396eab039156afdf456326fee14592f7a93957..92b40b373ba6b595768f40180945e6c6b04bd6c5 100644 (file)
--- a/include/usermanager.h
+++ b/include/usermanager.h
@@ -1,37 +1,37 @@
-/*       +------------------------------------+
- *       | 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>
  *
- * 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 __USERMANAGER_H
-#define __USERMANAGER_H
+
+#ifndef USERMANAGER_H
+#define USERMANAGER_H
 
 #include <list>
 
 /** A list of ip addresses cross referenced against clone counts */
-typedef std::map<irc::string, unsigned int> clonemap;
+typedef std::map<irc::sockets::cidr_mask, unsigned int> clonemap;
 
-class CoreExport UserManager : public Extensible
+class CoreExport UserManager
 {
  private:
-       InspIRCd *ServerInstance;
-
        /** Map of local ip addresses for clone counting
         */
        clonemap local_clones;
  public:
-       UserManager(InspIRCd *Instance) : ServerInstance(Instance)
-       {
-       }
-
        ~UserManager()
        {
                for (user_hash::iterator i = clientlist->begin();i != clientlist->end();i++)
@@ -54,7 +54,7 @@ class CoreExport UserManager : public Extensible
 
        /** Local client list, a vector containing only local clients
         */
-       std::vector<User*> local_users;
+       std::vector<LocalUser*> local_users;
 
        /** Oper list, a vector containing all local and remote opered users
         */
@@ -73,20 +73,19 @@ class CoreExport UserManager : public Extensible
        /** Add a client to the system.
         * This will create a new User, insert it into the user_hash,
         * initialize it as not yet registered, and add it to the socket engine.
-        * @param Instance a pointer to the server instance
         * @param socket The socket id (file descriptor) this user is on
-        * @param iscached This variable is reserved for future use
+        * @param via The socket that this user connected using
         * @param client The IP address and client port of the user
         * @param server The server IP address and port used by the user
         * @return This function has no return value, but a call to AddClient may remove the user.
         */
-       void AddUser(InspIRCd* Instance, int socket, bool iscached, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
+       void AddUser(int socket, ListenSocket* via, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 
        /** Disconnect a user gracefully
-        * @param user The user to remove
-        * @param r The quit reason to show to normal users
-        * @param oreason The quit reason to show to opers
-        * @return Although this function has no return type, on exit the user provided will no longer exist.
+        * @param user The user to remove
+        * @param quitreason The quit reason to show to normal users
+        * @param operreason The quit reason to show to opers
+        * @return Although this function has no return type, on exit the user provided will no longer exist.
         */
        void QuitUser(User *user, const std::string &quitreason, const char* operreason = "");
 
@@ -162,16 +161,6 @@ class CoreExport UserManager : public Extensible
         * @param ... The format arguments
         */
        void ServerPrivmsgAll(const char* text, ...) CUSTOM_PRINTF(2, 3);
-
-       /** Send text to all users with a specific set of modes
-        * @param modes The modes to check against, without a +, e.g. 'og'
-        * @param flags one of WM_OR or WM_AND. If you specify WM_OR, any one of the
-        * mode characters in the first parameter causes receipt of the message, and
-        * if you specify WM_OR, all the modes must be present.
-        * @param text The text format string to send
-        * @param ... The format arguments
-        */
-       void WriteMode(const char* modes, int flags, const char* text, ...) CUSTOM_PRINTF(4, 5);
 };
 
 #endif