source: protocols/oscar/aim_internal.h @ d0752e8

Last change on this file since d0752e8 was 66c57924, checked in by Jelmer Vernooij <jelmer@…>, at 2005-11-20T16:09:23Z

Remove OFT and rendez-vous support (not used anyway and implemented
in a way too complicated way)
  • Property mode set to 100644
File size: 7.7 KB
Line 
1/*
2 * aim_internal.h -- prototypes/structs for the guts of libfaim
3 *
4 */
5
6#ifndef __AIM_INTERNAL_H__
7#define __AIM_INTERNAL_H__ 1
8
9typedef struct {
10        guint16 family;
11        guint16 subtype;
12        guint16 flags;
13        guint32 id;
14} aim_modsnac_t;
15
16#define AIM_MODULENAME_MAXLEN 16
17#define AIM_MODFLAG_MULTIFAMILY 0x0001
18typedef struct aim_module_s {
19        guint16 family;
20        guint16 version;
21        guint16 toolid;
22        guint16 toolversion;
23        guint16 flags;
24        char name[AIM_MODULENAME_MAXLEN+1];
25        int (*snachandler)(aim_session_t *sess, struct aim_module_s *mod, aim_frame_t *rx, aim_modsnac_t *snac, aim_bstream_t *bs);
26        void (*shutdown)(aim_session_t *sess, struct aim_module_s *mod);
27        void *priv;
28        struct aim_module_s *next;
29} aim_module_t;
30
31int aim__registermodule(aim_session_t *sess, int (*modfirst)(aim_session_t *, aim_module_t *));
32void aim__shutdownmodules(aim_session_t *sess);
33aim_module_t *aim__findmodulebygroup(aim_session_t *sess, guint16 group);
34
35int buddylist_modfirst(aim_session_t *sess, aim_module_t *mod);
36int admin_modfirst(aim_session_t *sess, aim_module_t *mod);
37int bos_modfirst(aim_session_t *sess, aim_module_t *mod);
38int search_modfirst(aim_session_t *sess, aim_module_t *mod);
39int stats_modfirst(aim_session_t *sess, aim_module_t *mod);
40int auth_modfirst(aim_session_t *sess, aim_module_t *mod);
41int msg_modfirst(aim_session_t *sess, aim_module_t *mod);
42int misc_modfirst(aim_session_t *sess, aim_module_t *mod);
43int chatnav_modfirst(aim_session_t *sess, aim_module_t *mod);
44int chat_modfirst(aim_session_t *sess, aim_module_t *mod);
45int locate_modfirst(aim_session_t *sess, aim_module_t *mod);
46int general_modfirst(aim_session_t *sess, aim_module_t *mod);
47int ssi_modfirst(aim_session_t *sess, aim_module_t *mod);
48int icq_modfirst(aim_session_t *sess, aim_module_t *mod);
49
50int aim_genericreq_n(aim_session_t *, aim_conn_t *conn, guint16 family, guint16 subtype);
51int aim_genericreq_n_snacid(aim_session_t *, aim_conn_t *conn, guint16 family, guint16 subtype);
52int aim_genericreq_l(aim_session_t *, aim_conn_t *conn, guint16 family, guint16 subtype, guint32 *);
53int aim_genericreq_s(aim_session_t *, aim_conn_t *conn, guint16 family, guint16 subtype, guint16 *);
54
55#define AIMBS_CURPOSPAIR(x) ((x)->data + (x)->offset), ((x)->len - (x)->offset)
56
57void aim_rxqueue_cleanbyconn(aim_session_t *sess, aim_conn_t *conn);
58int aim_recv(int fd, void *buf, size_t count);
59int aim_bstream_init(aim_bstream_t *bs, guint8 *data, int len);
60int aim_bstream_empty(aim_bstream_t *bs);
61int aim_bstream_curpos(aim_bstream_t *bs);
62int aim_bstream_setpos(aim_bstream_t *bs, int off);
63void aim_bstream_rewind(aim_bstream_t *bs);
64int aim_bstream_advance(aim_bstream_t *bs, int n);
65guint8 aimbs_get8(aim_bstream_t *bs);
66guint16 aimbs_get16(aim_bstream_t *bs);
67guint32 aimbs_get32(aim_bstream_t *bs);
68guint8 aimbs_getle8(aim_bstream_t *bs);
69guint16 aimbs_getle16(aim_bstream_t *bs);
70guint32 aimbs_getle32(aim_bstream_t *bs);
71int aimbs_put8(aim_bstream_t *bs, guint8 v);
72int aimbs_put16(aim_bstream_t *bs, guint16 v);
73int aimbs_put32(aim_bstream_t *bs, guint32 v);
74int aimbs_putle8(aim_bstream_t *bs, guint8 v);
75int aimbs_putle16(aim_bstream_t *bs, guint16 v);
76int aimbs_putle32(aim_bstream_t *bs, guint32 v);
77int aimbs_getrawbuf(aim_bstream_t *bs, guint8 *buf, int len);
78guint8 *aimbs_getraw(aim_bstream_t *bs, int len);
79char *aimbs_getstr(aim_bstream_t *bs, int len);
80int aimbs_putraw(aim_bstream_t *bs, const guint8 *v, int len);
81int aimbs_putbs(aim_bstream_t *bs, aim_bstream_t *srcbs, int len);
82
83int aim_get_command_rendezvous(aim_session_t *sess, aim_conn_t *conn);
84
85int aim_tx_sendframe(aim_session_t *sess, aim_frame_t *cur);
86flap_seqnum_t aim_get_next_txseqnum(aim_conn_t *);
87aim_frame_t *aim_tx_new(aim_session_t *sess, aim_conn_t *conn, guint8 framing, guint8 chan, int datalen);
88void aim_frame_destroy(aim_frame_t *);
89int aim_tx_enqueue(aim_session_t *, aim_frame_t *);
90int aim_tx_printqueue(aim_session_t *);
91void aim_tx_cleanqueue(aim_session_t *, aim_conn_t *);
92
93aim_rxcallback_t aim_callhandler(aim_session_t *sess, aim_conn_t *conn, u_short family, u_short type);
94
95/*
96 * Generic SNAC structure.  Rarely if ever used.
97 */
98typedef struct aim_snac_s {
99        aim_snacid_t id;
100        guint16 family;
101        guint16 type;
102        guint16 flags;
103        void *data;
104        time_t issuetime;
105        struct aim_snac_s *next;
106} aim_snac_t;
107
108void aim_initsnachash(aim_session_t *sess);
109aim_snacid_t aim_cachesnac(aim_session_t *sess, const guint16 family, const guint16 type, const guint16 flags, const void *data, const int datalen);
110aim_snac_t *aim_remsnac(aim_session_t *, aim_snacid_t id);
111void aim_cleansnacs(aim_session_t *, int maxage);
112int aim_putsnac(aim_bstream_t *, guint16 family, guint16 type, guint16 flags, aim_snacid_t id);
113
114aim_conn_t *aim_cloneconn(aim_session_t *sess, aim_conn_t *src);
115void aim_clonehandlers(aim_session_t *sess, aim_conn_t *dest, aim_conn_t *src);
116
117int aim_oft_buildheader(unsigned char *,struct aim_fileheader_t *);
118
119int aim_parse_unknown(aim_session_t *, aim_frame_t *, ...);
120
121/* Stored in ->priv of the service request SNAC for chats. */
122struct chatsnacinfo {
123        guint16 exchange;
124        char name[128];
125        guint16 instance;
126};
127
128/* these are used by aim_*_clientready */
129#define AIM_TOOL_JAVA   0x0001
130#define AIM_TOOL_MAC    0x0002
131#define AIM_TOOL_WIN16  0x0003
132#define AIM_TOOL_WIN32  0x0004
133#define AIM_TOOL_MAC68K 0x0005
134#define AIM_TOOL_MACPPC 0x0006
135#define AIM_TOOL_NEWWIN 0x0010
136struct aim_tool_version {
137        guint16 group;
138        guint16 version;
139        guint16 tool;
140        guint16 toolversion;
141};
142
143/*
144 * In SNACland, the terms 'family' and 'group' are synonymous -- the former
145 * is my term, the latter is AOL's.
146 */
147struct snacgroup {
148        guint16 group;
149        struct snacgroup *next;
150};
151
152struct snacpair {
153        guint16 group;
154        guint16 subtype;
155        struct snacpair *next;
156};
157
158struct rateclass {
159        guint16 classid;
160        guint32 windowsize;
161        guint32 clear;
162        guint32 alert;
163        guint32 limit;
164        guint32 disconnect;
165        guint32 current;
166        guint32 max;
167        guint8 unknown[5]; /* only present in versions >= 3 */
168        struct snacpair *members;
169        struct rateclass *next;
170};
171
172/*
173 * This is inside every connection.  But it is a void * to anything
174 * outside of libfaim.  It should remain that way.  It's called data
175 * abstraction.  Maybe you've heard of it.  (Probably not if you're a
176 * libfaim user.)
177 *
178 */
179typedef struct aim_conn_inside_s {
180        struct snacgroup *groups;
181        struct rateclass *rates;
182} aim_conn_inside_t;
183
184void aim_conn_addgroup(aim_conn_t *conn, guint16 group);
185
186guint32 aim_getcap(aim_session_t *sess, aim_bstream_t *bs, int len);
187int aim_putcap(aim_bstream_t *bs, guint32 caps);
188
189int aim_cachecookie(aim_session_t *sess, aim_msgcookie_t *cookie);
190aim_msgcookie_t *aim_uncachecookie(aim_session_t *sess, guint8 *cookie, int type);
191aim_msgcookie_t *aim_mkcookie(guint8 *, int, void *);
192aim_msgcookie_t *aim_checkcookie(aim_session_t *sess, const unsigned char *, const int);
193int aim_freecookie(aim_session_t *sess, aim_msgcookie_t *cookie);
194int aim_cookie_free(aim_session_t *sess, aim_msgcookie_t *cookie);
195
196int aim_extractuserinfo(aim_session_t *sess, aim_bstream_t *bs, aim_userinfo_t *);
197int aim_putuserinfo(aim_bstream_t *bs, aim_userinfo_t *info);
198
199int aim_chat_readroominfo(aim_bstream_t *bs, struct aim_chat_roominfo *outinfo);
200
201int aim_request_directim(aim_session_t *sess, const char *destsn, guint8 *ip, guint16 port, guint8 *ckret);
202int aim_request_sendfile(aim_session_t *sess, const char *sn, const char *filename, guint16 numfiles, guint32 totsize, guint8 *ip, guint16 port, guint8 *ckret);
203void aim_conn_close_rend(aim_session_t *sess, aim_conn_t *conn);
204void aim_conn_kill_rend(aim_session_t *sess, aim_conn_t *conn);
205
206void aim_conn_kill_chat(aim_session_t *sess, aim_conn_t *conn);
207
208/* These are all handled internally now. */
209int aim_setversions(aim_session_t *sess, aim_conn_t *conn);
210int aim_reqrates(aim_session_t *, aim_conn_t *);
211int aim_rates_addparam(aim_session_t *, aim_conn_t *);
212int aim_rates_delparam(aim_session_t *, aim_conn_t *);
213
214#endif /* __AIM_INTERNAL_H__ */
Note: See TracBrowser for help on using the repository browser.