]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/conn.c
Updated some more copyright notices, it's 2010 already (part 2)
[ngircd-alex.git] / src / ngircd / conn.c
index cb7c2c6a8e3a0d2bf4beb5be8fba6c5a1ce66990..cd350a8d619700a2ca89034b5a05b132df6cba36 100644 (file)
@@ -113,17 +113,28 @@ static void cb_Read_Resolver_Result PARAMS((int sock, UNUSED short what));
 static void cb_Connect_to_Server PARAMS((int sock, UNUSED short what));
 static void cb_clientserver PARAMS((int sock, short what));
 
+
+/**
+ * IO callback for listening sockets: handle new connections. This callback
+ * gets called when a new non-SSL connection should be accepted.
+ * @param sock Socket descriptor
+ * @param irrelevant (ignored IO specification)
+ */
 static void
 cb_listen(int sock, short irrelevant)
 {
        (void) irrelevant;
-       if (New_Connection( sock ) >= 0)
-               NumConnections++;
-       LogDebug("Total number of connections now %ld.", NumConnections);
+       (void) New_Connection(sock);
 }
 
 
 #ifdef SSL_SUPPORT
+/**
+ * IO callback for listening SSL sockets: handle new connections. This callback
+ * gets called when a new SSL-enabled connection should be accepted.
+ * @param sock Socket descriptor
+ * @param irrelevant (ignored IO specification)
+ */
 static void
 cb_listen_ssl(int sock, short irrelevant)
 {
@@ -133,14 +144,16 @@ cb_listen_ssl(int sock, short irrelevant)
        fd = New_Connection(sock);
        if (fd < 0)
                return;
-
-       NumConnections++;
-       LogDebug("Total number of connections now %ld.", NumConnections);
        io_event_setcb(My_Connections[fd].sock, cb_clientserver_ssl);
 }
 #endif
 
 
+/**
+ * IO callback for new outgoing non-SSL server connections.
+ * @param sock Socket descriptor
+ * @param what IO specification (IO_WANTREAD/IO_WANTWRITE/...)
+ */
 static void
 cb_connserver(int sock, UNUSED short what)
 {
@@ -214,6 +227,10 @@ cb_connserver(int sock, UNUSED short what)
 }
 
 
