xpainfonew(3)

1xpainfonew(3)                 SAORD Documentation                xpainfonew(3)
2
3
4

NAME

6       XPAInfoNew: define an XPA info public access point
7

SYNOPSIS

9         #include <xpa.h>
10
11         XPA XPAInfoNew(char *class, char *name,
12                        int (*info_callback)(),
13                        void *info_data, char *info_mode);
14

DESCRIPTION

16       [NB: this is an experimental interface, new to XPA 2.0, whose value and
17       best use is evolving.]
18
19       A program can register interest in receiving a short message about a
20       particular topic from any other process that cares to send such a mes‐
21       sage.  Neither has to be an XPA server.  For example, if a user starts
22       to work with a new image file called new.fits, she might wish to alert
23       interested programs about this new file by sending a short message
24       using xpainfo:
25
26         xpainfo IMAGEFILE /data/new.fits
27
28       In this example, each process that has used the XPAInfoNew() call to
29       register interest in messages associated with the identifier IMAGEFILE
30       will have its info_callback() executed with the following calling
31       sequence:
32
33         int info_cb(void *info_data, void *call_data, char *paramlist)
34         {
35           XPA xpa = (XPA)call_data;
36         }
37
38       The arguments passed to this routine are equivalent to those sent in
39       the send_callback() routine.  The main difference is that there is no
40       buf sent to the info callback: this mechanism is meant for short
41       announcement of messages of interest to many clients.
42
43       The mode string is of the form: "key1=value1,key2=value2,..."  The fol‐
44       lowing keywords are recognized:
45
46         key           value           default         explanation
47         ------        --------        --------        -----------
48         acl           true/false      true            enable access control
49
50       Because no buf is passed to this callback, the usual buf-related key‐
51       words are not applicable here.
52
53       The information sent in the parameter list is arbitrary.  However, we
54       envision sending information such as file names or XPA access points
55       from which to collect more data.  Note that the xpainfo program and the
56       XPAInfo() routine that cause the info_callback to execute do not wait
57       for the callback to complete before returning.
58

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO