xemacs-beta: man/lispref/tooltalk.texi comparison

comparison man/lispref/tooltalk.texi @ 444:576fb035e263 r21-2-37

Import from CVS: tag r21-2-37

author	cvs
date	Mon, 13 Aug 2007 11:36:19 +0200
parents	8de8e3f6228a
children	9fae6227ede5

comparison

equal deleted inserted replaced

-:a8296e22da4e
+:576fb035e263
 @c -*-texinfo-*-
 @c This is part of the XEmacs Lisp Reference Manual.
 @c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
 @c See the file lispref.texi for copying conditions.
 @setfilename ../../info/tooltalk.info
 @node ToolTalk Support, LDAP Support, X-Windows, top
 @chapter ToolTalk Support
 @cindex ToolTalk
 A single callback may be associated with a message or a pattern;
 the callback is specified with a Lisp symbol (the symbol should
 have a function binding).
 @item
 The session attribute for messages and patterns is always
 initialized to the default session.
 @item
 Anywhere a ToolTalk enum constant, e.g. @samp{TT_SESSION}, is valid, one
 can substitute the corresponding symbol, e.g. @code{'TT_SESSION}.  This
 (message (get-tooltalk-message-attribute msg arg_val 0)))
 ((memq state '(TT_FAILED TT_REJECTED))
 (message "Random query turns up nothing")))))
 (defvar random-query-message
 '(   class TT_REQUEST
 scope TT_SESSION
 address TT_PROCEDURE
 op "random-query"
 args '((TT_INOUT "?" "string"))
 callback tooltalk-random-query-handler))
 @node Elisp Interface for Sending Messages
 @subsection Elisp Interface for Sending Messages
 @defun make-tooltalk-message attributes
 Create a ToolTalk message and initialize its attributes.
 The value of @var{attributes} must be a list of alternating keyword/values,
 where keywords are symbols that name valid message attributes.
 For example:
 @example
 (make-tooltalk-message
 '(class TT_NOTICE
 scope TT_SESSION
 address TT_PROCEDURE
 op "do-something"
 args ("arg1" 12345 (TT_INOUT "arg3" "string"))))
 want to initialize the argument with a string that can contain embedded
 nulls (use @code{arg_bval}).
 @refill
 @end defun
-@defun create-tooltalk-message
+@defun create-tooltalk-message &optional no-callback
 Create a new ToolTalk message.  The message's session attribute is
 initialized to the default session.  Other attributes can be initialized
 with @code{set-tooltalk-message-attribute}.
 @code{make-tooltalk-message} is the preferred way to create and
 initialize a message.
+Optional arg @var{no-callback} says don't add a C-level callback at all.
+Normally don't do that; just don't specify the Lisp callback when
+calling @code{make-tooltalk-message}.
 @refill
 @end defun
 @defun destroy-tooltalk-message msg
 Apply @samp{tt_message_destroy} to the message.  It's not necessary to
 @node Elisp Interface for Receiving Messages
 @subsection Elisp Interface for Receiving Messages
 @defun make-tooltalk-pattern attributes
 Create a ToolTalk pattern and initialize its attributes.
 The value of attributes must be a list of alternating keyword/values,
 where keywords are symbols that name valid pattern attributes
 or lists of valid attributes.  For example:
 @example
 (make-tooltalk-pattern
 '(category TT_OBSERVE
 scope TT_SESSION
 op ("operation1" "operation2")
 args ("arg1" 12345 (TT_INOUT "arg3" "string"))))
 @end example
 Attribute names are the same as those supported by
 @code{add-tooltalk-pattern-attribute}, plus @code{'args}.
 Values must always be strings, integers, or symbols that represent
 ToolTalk constants or lists of same.  When a list of values is provided
 all of the list elements are added to the attribute.  In the example
 more about the semantics and uses of ToolTalk pattern arguments in
 chapter 3 of the @cite{ToolTalk Programmer's Guide}.
 @refill
 @end defun
-@defun register-tooltalk-pattern pat
+@defun register-tooltalk-pattern pattern
 XEmacs will begin receiving messages that match this pattern.
 @end defun
-@defun unregister-tooltalk-pattern pat
+@defun unregister-tooltalk-pattern pattern
 XEmacs will stop receiving messages that match this pattern.
 @end defun
-@defun add-tooltalk-pattern-attribute value pat indicator
+@defun add-tooltalk-pattern-attribute value pattern indicator
 Add one value to the indicated pattern attribute. The names of
 attributes are the same as the ToolTalk accessors used to set them less
 the @samp{tooltalk_pattern_} prefix and the @samp{_add} suffix.  For
 example, the name of the attribute for the
 @samp{tt_pattern_disposition_add} attribute is @code{disposition}.  The
 The value of @var{callback} should be the name of a function of one
 argument.  It will be called each time the pattern matches an incoming
 message.
 @end defun
-@defun add-tooltalk-pattern-arg pat mode type value
+@defun add-tooltalk-pattern-arg pattern mode vtype &optional value
 Add one fully-specified argument to a ToolTalk pattern.  @var{mode} must
-be one of @code{TT_IN}, @code{TT_INOUT}, or @code{TT_OUT}.  @var{type}
+be one of @code{TT_IN}, @code{TT_INOUT}, or @code{TT_OUT}.  @var{vtype}
 must be a string.  @var{value} can be an integer, string or @code{nil}.
 If @var{value} is an integer then an integer argument
 (@samp{tt_pattern_iarg_add}) is added; otherwise a string argument is
 added.  At present there's no way to add a binary data argument.
 @refill
 @defun create-tooltalk-pattern
 Create a new ToolTalk pattern and initialize its session attribute to
 be the default session.
 @end defun
-@defun destroy-tooltalk-pattern pat
+@defun destroy-tooltalk-pattern pattern
 Apply @samp{tt_pattern_destroy} to the pattern.  This effectively
 unregisters the pattern.
 @end defun
 @defun describe-tooltalk-message msg &optional stream

Mercurial > hg > xemacs-beta

comparison man/lispref/tooltalk.texi @ 444:576fb035e263 r21-2-37