2 * aim_internal.h -- prototypes/structs for the guts of libfaim
7 #ifndef __AIM_INTERNAL_H__
8 #define __AIM_INTERNAL_H__ 1
17 #define AIM_MODULENAME_MAXLEN 16
18 #define AIM_MODFLAG_MULTIFAMILY 0x0001
19 typedef struct aim_module_s {
20 unsigned short family;
22 unsigned short version;
23 char name[AIM_MODULENAME_MAXLEN+1];
24 int (*snachandler)(aim_session_t *sess, struct aim_module_s *mod, aim_frame_t *rx, aim_modsnac_t *snac, aim_bstream_t *bs);
25 void (*shutdown)(aim_session_t *sess, struct aim_module_s *mod);
27 struct aim_module_s *next;
30 faim_internal int aim__registermodule(aim_session_t *sess, int (*modfirst)(aim_session_t *, aim_module_t *));
31 faim_internal void aim__shutdownmodules(aim_session_t *sess);
34 faim_internal int buddylist_modfirst(aim_session_t *sess, aim_module_t *mod);
35 faim_internal int admin_modfirst(aim_session_t *sess, aim_module_t *mod);
36 faim_internal int bos_modfirst(aim_session_t *sess, aim_module_t *mod);
37 faim_internal int search_modfirst(aim_session_t *sess, aim_module_t *mod);
38 faim_internal int stats_modfirst(aim_session_t *sess, aim_module_t *mod);
39 faim_internal int auth_modfirst(aim_session_t *sess, aim_module_t *mod);
40 faim_internal int msg_modfirst(aim_session_t *sess, aim_module_t *mod);
41 faim_internal int misc_modfirst(aim_session_t *sess, aim_module_t *mod);
42 faim_internal int chatnav_modfirst(aim_session_t *sess, aim_module_t *mod);
43 faim_internal int chat_modfirst(aim_session_t *sess, aim_module_t *mod);
44 faim_internal int locate_modfirst(aim_session_t *sess, aim_module_t *mod);
45 faim_internal int general_modfirst(aim_session_t *sess, aim_module_t *mod);
47 faim_internal int aim_genericreq_n(aim_session_t *, aim_conn_t *conn, fu16_t family, fu16_t subtype);
48 faim_internal int aim_genericreq_n_snacid(aim_session_t *, aim_conn_t *conn, fu16_t family, fu16_t subtype);
49 faim_internal int aim_genericreq_l(aim_session_t *, aim_conn_t *conn, fu16_t family, fu16_t subtype, fu32_t *);
50 faim_internal int aim_genericreq_s(aim_session_t *, aim_conn_t *conn, fu16_t family, fu16_t subtype, fu16_t *);
52 #define AIMBS_CURPOSPAIR(x) ((x)->data + (x)->offset), ((x)->len - (x)->offset)
54 faim_internal void aim_rxqueue_cleanbyconn(aim_session_t *sess, aim_conn_t *conn);
55 faim_internal int aim_recv(int fd, void *buf, size_t count);
56 faim_internal int aim_bstream_recv(aim_bstream_t *bs, int fd, size_t count);
57 faim_internal int aim_bstream_init(aim_bstream_t *bs, fu8_t *data, int len);
58 faim_internal int aim_bstream_empty(aim_bstream_t *bs);
59 faim_internal int aim_bstream_curpos(aim_bstream_t *bs);
60 faim_internal int aim_bstream_setpos(aim_bstream_t *bs, int off);
61 faim_internal void aim_bstream_rewind(aim_bstream_t *bs);
62 faim_internal int aim_bstream_advance(aim_bstream_t *bs, int n);
63 faim_internal fu8_t aimbs_get8(aim_bstream_t *bs);
64 faim_internal fu16_t aimbs_get16(aim_bstream_t *bs);
65 faim_internal fu32_t aimbs_get32(aim_bstream_t *bs);
66 faim_internal int aimbs_put8(aim_bstream_t *bs, fu8_t v);
67 faim_internal int aimbs_put16(aim_bstream_t *bs, fu16_t v);
68 faim_internal int aimbs_put32(aim_bstream_t *bs, fu32_t v);
69 faim_internal int aimbs_getrawbuf(aim_bstream_t *bs, fu8_t *buf, int len);
70 faim_internal fu8_t *aimbs_getraw(aim_bstream_t *bs, int len);
71 faim_internal char *aimbs_getstr(aim_bstream_t *bs, int len);
72 faim_internal int aimbs_putraw(aim_bstream_t *bs, const fu8_t *v, int len);
73 faim_internal int aimbs_putbs(aim_bstream_t *bs, aim_bstream_t *srcbs, int len);
75 faim_internal int aim_get_command_rendezvous(aim_session_t *sess, aim_conn_t *conn);
77 faim_internal int aim_tx_sendframe(aim_session_t *sess, aim_frame_t *cur);
78 faim_internal flap_seqnum_t aim_get_next_txseqnum(aim_conn_t *);
79 faim_internal aim_frame_t *aim_tx_new(aim_session_t *sess, aim_conn_t *conn, fu8_t framing, fu8_t chan, int datalen);
80 faim_internal void aim_frame_destroy(aim_frame_t *);
81 faim_internal int aim_tx_enqueue(aim_session_t *, aim_frame_t *);
82 faim_internal int aim_tx_printqueue(aim_session_t *);
83 faim_internal void aim_tx_cleanqueue(aim_session_t *, aim_conn_t *);
85 faim_internal aim_rxcallback_t aim_callhandler(aim_session_t *sess, aim_conn_t *conn, u_short family, u_short type);
86 faim_internal int aim_callhandler_noparam(aim_session_t *sess, aim_conn_t *conn, fu16_t family, fu16_t type, aim_frame_t *ptr);
89 * Generic SNAC structure. Rarely if ever used.
91 typedef struct aim_snac_s {
98 struct aim_snac_s *next;
101 faim_internal void aim_initsnachash(aim_session_t *sess);
102 faim_internal aim_snacid_t aim_newsnac(aim_session_t *, aim_snac_t *newsnac);
103 faim_internal aim_snacid_t aim_cachesnac(aim_session_t *sess, const fu16_t family, const fu16_t type, const fu16_t flags, const void *data, const int datalen);
104 faim_internal aim_snac_t *aim_remsnac(aim_session_t *, aim_snacid_t id);
105 faim_internal void aim_cleansnacs(aim_session_t *, int maxage);
106 faim_internal int aim_putsnac(aim_bstream_t *, fu16_t family, fu16_t type, fu16_t flags, aim_snacid_t id);
108 faim_internal aim_conn_t *aim_cloneconn(aim_session_t *sess, aim_conn_t *src);
109 faim_internal void aim_clonehandlers(aim_session_t *sess, aim_conn_t *dest, aim_conn_t *src);
111 faim_internal int aim_oft_buildheader(unsigned char *,struct aim_fileheader_t *);
113 faim_internal int aim_parse_unknown(aim_session_t *, aim_frame_t *, ...);
115 /* these are used by aim_*_clientready */
116 #define AIM_TOOL_JAVA 0x0001
117 #define AIM_TOOL_MAC 0x0002
118 #define AIM_TOOL_WIN16 0x0003
119 #define AIM_TOOL_WIN32 0x0004
120 #define AIM_TOOL_MAC68K 0x0005
121 #define AIM_TOOL_MACPPC 0x0006
122 #define AIM_TOOL_NEWWIN 0x0010
123 struct aim_tool_version {
131 * In SNACland, the terms 'family' and 'group' are synonymous -- the former
132 * is my term, the latter is AOL's.
136 struct snacgroup *next;
140 * This is inside every connection. But it is a void * to anything
141 * outside of libfaim. It should remain that way. It's called data
142 * abstraction. Maybe you've heard of it. (Probably not if you're a
146 typedef struct aim_conn_inside_s {
147 struct snacgroup *groups;
150 faim_internal void aim_conn_addgroup(aim_conn_t *conn, fu16_t group);
152 faim_internal fu16_t aim_getcap(aim_session_t *sess, aim_bstream_t *bs, int len);
153 faim_internal int aim_putcap(aim_bstream_t *bs, fu16_t caps);
155 faim_internal int aim_cachecookie(aim_session_t *sess, aim_msgcookie_t *cookie);
156 faim_internal aim_msgcookie_t *aim_uncachecookie(aim_session_t *sess, fu8_t *cookie, int type);
157 faim_internal aim_msgcookie_t *aim_mkcookie(fu8_t *, int, void *);
158 faim_internal aim_msgcookie_t *aim_checkcookie(aim_session_t *, const unsigned char *, const int);
159 faim_internal int aim_freecookie(aim_session_t *sess, aim_msgcookie_t *cookie);
160 faim_internal int aim_msgcookie_gettype(int reqclass);
161 faim_internal int aim_cookie_free(aim_session_t *sess, aim_msgcookie_t *cookie);
163 faim_internal int aim_extractuserinfo(aim_session_t *sess, aim_bstream_t *bs, struct aim_userinfo_s *);
164 faim_internal int aim_putuserinfo(aim_bstream_t *bs, struct aim_userinfo_s *info);
166 faim_internal int aim_chat_readroominfo(aim_bstream_t *bs, struct aim_chat_roominfo *outinfo);
168 faim_internal void faimdprintf(aim_session_t *sess, int dlevel, const char *format, ...);
170 faim_internal void aim_conn_close_rend(aim_session_t *sess, aim_conn_t *conn);
171 faim_internal void aim_conn_kill_rend(aim_session_t *sess, aim_conn_t *conn);
174 #ifndef FAIM_INTERNAL_INSANE
175 #define printf() printf called inside libfaim
176 #define sprintf() unbounded sprintf used inside libfaim
179 #endif /* __AIM_INTERNAL_H__ */
180 #endif /* FAIM_INTERNAL */