[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

/*
 * Maximum number of connections the library can simultaneously
 * handle per session structure.  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: 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

/*
 * 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.
 *
 */
#undef SNACLOGIN

/*
 * 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
bd71fa88	1	/*
	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	*
	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
	23	/*
	24	* Maximum number of connections the library can simultaneously
01b59e1e	25	* handle per session structure. Five is fairly arbitrary.
	26	* Only one client that I know of uses more than one concurrently
	27	* anyway (which means its only lightly tested too).
bd71fa88	28	*
	29	* Default: 5
	30	*
	31	*/
	32	#define AIM_CONN_MAX 5
	33
	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"
	44
	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	*
01b59e1e	52	* Default: defined. This is now defined by default
	53	* because it should be stable and its not too bad.
	54	* And Josh wanted it.
bd71fa88	55	*
	56	*/
	57	#define USE_SNAC_FOR_IMS
	58
01b59e1e	59	/*
	60	* As of AIM 3.5 or so, AOL as added a better way of
	61	* logging in. Define this to use it instead of the
	62	* old Version 1.0 way.
	63	*
	64	* The largest caveat here is that I have no idea
	65	* how to encode passwords using the new 3.5 way.
	66	* Until someone figures that out the...
	67	*
	68	* Default: Undefined.
	69	*
	70	*/
	71	#undef SNACLOGIN
	72
bd71fa88	73	/*
	74	* Default Authorizer server name and TCP port for the OSCAR farm.
	75	*
	76	* You shouldn't need to change this unless you're writing
	77	* your own server.
	78	*
	79	* Note that only one server is needed to start the whole
	80	* AIM process. The later server addresses come from
	81	* the authorizer service.
	82	*
	83	*/
	84	#define FAIM_LOGIN_SERVER "login.oscar.aol.com"
	85	#define FAIM_LOGIN_PORT 5190
	86
	87	/*
	88	* MAX_READ_ERROR can be decreased if you find dead connections
	89	* lingering around, and not getting detected, for too long.
	90	*
	91	* Default: 100
	92	*
	93	*/
	94	#define MAX_READ_ERROR 100
	95
	96	#endif /* __FAIMCONFIG_H__ */