+/**
+ * Login to a remote server.
+ * @param idx Connection index
+ */
 static void
 server_login(CONN_ID idx)
 {
@@ -230,6 +247,11 @@ server_login(CONN_ID idx)
 
 
 #ifdef SSL_SUPPORT
+/**
+ * IO callback for new outgoing SSL-enabled server connections.
+ * @param sock Socket descriptor
+ * @param what IO specification (IO_WANTREAD/IO_WANTWRITE/...)
+ */
 static void
 cb_connserver_login_ssl(int sock, short unused)
 {
@@ -259,6 +281,11 @@ cb_connserver_login_ssl(int sock, short unused)
 #endif
 
 
+/**
+ * IO callback for established non-SSL client and server connections.
+ * @param sock Socket descriptor
+ * @param what IO specification (IO_WANTREAD/IO_WANTWRITE/...)
+ */
 static void
 cb_clientserver(int sock, short what)
 {
@@ -287,6 +314,11 @@ cb_clientserver(int sock, short what)
 
 
 #ifdef SSL_SUPPORT
+/**
+ * IO callback for established SSL-enabled client and server connections.
+ * @param sock Socket descriptor
+ * @param what IO specification (IO_WANTREAD/IO_WANTWRITE/...)
+ */
 static void
 cb_clientserver_ssl(int sock, short what)
 {
@@ -319,6 +351,9 @@ cb_clientserver_ssl(int sock, short what)
 #endif
 
 
+/**
+ * Initialite connecion module.
+ */
 GLOBAL void
 Conn_Init( void )
 {
@@ -354,6 +389,9 @@ Conn_Init( void )
 } /* Conn_Init */
 
 
+/**
+ * Clean up connection module.
+ */
 GLOBAL void
 Conn_Exit( void )
 {
@@ -406,6 +444,10 @@ ports_initlisteners(array *a, const char *listen_addr, void (*func)(int,short))
 }
 
 
+/**
+ * Initialize all listening sockets.
+ * @return Number of created listening sockets
+ */
 GLOBAL unsigned int
 Conn_InitListeners( void )
 {
@@ -1170,12 +1212,14 @@ Count_Connections(ng_ipaddr_t *a)
 } /* Count_Connections */
 
 
+/**
+ * Initialize new client connection on a listening socket.
+ * @param Sock Listening socket descriptor
+ * @return Accepted socket descriptor or -1 on error
+ */
 static int
 New_Connection(int Sock)
 {
-       /* Neue Client-Verbindung von Listen-Socket annehmen und
-        * CLIENT-Struktur anlegen. */
-
 #ifdef TCPWRAP
        struct request_info req;
 #endif
@@ -1312,6 +1356,9 @@ New_Connection(int Sock)
         * DNS and IDENT resolver subprocess using the "penalty" mechanism.
         * If there are results earlier, the delay is aborted. */
        Conn_SetPenalty(new_sock, 4);
+
+       NumConnections++;
+       LogDebug("Total number of connections now %ld.", NumConnections);
        return new_sock;
 } /* New_Connection */
 
@@ -1830,12 +1877,13 @@ Init_Socket( int Sock )
        }
 
        /* Set type of service (TOS) */
-#if defined(IP_TOS) && defined(IPTOS_LOWDELAY)
+#if defined(IPPROTO_IP) && defined(IPTOS_LOWDELAY)
        value = IPTOS_LOWDELAY;
-       LogDebug("Setting option IP_TOS on socket %d to IPTOS_LOWDELAY (%d).", Sock, value );
-       if( setsockopt( Sock, SOL_IP, IP_TOS, &value, (socklen_t)sizeof( value )) != 0 )
-       {
-               Log( LOG_ERR, "Can't set socket option IP_TOS: %s!", strerror( errno ));
+       LogDebug("Setting IP_TOS on socket %d to IPTOS_LOWDELAY.", Sock);
+       if (setsockopt(Sock, IPPROTO_IP, IP_TOS, &value,
+                      (socklen_t) sizeof(value))) {
+               Log(LOG_ERR, "Can't set socket option IP_TOS: %s!",
+                   strerror(errno));
                /* ignore this error */
        }
 #endif
@@ -1951,10 +1999,14 @@ cb_Read_Resolver_Result( int r_fd, UNUSED short events )
        c = Conn_GetClient( i );
        assert( c != NULL );
 
-       /* Only update client information of unregistered clients */
-       if( Client_Type( c ) == CLIENT_UNKNOWN ) {
-               strlcpy(My_Connections[i].host, readbuf, sizeof( My_Connections[i].host));
-               Client_SetHostname( c, readbuf);
+       /* Only update client information of unregistered clients.
+        * Note: user commands (e. g. WEBIRC) are always read _after_ reading
+        * the resolver results, so we don't have to worry to override settings
+        * from these commands here. */
+       if(Client_Type(c) == CLIENT_UNKNOWN) {
+               strlcpy(My_Connections[i].host, readbuf,
+                       sizeof(My_Connections[i].host));
+               Client_SetHostname(c, readbuf);
 #ifdef IDENTAUTH
                ++identptr;
                if (*identptr) {
@@ -1990,12 +2042,16 @@ Simple_Message( int Sock, const char *Msg )
 } /* Simple_Error */
 
 
+/**
+ * Get CLIENT structure that belongs to a local connection identified by its
+ * index number. Each connection belongs to a client by definition, so it is
+ * not required that the caller checks for NULL return values.
+ * @param Idx Connection index number
+ * @return Pointer to CLIENT structure
+ */
 GLOBAL CLIENT *
 Conn_GetClient( CONN_ID Idx ) 
 {
-       /* return Client-Structure that belongs to the local Connection Idx.
-        * If none is found, return NULL.
-        */
        CONNECTION *c;
 
        assert(Idx >= 0);
@@ -2006,7 +2062,14 @@ Conn_GetClient( CONN_ID Idx )
 
 
 #ifdef SSL_SUPPORT
-/* we cannot access My_Connections in irc-info.c */
+
+/**
+ * Get information about used SSL chiper.
+ * @param Idx Connection index number
+ * @param buf Buffer for returned information text
+ * @param len Size of return buffer "buf"
+ * @return true on success, false otherwise
+ */
 GLOBAL bool
 Conn_GetCipherInfo(CONN_ID Idx, char *buf, size_t len)
 {
@@ -2017,6 +2080,11 @@ Conn_GetCipherInfo(CONN_ID Idx, char *buf, size_t len)
 }
 
 
+/**
+ * Check if a connection is SSL-enabled or not.
+ * @param Idx Connection index number
+ * @return true if connection is SSL-enabled, false otherwise.
+ */
 GLOBAL bool
 Conn_UsesSSL(CONN_ID Idx)
 {