]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/socket.h
Fix Doxygen syntax errors.
[user/henk/code/inspircd.git] / include / socket.h
index f97630d0463070d7e3d253415f52723fc4784aae..16809c3f81988bd75da2dcae0819348d5fc56f4a 100644 (file)
@@ -1,16 +1,27 @@
-/*       +------------------------------------+
- *       | 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) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2005-2007 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
+ *   Copyright (C) 2006 William Pitcock <nenolod@dereferenced.org>
  *
- * 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 INSPIRCD_SOCKET_H
 #define INSPIRCD_SOCKET_H
 
@@ -34,7 +45,6 @@
 #endif
 
 #include <cerrno>
-#include "socketengine.h"
 
 /* Contains irc-specific definitions */
 namespace irc
@@ -45,38 +55,46 @@ namespace irc
         */
        namespace sockets
        {
-
-               typedef union {
+               union CoreExport sockaddrs
+               {
                        struct sockaddr sa;
                        struct sockaddr_in in4;
                        struct sockaddr_in6 in6;
-               } sockaddrs;
-
-               /** Match raw binary data using CIDR rules.
-                *
-                * This function will use binary comparison to compare the
-                * two bit sequences, address and mask, up to mask_bits
-                * bits in size. If they match, it will return true.
-                * @param address The whole address, of 4 or 16 bytes in length
-                * @param mask The mask, from 1 to 16 bytes in length, anything
-                * from 1 to 128 bits of which is significant
-                * @param mask_Bits How many bits of the mask parameter are significant
-                * for this comparison.
-                * @returns True if the first mask_bits of address matches the first
-                * mask_bits of mask.
-                */
-               CoreExport bool MatchCIDRBits(const unsigned char* address, const unsigned char* mask, unsigned int mask_bits);
-
-               /** Match CIDR, without matching username/nickname parts.
-                *
-                * This function will compare a human-readable address against a human-
-                * readable CIDR mask, for example 1.2.3.4 against 1.2.0.0/16. This
-                * method supports both IPV4 and IPV6 addresses.
-                * @param address The human readable address, e.g. 1.2.3.4
-                * @param cidr_mask The human readable mask, e.g. 1.2.0.0/16
-                * @return True if the mask matches the address
-                */
-               CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask);
+                       /** Return the size of the structure for syscall passing */
+                       int sa_size() const;
+                       /** Return port number or -1 if invalid */
+                       int port() const;
+                       /** Return IP only */
+                       std::string addr() const;
+                       /** Return human-readable IP/port pair */
+                       std::string str() const;
+                       bool operator==(const sockaddrs& other) const;
+                       inline bool operator!=(const sockaddrs& other) const { return !(*this == other); }
+               };
+
+               struct CoreExport cidr_mask
+               {
+                       /** Type, AF_INET or AF_INET6 */
+                       unsigned char type;
+                       /** Length of the mask in bits (0-128) */
+                       unsigned char length;
+                       /** Raw bits. Unused bits must be zero */
+                       unsigned char bits[16];
+
+                       cidr_mask() {}
+                       /** Construct a CIDR mask from the string. Will normalize (127.0.0.1/8 => 127.0.0.0/8). */
+                       cidr_mask(const std::string& mask);
+                       /** Construct a CIDR mask of a given length from the given address */
+                       cidr_mask(const irc::sockets::sockaddrs& addr, int len);
+                       /** Equality of bits, type, and length */
+                       bool operator==(const cidr_mask& other) const;
+                       /** Ordering defined for maps */
+                       bool operator<(const cidr_mask& other) const;
+                       /** Match within this CIDR? */
+                       bool match(const irc::sockets::sockaddrs& addr) const;
+                       /** Human-readable string */
+                       std::string str() const;
+               };
 
                /** Match CIDR, including an optional username/nickname part.
                 *
@@ -87,19 +105,13 @@ namespace irc
                 * IPV6 addresses.
                 * @param address The human readable address, e.g. fred\@1.2.3.4
                 * @param cidr_mask The human readable mask, e.g. *\@1.2.0.0/16
+                * @param match_with_username Does the  mask include a nickname segment?
                 * @return True if the mask matches the address
                 */
                CoreExport bool MatchCIDR(const std::string &address, const std::string &cidr_mask, bool match_with_username);
 
-               /** Create a new valid file descriptor using socket()
-                * @return On return this function will return a value >= 0 for success,
-                * or a negative value upon failure (negative values are invalid file
-                * descriptors)
-                */
-               CoreExport int OpenTCPSocket(const char* addr, int socktype = SOCK_STREAM);
-
                /** Return the size of the structure for syscall passing */
