- added doc for chat-abort, chat-timeout, chat-monitor and the return
value of chat
This commit is contained in:
parent
731fc793c0
commit
6d8a32093e
19
doc/chat.doc
19
doc/chat.doc
|
@ -12,4 +12,23 @@ logging output funs?
|
|||
|
||||
side-effecting option setting
|
||||
(chat-abort <re>)
|
||||
if this regular expression is matched, the chat call is aborted.
|
||||
(chat-timeout <nsecs>)
|
||||
sets the timeout for look-for calls
|
||||
(chat-monitor <monitor>)
|
||||
monitor has to be a function taking two arguments (event val),
|
||||
where event is a symbol, and val a possible value for this
|
||||
event:
|
||||
- looking-for(re)
|
||||
- found(match)
|
||||
- new-input(text)
|
||||
- sending(text)
|
||||
- abort(text)
|
||||
- eof
|
||||
- timeout
|
||||
|
||||
chat can return the following values:
|
||||
- 'eof
|
||||
- 'timeout if no timeout-handler was specified in a look-for clause
|
||||
- <string> in case of an abortion the submatch of the abort-regexp
|
||||
- #f if the whole body evaluated normally
|
||||
|
|
Loading…
Reference in New Issue