]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/conn-func.c
Add Doxygen @file documentation to each source and header file
[ngircd-alex.git] / src / ngircd / conn-func.c
index 84fe1e4ca929abcc269572a97df9a8c299c76c1d..a50f0daadded8806ad0a6be459da4762fde6bf0e 100644 (file)
@@ -1,14 +1,12 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2008 Alexander Barton (alex@barton.de)
  *
  * This program 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; either version 2 of the License, or
  * (at your option) any later version.
  * Please read the file COPYING, README and AUTHORS for more information.
- *
- * Connection management: Global functions
  */
 
 
 
 #include "portab.h"
 
-static char UNUSED id[] = "$Id: conn-func.c,v 1.6 2005/06/12 16:32:17 alex Exp $";
+/**
+ * @file
+ * Connection management: Global functions
+ */
 
 #include "imp.h"
 #include <assert.h>
-#include <log.h>
+#include <string.h>
+#include "log.h"
 
 #include "conn.h"
 #include "client.h"
@@ -32,18 +34,25 @@ static char UNUSED id[] = "$Id: conn-func.c,v 1.6 2005/06/12 16:32:17 alex Exp $
 GLOBAL void
 Conn_UpdateIdle( CONN_ID Idx )
 {
-       /* Idle-Timer zuruecksetzen */
-
        assert( Idx > NONE );
        My_Connections[Idx].lastprivmsg = time( NULL );
 }
 
 
+/*
+ * Get signon time of a connection.
+ */
+GLOBAL time_t
+Conn_GetSignon(CONN_ID Idx)
+{
+       assert(Idx > NONE);
+       return My_Connections[Idx].signon;
+}
+
 GLOBAL time_t
 Conn_GetIdle( CONN_ID Idx )
 {
-       /* Idle-Time einer Verbindung liefern (in Sekunden) */
-
+       /* Return Idle-Timer of a connetion */
        assert( Idx > NONE );
        return time( NULL ) - My_Connections[Idx].lastprivmsg;
 } /* Conn_GetIdle */
@@ -52,8 +61,6 @@ Conn_GetIdle( CONN_ID Idx )
 GLOBAL time_t
 Conn_LastPing( CONN_ID Idx )
 {
-       /* Zeitpunkt des letzten PING liefern */
-
        assert( Idx > NONE );
        return My_Connections[Idx].lastping;
 } /* Conn_LastPing */
@@ -62,18 +69,24 @@ Conn_LastPing( CONN_ID Idx )
 GLOBAL void
 Conn_SetPenalty( CONN_ID Idx, time_t Seconds )
 {
-       /* Penalty-Delay fuer eine Verbindung (in Sekunden) setzen;
-        * waehrend dieser Zeit wird der entsprechende Socket vom Server
-        * bei Lese-Operationen komplett ignoriert. Der Delay kann mit
-        * dieser Funktion nur erhoeht, nicht aber verringert werden. */
-       
+       /* set Penalty-Delay for a socket.
+        * during the penalty, the socket is ignored completely, no new
+        * data is read. This function only increases the penalty, it is
+        * not possible to decrease the penalty time.
+        */
        time_t t;
        
        assert( Idx > NONE );
        assert( Seconds >= 0 );
 
        t = time( NULL ) + Seconds;
-       if( t > My_Connections[Idx].delaytime ) My_Connections[Idx].delaytime = t;
+       if (t > My_Connections[Idx].delaytime)
+               My_Connections[Idx].delaytime = t;
+
+#ifdef DEBUG
+       Log(LOG_DEBUG, "Add penalty time on connection %d: %ld second(s).",
+                       Idx, (long)Seconds);
+#endif
 } /* Conn_SetPenalty */
 
 
@@ -88,8 +101,6 @@ Conn_ResetPenalty( CONN_ID Idx )
 GLOBAL void
 Conn_ClearFlags( void )
 {
-       /* Alle Connection auf "nicht-markiert" setzen */
-
        CONN_ID i;
 
        for( i = 0; i < Pool_Size; i++ ) My_Connections[i].flag = 0;
@@ -99,8 +110,6 @@ Conn_ClearFlags( void )
 GLOBAL int
 Conn_Flag( CONN_ID Idx )
 {
-       /* Ist eine Connection markiert (true) oder nicht? */
-
        assert( Idx > NONE );
        return My_Connections[Idx].flag;
 } /* Conn_Flag */
@@ -150,7 +159,7 @@ Conn_Next( CONN_ID Idx )
 } /* Conn_Next */
 
 
