]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/conn-func.c
Whitespace fixes (no functional changes)
[ngircd-alex.git] / src / ngircd / conn-func.c
index 8b0b6f7161db82c4fd73f0d71faf8ff25c9879c9..b6e82849b0c6ae98f9441cafff8f67d5487d58f7 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2008 Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2014 Alexander Barton (alex@barton.de) and Contributors.
  *
  * 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
  * Connection management: Global functions
  */
 
-#include "imp.h"
 #include <assert.h>
-#include <string.h>
-#include "log.h"
+#include <time.h>
 
+#ifdef DEBUG
+# include "log.h"
+#endif
 #include "conn.h"
-#include "client.h"
 
-#include "exp.h"
 #include "conn-func.h"
 
-
+/**
+ * Update "idle timestamp", the time of the last visible user action
+ * (e. g. like sending messages, joining or leaving channels).
+ *
+ * @param Idx Connection index.
+ */
 GLOBAL void
-Conn_UpdateIdle( CONN_ID Idx )
+Conn_UpdateIdle(CONN_ID Idx)
 {
-       assert( Idx > NONE );
-       My_Connections[Idx].lastprivmsg = time( NULL );
+       assert(Idx > NONE);
+       My_Connections[Idx].lastprivmsg = time(NULL);
 }
 
+/**
+ * Update "ping timestamp", the time of the last outgoing PING request.
+ *
+ * @param Idx Connection index.
+ */
+GLOBAL void
+Conn_UpdatePing(CONN_ID Idx)
+{
+       assert(Idx > NONE);
+       My_Connections[Idx].lastping = time(NULL);
+}
 
 /*
  * Get signon time of a connection.
@@ -56,7 +71,6 @@ Conn_GetIdle( CONN_ID Idx )
        return time( NULL ) - My_Connections[Idx].lastprivmsg;
 } /* Conn_GetIdle */
 
-
 GLOBAL time_t
 Conn_LastPing( CONN_ID Idx )
 {
@@ -64,39 +78,40 @@ Conn_LastPing( CONN_ID Idx )
        return My_Connections[Idx].lastping;
 } /* Conn_LastPing */
 
-
+/**
+ * Add "penalty time" for a connection.
+ *
+ * During the "penalty time" 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.
+ *
+ * @param Idex Connection index.
+ * @param Seconds Seconds to add.
+ * @see Conn_ResetPenalty
+ */
 GLOBAL void
-Conn_SetPenalty( CONN_ID Idx, time_t Seconds )
+Conn_SetPenalty(CONN_ID Idx, time_t Seconds)
 {
-       /* 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)
+       assert(Idx > NONE);
+       assert(Seconds >= 0);
+
+       t = time(NULL);
+       if (My_Connections[Idx].delaytime < t)
                My_Connections[Idx].delaytime = t;
 
+       My_Connections[Idx].delaytime += Seconds;
+
 #ifdef DEBUG
-       Log(LOG_DEBUG, "Add penalty time on connection %d: %ld second(s).",
-                       Idx, (long)Seconds);
+       Log(LOG_DEBUG,
+           "Add penalty time on connection %d: %ld second%s, total %ld second%s.",
+           Idx, (long)Seconds, Seconds != 1 ? "s" : "",
+           My_Connections[Idx].delaytime - t,
+           My_Connections[Idx].delaytime - t != 1 ? "s" : "");
 #endif
 } /* Conn_SetPenalty */
 
-
-GLOBAL void
-Conn_ResetPenalty( CONN_ID Idx )
-{
-       assert( Idx > NONE );
-       My_Connections[Idx].delaytime = 0;
-} /* Conn_ResetPenalty */
-
-
 GLOBAL void
 Conn_ClearFlags( void )
 {
@@ -105,7 +120,6 @@ Conn_ClearFlags( void )
        for( i = 0; i < Pool_Size; i++ ) My_Connections[i].flag = 0;
 } /* Conn_ClearFlags */
 
-
 GLOBAL int
 Conn_Flag( CONN_ID Idx )
 {
@@ -113,25 +127,18 @@ Conn_Flag( CONN_ID Idx )
        return My_Connections[Idx].flag;
 } /* Conn_Flag */
 
-
 GLOBAL void
 Conn_SetFlag( CONN_ID Idx, int Flag )
 {
-       /* Connection markieren */
-
        assert( Idx > NONE );
        My_Connections[Idx].flag = Flag;
 } /* Conn_SetFlag */
 
-
 GLOBAL CONN_ID
 Conn_First( void )
 {
-       /* Connection-Struktur der ersten Verbindung liefern;
-        * Ist keine Verbindung vorhanden, wird NONE geliefert. */
-
        CONN_ID i;
-       
+
        for( i = 0; i < Pool_Size; i++ )
        {
                if( My_Connections[i].sock != NONE ) return i;
@@ -139,17 +146,13 @@ Conn_First( void )
        return NONE;
 } /* Conn_First */
 
-
 GLOBAL CONN_ID
 Conn_Next( CONN_ID Idx )
 {
-       /* Naechste Verbindungs-Struktur liefern; existiert keine
-        * weitere, so wird NONE geliefert. */
-
        CONN_ID i = NONE;
 
        assert( Idx > NONE );
-       
+
        for( i = Idx + 1; i < Pool_Size; i++ )
        {
                if( My_Connections[i].sock != NONE ) return i;
@@ -157,7 +160,6 @@ Conn_Next( CONN_ID Idx )
        return NONE;
 } /* Conn_Next */
 
-
 GLOBAL UINT16
 Conn_Options( CONN_ID Idx )
 {
@@ -165,7 +167,6 @@ Conn_Options( CONN_ID Idx )
        return My_Connections[Idx].options;
 } /* Conn_Options */
 
-
 /**
  * Set connection option.
  */
@@ -176,7 +177,6 @@ Conn_SetOption(CONN_ID Idx, int Option)
        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
@@ -212,7 +212,6 @@ Conn_SendQ( CONN_ID Idx )
        return array_bytes(&My_Connections[Idx].wbuf);
 } /* Conn_SendQ */
 
-
 /**
  * return number of messages sent on this connection so far
  */
@@ -224,7 +223,6 @@ Conn_SendMsg( CONN_ID Idx )
        return My_Connections[Idx].msg_out;
 } /* Conn_SendMsg */
 
-
 /**
  * return number of (uncompressed) bytes sent
  * on this connection so far
@@ -236,7 +234,6 @@ Conn_SendBytes( CONN_ID Idx )
        return My_Connections[Idx].bytes_out;
 } /* Conn_SendBytes */
 
-
 /**
  * return number of bytes pending in read buffer
  */
@@ -252,7 +249,6 @@ Conn_RecvQ( CONN_ID Idx )
        return array_bytes(&My_Connections[Idx].rbuf);
 } /* Conn_RecvQ */
 
-
 /**
  * return number of messages received on this connection so far
  */
@@ -263,7 +259,6 @@ Conn_RecvMsg( CONN_ID Idx )
        return My_Connections[Idx].msg_in;
 } /* Conn_RecvMsg */
 
-
 /**
  * return number of (uncompressed) bytes received on this
  * connection so far
@@ -285,19 +280,16 @@ Conn_IPA(CONN_ID Idx)
        return ng_ipaddr_tostr(&My_Connections[Idx].addr);
 }
 
-
 GLOBAL void
 Conn_ResetWCounter( void )
 {
        WCounter = 0;
 } /* Conn_ResetWCounter */
 
-
 GLOBAL long
 Conn_WCounter( void )
 {
        return WCounter;
 } /* Conn_WCounter */
 
-
 /* -eof- */