-               CoreExport int sa_size(irc::sockets::sockaddrs& sa);
+               inline int sa_size(const irc::sockets::sockaddrs& sa) { return sa.sa_size(); }
 
                /** Convert an address-port pair into a binary sockaddr
                 * @param addr The IP address, IPv4 or IPv6
@@ -107,100 +119,51 @@ namespace irc
                 * @param sa The structure to place the result in. Will be zeroed prior to conversion
                 * @return true if the conversion was successful, false if not.
                 */
-               CoreExport bool aptosa(const char* addr, int port, irc::sockets::sockaddrs* sa);
+               CoreExport bool aptosa(const std::string& addr, int port, irc::sockets::sockaddrs& sa);
+
                /** Convert a binary sockaddr to an address-port pair
                 * @param sa The structure to convert
                 * @param addr the IP address
                 * @param port the port
                 * @return true if the conversion was successful, false if unknown address family
                 */
-               CoreExport bool satoap(const irc::sockets::sockaddrs* sa, std::string& addr, int &port);
+               CoreExport bool satoap(const irc::sockets::sockaddrs& sa, std::string& addr, int &port);
+
                /** Convert a binary sockaddr to a user-readable string.
                 * This means IPv6 addresses are written as [::1]:6667, and *:6668 is used for 0.0.0.0:6668
                 * @param sa The structure to convert
                 * @return The string; "<unknown>" if not a valid address
                 */
-               CoreExport std::string satouser(const irc::sockets::sockaddrs* sa);
+               inline std::string satouser(const irc::sockets::sockaddrs& sa) { return sa.str(); }
        }
 }
 
-
-
+#include "socketengine.h"
 /** This class handles incoming connections on client ports.
  * It will create a new User for every valid connection
  * and assign it a file descriptor.
  */
-class CoreExport ListenSocketBase : public EventHandler
+class CoreExport ListenSocket : public EventHandler
 {
- protected:
-       /** The creator/owner of this object
-        */
-       InspIRCd* ServerInstance;
-       /** Socket description (shown in stats p) */
-       std::string desc;
-
-       /** Raw address socket is bound to */
+ public:
+       const reference<ConfigTag> bind_tag;
        std::string bind_addr;
-       /** Port socket is bound to */
        int bind_port;
-       /** Human-readable address/port socket is bound to */
+       /** Human-readable bind description */
        std::string bind_desc;
-
-       /** The client address if the most recently connected client.
-        * Should only be used when accepting a new client.
-        */
-       static irc::sockets::sockaddrs client;
-       /** The server address used by the most recently connected client.
-        * This may differ from the bind address by having a nonzero address,
-        * if the port is wildcard bound, or being IPv4 on a 6to4 IPv6 port.
-        * The address family will always match that of "client"
-        */
-       static irc::sockets::sockaddrs server;
-
- public:
        /** Create a new listening socket
         */
-       ListenSocketBase(InspIRCd* Instance, int port, const std::string &addr);
+       ListenSocket(ConfigTag* tag, const irc::sockets::sockaddrs& bind_to);
        /** Handle an I/O event
         */
        void HandleEvent(EventType et, int errornum = 0);
        /** Close the socket
         */
-       ~ListenSocketBase();
-       /** Set descriptive text
-        */
-       void SetDescription(const std::string &description)
-       {
-               desc = description;
-       }
-       /** Get description for socket
-        */
-       const std::string& GetDescription() { return desc; }
-       /** Get port number for socket
-        */
-       const int GetPort() { return bind_port; }
-
-       /** Get IP address socket is bound to
-        */
-       const std::string &GetIP() { return bind_addr; }
-
-       const std::string &GetBindDesc() { return bind_desc; }
+       ~ListenSocket();
 
        /** Handles sockets internals crap of a connection, convenience wrapper really
         */
        void AcceptInternal();
-
-       /** Called when a new connection has successfully been accepted on this listener.
-        * @param fd The file descriptor of the new connection
-        */
-       virtual void OnAcceptReady(int fd) = 0;
-};
-
-class CoreExport ClientListenSocket : public ListenSocketBase
-{
-       virtual void OnAcceptReady(int fd);
- public:
-       ClientListenSocket(InspIRCd* Instance, int port, const std::string &addr) : ListenSocketBase(Instance, port, addr) { }
 };
 
 #endif