diff libfaim/faimconfig.h @ 237:6ced2f1c8b24

[gaim-migrate @ 247] How cool is this, libfaim is making a comeback. I completely redid everything, as was necessary because of the updates to libfaim since gaim 0.9.7. You can sign on and send/recv IMs, but there's a bad lag between display updates that I haven't figured out how to fix yet. committer: Tailor Script <[e-mail]>

--- a/libfaim/faimconfig.h	Thu May 18 18:20:18 2000 +0000
+++ b/libfaim/faimconfig.h	Sat May 20 00:30:53 2000 +0000
@@ -1,42 +1,106 @@
+/*
+ *  faimconfig.h
+ *
+ * Contains various compile-time options that apply _only_ to libfaim.
+ * Note that setting any of these options in a frontend header does not imply
+ * that they'll get set here.  Notably, the 'debug' of this file is _not_ 
+ * the same as the frontend 'debug'.  They can be different values.
+ *
+ */
+
 #ifndef __FAIMCONFIG_H__
 #define __FAIMCONFIG_H__
 
-/*
-  faimconfig.h
+/* 
+ * set debug to be > 0 if you want debugging information spewing
+ * on the attached tty.  set to 0 for daily use.  this value
+ * is _not_ inherited by the frontend, only this backend.
+ *
+ * Default: 0  
+*/
+#define debug 0
 
-  Contains various compile-time options that apply _only to the faim backend_.
-  Note that setting any of these options in a frontend header does not imply
-  that they'll get set here.  Notably, the 'debug' of this file is _not_ 
-  the same as the frontend 'debug'.  They can be different values.
-
+/*
+ * Maximum number of connections the library can simultaneously
+ * handle per session structure.  Five is fairly arbitrary.  
+ * 
+ * Normally, only one connection gets used at a time.  However, if
+ * chat is used, its easily possible for several connections to be
+ * open simultaneously.
+ *
+ * Normal connection list looks like this:
+ *   1 -- used for authentication at login (closed after login)
+ *   1 -- used for BOS (general messaging) (stays open for entire session)
+ *   1 -- used for chatnav (room creation, etc) (opened at random)
+ *  1n -- used for n connected chat rooms (AOL limits to three)
+ *
+ * Default: 7
+ *
  */
+#define AIM_CONN_MAX 7
 
-/* 
-   set debug to be > 0 if you want debugging information spewing
-   on the attached tty.  set to 0 for daily use.  this value
-   is _not_ inherited by the frontend, only this backend.
-
-   Default: 0  
-*/
-#define debug 10
+/*
+ * USE_SNAC_FOR_IMS is an old feature that allowed better
+ * tracking of error messages by caching SNAC IDs of outgoing
+ * ICBMs and comparing them to incoming errors.  However,
+ * its a helluvalot of overhead for something that should
+ * rarely happen.  
+ *
+ * Default: defined.  This is now defined by default
+ * because it should be stable and its not too bad.  
+ * And Josh wanted it.
+ *
+ */
+#define USE_SNAC_FOR_IMS
 
 /*
-  define TIS_TELNET_PROXY if you have a TIS firewall (Gauntlet) and
-  you want to use FAIM through the firewall
-
-  Default: undefined
+ * As of AIM 3.5 or so, AOL as added a better way of
+ * logging in.  Define this to use it instead of the 
+ * old Version 1.0 way.  
+ *
+ * The largest caveat here is that I have no idea
+ * how to encode passwords using the new 3.5 way.
+ * Until someone figures that out the...
+ *
+ * Default: Undefined.
+ *
  */
-/* #define TIS_TELNET_PROXY "proxy.mydomain.com" */
-
+#undef SNACLOGIN
 
-/* #define USE_SNAC_FOR_IMS */
-
-/* ---- these shouldn't need any changes ---- */
-
-/* authentication server of OSCAR */
+/*
+ * Default Authorizer server name and TCP port for the OSCAR farm.  
+ *
+ * You shouldn't need to change this unless you're writing
+ * your own server. 
+ *
+ * Note that only one server is needed to start the whole
+ * AIM process.  The later server addresses come from
+ * the authorizer service.
+ *
+ * This is only here for convenience.  Its still up to
+ * the client to connect to it.
+ *
+ */
 #define FAIM_LOGIN_SERVER "login.oscar.aol.com"
-/* port on OSCAR authenticator to connect to */
 #define FAIM_LOGIN_PORT 5190
 
+/*
+ * MAX_READ_ERROR can be decreased if you find dead connections
+ * lingering around, and not getting detected, for too long.
+ *
+ * Default: 100
+ *
+ */
+#define MAX_READ_ERROR 100
+
+/*
+ * The integer extraction/copying functions in aim_util.c have
+ * both a function version and a macro version.  The macro 
+ * version is suggested.  Since the function version is more
+ * readable, I leave both around for reference.
+ *
+ * Default: defined.
+ */
+#define AIMUTIL_USEMACROS
 
 #endif /* __FAIMCONFIG_H__ */