-GLOBAL int
+GLOBAL UINT16
 Conn_Options( CONN_ID Idx )
 {
        assert( Idx > NONE );
@@ -158,6 +167,17 @@ Conn_Options( CONN_ID Idx )
 } /* Conn_Options */
 
 
+/**
+ * Set connection option.
+ */
+GLOBAL void
+Conn_SetOption(CONN_ID Idx, int Option)
+{
+       assert(Idx > NONE);
+       Conn_OPTION_ADD(&My_Connections[Idx], Option);
+} /* Conn_SetOption */
+
+
 /**
  * Get the start time of the connection.
  * The result is the start time in seconds since 1970-01-01, as reported
@@ -171,81 +191,101 @@ Conn_StartTime( CONN_ID Idx )
        assert(Idx > NONE);
 
        /* Search client structure for this link ... */
-       c = Client_GetFromConn(Idx);
+       c = Conn_GetClient(Idx);
        if(c != NULL)
                return Client_StartTime(c);
 
        return 0;
 } /* Conn_StartTime */
 
-
-GLOBAL int
+/**
+ * return number of bytes queued for writing
+ */
+GLOBAL size_t
 Conn_SendQ( CONN_ID Idx )
 {
-       /* Laenge der Daten im Schreibbuffer liefern */
-
        assert( Idx > NONE );
 #ifdef ZLIB
-       if( My_Connections[Idx].options & CONN_ZIP ) return My_Connections[Idx].zip.wdatalen;
+       if( My_Connections[Idx].options & CONN_ZIP )
+               return array_bytes(&My_Connections[Idx].zip.wbuf);
        else
 #endif
-       return My_Connections[Idx].wdatalen;
+       return array_bytes(&My_Connections[Idx].wbuf);
 } /* Conn_SendQ */
 
 
+/**
+ * return number of messages sent on this connection so far
+ */
 GLOBAL long
 Conn_SendMsg( CONN_ID Idx )
 {
-       /* Anzahl gesendeter Nachrichten liefern */
 
        assert( Idx > NONE );
        return My_Connections[Idx].msg_out;
 } /* Conn_SendMsg */
 
 
+/**
+ * return number of (uncompressed) bytes sent
+ * on this connection so far
+ */
 GLOBAL long
 Conn_SendBytes( CONN_ID Idx )
 {
-       /* Anzahl gesendeter Bytes (unkomprimiert) liefern */
-
        assert( Idx > NONE );
        return My_Connections[Idx].bytes_out;
 } /* Conn_SendBytes */
 
 
-GLOBAL int
+/**
+ * return number of bytes pending in read buffer
+ */
+GLOBAL size_t
 Conn_RecvQ( CONN_ID Idx )
 {
-       /* Laenge der Daten im Lesebuffer liefern */
-
        assert( Idx > NONE );
 #ifdef ZLIB
-       if( My_Connections[Idx].options & CONN_ZIP ) return My_Connections[Idx].zip.rdatalen;
+       if( My_Connections[Idx].options & CONN_ZIP )
+               return array_bytes(&My_Connections[Idx].zip.rbuf);
        else
 #endif
-       return My_Connections[Idx].rdatalen;
+       return array_bytes(&My_Connections[Idx].rbuf);
 } /* Conn_RecvQ */
 
 
+/**
+ * return number of messages received on this connection so far
+ */
 GLOBAL long
 Conn_RecvMsg( CONN_ID Idx )
 {
-       /* Anzahl empfangener Nachrichten liefern */
-
        assert( Idx > NONE );
        return My_Connections[Idx].msg_in;
 } /* Conn_RecvMsg */
 
 
+/**
+ * return number of (uncompressed) bytes received on this
+ * connection so far
+ */
 GLOBAL long
 Conn_RecvBytes( CONN_ID Idx )
 {
-       /* Anzahl empfangener Bytes (unkomprimiert) liefern */
-
        assert( Idx > NONE );
        return My_Connections[Idx].bytes_in;
 } /* Conn_RecvBytes */
 
+/**
+ * Return the remote IP address of this connection as string.
+ */
+GLOBAL const char *
+Conn_IPA(CONN_ID Idx)
+{
+       assert (Idx > NONE);
+       return ng_ipaddr_tostr(&My_Connections[Idx].addr);
+}
+
 
 GLOBAL void
 Conn_ResetWCounter( void )