[libfaim.git] / 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 

/*
 * Maximum number of connections the library can simultaneously
 * handle.  Five is fairly arbitrary.  Only one client that I 
 * know of uses more than one concurrently anyway (which means
 * its only lightly tested too).  
 *
 * Default: 5
 *
 */
#define AIM_CONN_MAX 5 

/*
 *  define TIS_TELNET_PROXY if you have a TIS firewall (Gauntlet) and
 * you want to use FAIM through the firewall
 *
 * XXX: The TIS firewall code hasn't existed, let alone worked,
 *      in many, many months.  I'd be happy to take fixes.
 *
 * Default: undefined
 */
#undef TIS_TELNET_PROXY "proxy.mydomain.com"

/*
 * 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: undefined.  Hasn't been tested in quite a long
 * time.  Most likely doesn't even compile.  
 *
 */
#undef 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.
 *
 */
#define FAIM_LOGIN_SERVER "login.oscar.aol.com"
#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

#endif /* __FAIMCONFIG_H__ */
Commit	Line	Data
9de3ca7e	1	/*
adca9dcf	2	* faimconfig.h
	3	*
	4	* Contains various compile-time options that apply _only to libfaim.
	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	*
9de3ca7e	9	*/
9de3ca7e	10
adca9dcf	11	#ifndef __FAIMCONFIG_H__
adca9dcf	12	#define __FAIMCONFIG_H__
9de3ca7e	13
adca9dcf	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
9de3ca7e	20	*/
	21	#define debug 0
	22
	23	/*
adca9dcf	24	* Maximum number of connections the library can simultaneously
	25	* handle. Five is fairly arbitrary. Only one client that I
	26	* know of uses more than one concurrently anyway (which means
	27	* its only lightly tested too).
	28	*
	29	* Default: 5
	30	*
9de3ca7e	31	*/
adca9dcf	32	#define AIM_CONN_MAX 5
9de3ca7e	33
adca9dcf	34	/*
	35	* define TIS_TELNET_PROXY if you have a TIS firewall (Gauntlet) and
	36	* you want to use FAIM through the firewall
	37	*
	38	* XXX: The TIS firewall code hasn't existed, let alone worked,
	39	* in many, many months. I'd be happy to take fixes.
	40	*
	41	* Default: undefined
	42	*/
	43	#undef TIS_TELNET_PROXY "proxy.mydomain.com"
9de3ca7e	44
adca9dcf	45	/*
	46	* USE_SNAC_FOR_IMS is an old feature that allowed better
	47	* tracking of error messages by caching SNAC IDs of outgoing
	48	* ICBMs and comparing them to incoming errors. However,
	49	* its a helluvalot of overhead for something that should
	50	* rarely happen.
	51	*
	52	* Default: undefined. Hasn't been tested in quite a long
	53	* time. Most likely doesn't even compile.
	54	*
	55	*/
	56	#undef USE_SNAC_FOR_IMS
9de3ca7e	57
adca9dcf	58	/*
	59	* Default Authorizer server name and TCP port for the OSCAR farm.
	60	*
	61	* You shouldn't need to change this unless you're writing
	62	* your own server.
	63	*
	64	* Note that only one server is needed to start the whole
	65	* AIM process. The later server addresses come from
	66	* the authorizer service.
	67	*
	68	*/
9de3ca7e	69	#define FAIM_LOGIN_SERVER "login.oscar.aol.com"
9de3ca7e	70	#define FAIM_LOGIN_PORT 5190
9de3ca7e	71
adca9dcf	72	/*
	73	* MAX_READ_ERROR can be decreased if you find dead connections
	74	* lingering around, and not getting detected, for too long.
	75	*
	76	* Default: 100
	77	*
	78	*/
	79	#define MAX_READ_ERROR 100
9de3ca7e	80
9de3ca7e	81	#endif /* __FAIMCONFIG_H__ */