[libfaim.git] / include / faimconfig.h

/*
 *  faimconfig.h
 *
 * Contains various compile-time options that apply _only_ to libfaim.
 *
 */

#ifndef __FAIMCONFIG_H__
#define __FAIMCONFIG_H__

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

/*
 * 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	*
	6	*/
	7
	8	#ifndef __FAIMCONFIG_H__
	9	#define __FAIMCONFIG_H__
	10
bd71fa88	11	/*
	12	* USE_SNAC_FOR_IMS is an old feature that allowed better
	13	* tracking of error messages by caching SNAC IDs of outgoing
	14	* ICBMs and comparing them to incoming errors. However,
	15	* its a helluvalot of overhead for something that should
	16	* rarely happen.
	17	*
01b59e1e	18	* Default: defined. This is now defined by default
	19	* because it should be stable and its not too bad.
	20	* And Josh wanted it.
bd71fa88	21	*
	22	*/
	23	#define USE_SNAC_FOR_IMS
	24
	25	/*
	26	* Default Authorizer server name and TCP port for the OSCAR farm.
	27	*
	28	* You shouldn't need to change this unless you're writing
	29	* your own server.
	30	*
	31	* Note that only one server is needed to start the whole
	32	* AIM process. The later server addresses come from
	33	* the authorizer service.
	34	*
f1a5efe0	35	* This is only here for convenience. Its still up to
	36	* the client to connect to it.
	37	*
bd71fa88	38	*/
	39	#define FAIM_LOGIN_SERVER "login.oscar.aol.com"
	40	#define FAIM_LOGIN_PORT 5190
	41
e88ba395	42	/*
37ee990e	43	* What type of synchronisation to use.
e88ba395	44	*
37ee990e	45	* We don't actually use threads, but can use the POSIX mutex
81d7797e	46	* in order to maintain thread safety. You can use the fake locking
37ee990e	47	* if you really don't like pthreads (which I don't) or if you don't
	48	* have it.
	49	*
	50	* USEPTHREADS - Use POSIX mutecies
	51	* USEFAKELOCKS - Use little stub spinners to help find locking bugs
	52	* USENOPLOCKS - No-op out all synchro calls at compile time
	53	*
	54	* Default: use noplocks by default.
	55	*
	56	* !!!NOTE: Even with USEPTHREADS turned on, libfaim is not fully thread
	57	* safe. It will still take some effort to add locking calls to
	58	* the places that need them. In fact, this feature in general
	59	* is in danger of being officially deprecated and removed from
	60	* the code.
81d7797e	61	*
e88ba395	62	*/
37ee990e	63	#undef FAIM_USEPTHREADS
	64	#undef FAIM_USEFAKELOCKS
	65	#define FAIM_USENOPLOCKS
e88ba395	66
b13c9e13	67	/*
	68	* Size of the SNAC caching hash.
	69	*
	70	* Default: 16
	71	*
	72	*/
	73	#define FAIM_SNAC_HASH_SIZE 16
	74
5ac21963	75	/*
b064db1b	76	* If building on Win32, define WIN32_STATIC if you don't want
5ac21963	77	* to compile libfaim as a DLL (and instead link it right into
	78	* your app).
	79	*/
	80	#define WIN32_STATIC
	81
bd71fa88	82	#endif /* __FAIMCONFIG_H__ */
e88ba395	83
e88ba395	84