aboutsummaryrefslogtreecommitdiff
path: root/vo/handlers/README
diff options
context:
space:
mode:
Diffstat (limited to 'vo/handlers/README')
-rw-r--r--vo/handlers/README66
1 files changed, 66 insertions, 0 deletions
diff --git a/vo/handlers/README b/vo/handlers/README
new file mode 100644
index 00000000..ae045cbd
--- /dev/null
+++ b/vo/handlers/README
@@ -0,0 +1,66 @@
+
+ SAMP Message Handlers
+ =====================
+
+ This directory contains scripts that may be used as SAMP message handlers.
+
+
+
+Using SAMP Handlers
+===================
+
+ SAMP handlers in use can be listed with the command:
+
+ cl> samp handler
+
+A handler may be defined using the command
+
+ cl> samp handler <mtype> "<cmd_string>"
+
+where <mtype> is the SAMP MType associated with the handler (e.g. a standard
+"image.load.fits" for images, or a custom "foo.bar" for private use). The
+<cmd_string> is an IRAF command string that will be executed when that mtype
+is received, e.g.
+
+ cl> samp handler image.load.fits "imstat $url"
+
+The '$' operator before an argument will cause the value of the message
+parameter of that name to be substituted in the command string. The list
+of SAMP Mtypes in common use is maintained at
+
+ http://www.ivoa.net/cgi-bin/twiki/bin/view/IVOA/SampMTypes
+
+
+In summary, the mtypes and arguments in use at this writing include:
+
+ MType Arguments
+ ----------------------- --------------------------
+ samp.app.ping sender
+ samp.app.status sender
+
+ table.load.votable url, [table-id], [name]
+ table.load.fits url, [table-id], [name]
+ table.highlight.row url, table-id, row
+ table.select.rowList url, table-id, row-list[]
+
+ image.load.fits url, [image-id], [name]
+
+ coord.pointAt.sky ra, dec
+
+ bibcode.load bibcode
+
+ client.env.get name
+ client.env.set name, value
+
+ client.param.get name
+ client.param.set name, value
+
+ spectrum.load.ssa-generic url, meta, [spectrum-id], [name]
+
+ voresource.loadlist [name], ids
+ voresource.loadlist.cone " "
+ voresource.loadlist.siap " "
+ voresource.loadlist.ssap " "
+ voresource.loadlist.tap " "
+ voresource.loadlist.vospace " "
+