added gnutls backend and moved backend code into new files

[ircu2.10.12-pk.git] / include / userload.h

diff --git a/include/userload.h b/include/userload.h
index 50adf2cfb66e5a3a805ea157dd06993dc2a1a70c..3891ca8d67b2cb83a2a0f76b3beac64e3e36977e 100644 (file)
--- a/include/userload.h
+++ b/include/userload.h
@@ -20,28 +20,36 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
+/** @file
+ * @brief Userload tracking and statistics.
+ * @version $Id$
+ */
+#ifndef INCLUDED_userload_h
+#define INCLUDED_userload_h
 
-#ifndef USERLOAD_H
-#define USERLOAD_H
+struct Client;
+struct StatDesc;
 
-/*=============================================================================
+/*
  * Structures
  */
 
+/** Tracks load of various types of users. */
 struct current_load_st {
-  unsigned int client_count;
-  unsigned int local_count;
-  unsigned int conn_count;
+  unsigned int client_count; /**< Count of locally connected clients. */
+  unsigned int local_count; /**< This field is updated but apparently meaningless. */
+  unsigned int conn_count; /**< Locally connected clients plus servers. */
 };
 
-/*=============================================================================
+/*
  * Proto types
  */
 
 extern void update_load(void);
-extern void calc_load(aClient *sptr);
+extern void calc_load(struct Client *sptr, const struct StatDesc *sd,
+                      char *param);
 extern void initload(void);
 
 extern struct current_load_st current_load;
 
-#endif /* USERLOAD_H */
+#endif /* INCLUDED_userload_h */