comparison src/tooltalk.doc @ 30:ec9a17fef872 r19-15b98

Import from CVS: tag r19-15b98
author cvs
date Mon, 13 Aug 2007 08:52:29 +0200
parents 376386a54a3c
children 131b0175ea99
comparison
equal deleted inserted replaced
29:7976500f47f9 30:ec9a17fef872
1 1
2 Emacs Tooltalk API Summary 2 Emacs Tooltalk API Summary
3 3
4 The Emacs Lisp interface to Tooltalk is similar, atleast in spirit, 4 The Emacs Lisp interface to Tooltalk is similar, at least in spirit,
5 to the standard C Tootalk API. Only the message and pattern parts 5 to the standard C Tootalk API. Only the message and pattern parts
6 of the API are supported at present, more of the API could be added 6 of the API are supported at present, more of the API could be added
7 if needed. The Lisp interface departs from the C API in a few ways: 7 if needed. The Lisp interface departs from the C API in a few ways:
8 8
9 - Tooltalk is initialized automatically at emacs startup-time. Messages 9 - Tooltalk is initialized automatically at emacs startup-time. Messages
193 be a string or an integer. Tooltalk doesn't 193 be a string or an integer. Tooltalk doesn't
194 define any semantics for type, so only the participants in the 194 define any semantics for type, so only the participants in the
195 protocol you're using need to agree what types mean (if anything). 195 protocol you're using need to agree what types mean (if anything).
196 Conventionally "string" is used for strings and "int" for 32 bit integers. 196 Conventionally "string" is used for strings and "int" for 32 bit integers.
197 Arguments can initialized by providing a value or with 197 Arguments can initialized by providing a value or with
198 set-tooltalk-message-attribute, the latter is neccessary if you 198 set-tooltalk-message-attribute, the latter is necessary if you
199 want to initialize the argument with a string that can contain 199 want to initialize the argument with a string that can contain
200 embedded nulls (use 'arg_bval). 200 embedded nulls (use 'arg_bval).
201 201
202 202
203 (create-tooltalk-message) 203 (create-tooltalk-message)
208 preferred to create and initialize a message. 208 preferred to create and initialize a message.
209 209
210 210
211 (destroy-tooltalk-message msg) 211 (destroy-tooltalk-message msg)
212 212
213 Apply tt_message_destroy to the message. It's not neccessary 213 Apply tt_message_destroy to the message. It's not necessary
214 to destroy messages after they've been proccessed by a message or 214 to destroy messages after they've been proccessed by a message or
215 pattern callback, the Lisp/Tooltalk callback machinery does this 215 pattern callback, the Lisp/Tooltalk callback machinery does this
216 for you. 216 for you.
217 217
218 218