]> 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 591804b1910aafa565ade56f2a09e9b2ba47ad97..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.2 2003/11/05 23:24:48 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"
 
 #include "exp.h"
 #include "conn-func.h"
 
 
-GLOBAL VOID
+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 */
@@ -51,32 +61,36 @@ 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 */
 
 
-GLOBAL VOID
+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 */
 
 
-GLOBAL VOID
+GLOBAL void
 Conn_ResetPenalty( CONN_ID Idx )
 {
        assert( Idx > NONE );
@@ -84,29 +98,25 @@ Conn_ResetPenalty( CONN_ID Idx )
 } /* Conn_ResetPenalty */
 
 
-GLOBAL VOID
-Conn_ClearFlags( VOID )
+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;
 } /* Conn_ClearFlags */
 
 
-GLOBAL INT
+GLOBAL int
 Conn_Flag( CONN_ID Idx )
 {
-       /* Ist eine Connection markiert (TRUE) oder nicht? */
-
        assert( Idx > NONE );
        return My_Connections[Idx].flag;
 } /* Conn_Flag */
 
 
-GLOBAL VOID
-Conn_SetFlag( CONN_ID Idx, INT Flag )
+GLOBAL void
+Conn_SetFlag( CONN_ID Idx, int Flag )
 {
        /* Connection markieren */
 
@@ -116,7 +126,7 @@ Conn_SetFlag( CONN_ID Idx, INT Flag )
 
 
 GLOBAL CONN_ID
-Conn_First( VOID )
+Conn_First( void )
 {
        /* Connection-Struktur der ersten Verbindung liefern;
         * Ist keine Verbindung vorhanden, wird NONE geliefert. */
@@ -149,32 +159,7 @@ Conn_Next( CONN_ID Idx )
 } /* Conn_Next */
 
 
-GLOBAL VOID
-Conn_SetOption( CONN_ID Idx, INT Option )
-{
-       /* Option fuer Verbindung setzen.
-        * Initial sind alle Optionen _nicht_ gesetzt. */
-
-       assert( Idx > NONE );
-       assert( Option != 0 );
-
-       My_Connections[Idx].options |= Option;
-} /* Conn_SetOption */
-
-
-GLOBAL VOID
-Conn_UnsetOption( CONN_ID Idx, INT Option )
-{
-       /* Option fuer Verbindung loeschen */
-
-       assert( Idx > NONE );
-       assert( Option != 0 );
-
-       My_Connections[Idx].options &= ~Option;
-} /* Conn_UnsetOption */
-
-
-GLOBAL INT
+GLOBAL UINT16
 Conn_Options( CONN_ID Idx )
 {
        assert( Idx > NONE );
@@ -182,93 +167,135 @@ 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
+ * by the C function time(NULL).
+ */
 GLOBAL time_t
 Conn_StartTime( CONN_ID Idx )
 {
-       /* Zeitpunkt des Link-Starts liefern (in Sekunden) */
+       CLIENT *c;
 
-       assert( Idx > NONE );
-       return My_Connections[Idx].starttime;
-} /* Conn_Uptime */
+       assert(Idx > NONE);
 
+       /* Search client structure for this link ... */
+       c = Conn_GetClient(Idx);
+       if(c != NULL)
+               return Client_StartTime(c);
 
-GLOBAL INT
+       return 0;
+} /* Conn_StartTime */
+
+/**
+ * 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 USE_ZLIB
-       if( My_Connections[Idx].options & CONN_ZIP ) return My_Connections[Idx].zip.wdatalen;
+#ifdef ZLIB
+       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 */
 
 
-GLOBAL LONG
+/**
+ * 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 */
 
 
-GLOBAL LONG
+/**
+ * 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 USE_ZLIB
-       if( My_Connections[Idx].options & CONN_ZIP ) return My_Connections[Idx].zip.rdatalen;
+#ifdef ZLIB
+       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 */
 
 
-GLOBAL LONG
+/**
+ * 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 */
 
 
-GLOBAL LONG
+/**
+ * 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 )
+GLOBAL void
+Conn_ResetWCounter( void )
 {
        WCounter = 0;
 } /* Conn_ResetWCounter */
 
 
-GLOBAL LONG
-Conn_WCounter( VOID )
+GLOBAL long
+Conn_WCounter( void )
 {
        return WCounter;
 } /* Conn_WCounter */