[libfaim.git] / faim / faimconfig.h

/*
 *  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__

/* 
 * 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

/*
 * 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

/*
 * 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"
#define FAIM_LOGIN_PORT 5190

/*
 * 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

/*
 * What type of synchronisation to use.
 * 
 * We don't actually use threads, but can use the POSIX mutex
 * in order to maintain thread safety.  You can use the fake locking
 * if you really don't like pthreads (which I don't) or if you don't
 * have it.
 *
 *   USEPTHREADS - Use POSIX mutecies
 *   USEFAKELOCKS - Use little stub spinners to help find locking bugs
 *   USENOPLOCKS - No-op out all synchro calls at compile time
 * 
 * Default: use noplocks by default.
 *
 * !!!NOTE: Even with USEPTHREADS turned on, libfaim is not fully thread
 *          safe.  It will still take some effort to add locking calls to
 *          the places that need them.  In fact, this feature in general
 *          is in danger of being officially deprecated and removed from 
 *          the code.
 *
 */
#undef FAIM_USEPTHREADS
#undef FAIM_USEFAKELOCKS
#define FAIM_USENOPLOCKS

/*
 * Size of the SNAC caching hash.
 *
 * Default: 16
 *
 */
#define FAIM_SNAC_HASH_SIZE 16

/*
 * If building on Win32,define WIN32_STATIC if you don't want
 * to compile libfaim as a DLL (and instead link it right into
 * your app).
 */
#define WIN32_STATIC

#endif /* __FAIMCONFIG_H__ */
Commit	Line	Data
bd71fa88	1	/*
	2	* faimconfig.h
	3	*
f1a5efe0	4	* Contains various compile-time options that apply _only_ to libfaim.
bd71fa88	5	* Note that setting any of these options in a frontend header does not imply
	6	* that they'll get set here. Notably, the 'debug' of this file is _not_
	7	* the same as the frontend 'debug'. They can be different values.
	8	*
	9	*/
	10
	11	#ifndef __FAIMCONFIG_H__
	12	#define __FAIMCONFIG_H__
	13
	14	/*
	15	* set debug to be > 0 if you want debugging information spewing
	16	* on the attached tty. set to 0 for daily use. this value
	17	* is _not_ inherited by the frontend, only this backend.
	18	*
	19	* Default: 0
	20	*/
0c20631f	21	#define debug 0
bd71fa88	22
bd71fa88	23	/*
	24	* USE_SNAC_FOR_IMS is an old feature that allowed better
	25	* tracking of error messages by caching SNAC IDs of outgoing
	26	* ICBMs and comparing them to incoming errors. However,
	27	* its a helluvalot of overhead for something that should
	28	* rarely happen.
	29	*
01b59e1e	30	* Default: defined. This is now defined by default
	31	* because it should be stable and its not too bad.
	32	* And Josh wanted it.
bd71fa88	33	*
	34	*/
	35	#define USE_SNAC_FOR_IMS
	36
	37	/*
	38	* Default Authorizer server name and TCP port for the OSCAR farm.
	39	*
	40	* You shouldn't need to change this unless you're writing
	41	* your own server.
	42	*
	43	* Note that only one server is needed to start the whole
	44	* AIM process. The later server addresses come from
	45	* the authorizer service.
	46	*
f1a5efe0	47	* This is only here for convenience. Its still up to
	48	* the client to connect to it.
	49	*
bd71fa88	50	*/
	51	#define FAIM_LOGIN_SERVER "login.oscar.aol.com"
	52	#define FAIM_LOGIN_PORT 5190
	53
f1a5efe0	54	/*
	55	* The integer extraction/copying functions in aim_util.c have
	56	* both a function version and a macro version. The macro
	57	* version is suggested. Since the function version is more
	58	* readable, I leave both around for reference.
	59	*
	60	* Default: defined.
	61	*/
	62	#define AIMUTIL_USEMACROS
	63
e88ba395	64	/*
37ee990e	65	* What type of synchronisation to use.
e88ba395	66	*
37ee990e	67	* We don't actually use threads, but can use the POSIX mutex
81d7797e	68	* in order to maintain thread safety. You can use the fake locking
37ee990e	69	* if you really don't like pthreads (which I don't) or if you don't
	70	* have it.
	71	*
	72	* USEPTHREADS - Use POSIX mutecies
	73	* USEFAKELOCKS - Use little stub spinners to help find locking bugs
	74	* USENOPLOCKS - No-op out all synchro calls at compile time
	75	*
	76	* Default: use noplocks by default.
	77	*
	78	* !!!NOTE: Even with USEPTHREADS turned on, libfaim is not fully thread
	79	* safe. It will still take some effort to add locking calls to
	80	* the places that need them. In fact, this feature in general
	81	* is in danger of being officially deprecated and removed from
	82	* the code.
81d7797e	83	*
e88ba395	84	*/
37ee990e	85	#undef FAIM_USEPTHREADS
	86	#undef FAIM_USEFAKELOCKS
	87	#define FAIM_USENOPLOCKS
e88ba395	88
b13c9e13	89	/*
	90	* Size of the SNAC caching hash.
	91	*
	92	* Default: 16
	93	*
	94	*/
	95	#define FAIM_SNAC_HASH_SIZE 16
	96
5ac21963	97	/*
	98	* If building on Win32,define WIN32_STATIC if you don't want
	99	* to compile libfaim as a DLL (and instead link it right into
	100	* your app).
	101	*/
	102	#define WIN32_STATIC
	103
bd71fa88	104	#endif /* __FAIMCONFIG_H__ */
e88ba395	105
e88ba395	106