sampDecl.h File Reference

SAMP interface method declarations. More...

Go to the source code of this file.

Data Structures

struct  appMD
struct  Subs
struct  Client
struct  Hub
struct  Samp

Defines

#define SZ_NAME   256
#define SZ_LINE   256
#define SZ_SECRET   64
#define SZ_DESC   8192
#define SZ_URL   1024
#define SZ_CMD   1024
#define MAX_SAMPS   16
#define MAX_HUBS   16
#define MAX_MDATTRS   32
#define MAX_SUBS   256
#define MAX_CLIENTS   32
#define MAX_ROWS   256
#define MSG_SYNC   0
#define MSG_ASYNC   1
#define MSG_NOTIFY   2
#define DEF_CALLMODE   MSG_ASYNC

Typedefs

typedef XINT handle_t
typedef int Map
typedef int List
typedef int Msg
typedef int Param
typedef char * String
typedef struct appMD * appMDP
typedef struct Subs * SubsP
typedef struct Client * ClientP
typedef struct Hub * HubP
typedef struct Samp * SampP

Functions

handle_t sampInit (String appName, String description)
 Initialize the SAMP interface.
void samp_Metadata (handle_t handle, String field, String value)
 Set a metadata field value for the application.
void samp_Subscribe (handle_t handle, String mtype, void *func)
 Subscribe to a given mtype.
void samp_Unsubscribe (handle_t handle, String mtype)
 Unsubscribe to a given mtype.
int sampStartup (handle_t handle)
 Startup the SAMP interface to send/receive messages.
int sampShutdown (handle_t handle)
 Shut down the active SAMP interface.
void sampClose (handle_t handle)
 Close the SAMP interface and free resources.
void samp_setSyncMode (handle_t handle)
 Set the calling mode to use synchronous messaging.
void samp_setASyncMode (handle_t handle)
 Set the calling mode to use asynchronous messaging.
void samp_setNotifyMode (handle_t handle)
 Set the calling mode to use notification messaging.
void samp_setCallByRef (handle_t handle)
 Have interface call user handlers by reference.
void samp_setCallMode (handle_t handle, int mode)
 Set the default calling mode (synch or asynch).
void samp_setReplyCallback (handle_t handle, int *func)
 Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func).
void samp_setResponseCallback (handle_t handle, int *func)
 Set the Response callback. samp_setResponseCallback (handle_t handle, int *func).
void samp_setTimeout (handle_t handle, int timeout)
 Set the message timeout value (in seconds).
void samp_setAppName (handle_t handle, String name)
void samp_setAppVersion (handle_t handle, String version)
 Set the application name string.
void samp_defaultReplyHandler (handle_t handle)
 The interface's default Reply handler.
void samp_deaultfResponseHandler (handle_t handle)
int samp_replyStatus (handle_t handle)
 Reply with the status of the last message sent.
int samp_mapClients (handle_t handle)
int samp_listClients (handle_t handle)
int samp_addClient (handle_t handle, String name, String id)
int samp_removeClient (handle_t handle, String id)
Map samp_getOKMap (void)
Map samp_getNullMap (void)
int samp_Register (handle_t handle)
 Register with the Hub using the currently stored metadata.
int samp_UnRegister (handle_t handle)
 Un-Register from the hub.
int samp_DeclareMetadata (handle_t handle)
 (Re)Declare all of our metadata.
int samp_Ping (handle_t handle, String appName)
 Ping the hub/app to see if it is alive (returns >0).
Map samp_GetMetadata (handle_t handle, String pubId)
 Get the metadata for a specified app.
int samp_DeclareSubscriptions (handle_t handle)
 Declare the messages we're interested in.
Map samp_GetSubscriptions (handle_t handle, String pubId)
List samp_GetRegisteredClients (handle_t handle)
 Get public-ids of the registered clients.
List samp_GetSubscribedClients (handle_t handle, String mtype)
 Get clients matching the mtype subscription.
int samp_tableLoadVOTable (handle_t handle, String recip, String url, String tableId, String name)
 Tell an app to load a VOTable.
int samp_tableLoadFITS (handle_t handle, String recip, String url, String tableId, String name)
 Tell an app to load a FITS table.
int samp_imageLoadFITS (handle_t handle, String recip, String url, String imageId, String name)
 Tell an app to load a FITS image.
int samp_tableHighlightRow (handle_t handle, String recip, String tableId, String url, int row)
 Tell an app to highlight a table row.
int samp_tableSelectRowList (handle_t handle, String recip, String tableId, String url, int rows[], int nrows)
 Tell an app to select a list of table rows.
int samp_coordPointAtSky (handle_t handle, String recip, float ra, float dec)
 Tell an app to point at an RA/Dec coordinate.
int samp_specLoadSSAGeneric (handle_t handle, String recip, String url, Map meta, String spectrumId, String name)
 Load a generic spectrum from an SSA service.
int samp_cmdExec (handle_t handle, String recip, String cmd)
 Execute a command in a remote application.
char * samp_envGet (handle_t handle, String recip, String name)
 Get an environment variable in a remote application.
int samp_envSet (handle_t handle, String recip, String name, String value)
 Set an environment variable in a remote application.
char * samp_paramGet (handle_t handle, String recip, String name)
 Get a parameter variable in a remote application.
int samp_paramSet (handle_t handle, String recip, String name, String value)
 Set an parameter variable in a remote application.
int samp_bibLoad (handle_t handle, String recip, String bibcode)
 Exchange a bibcode.
int samp_resourceLoad (handle_t handle, String recip, String type, String name, Map resMap)
 Exchange a resource list.
int samp_sendGeneric (handle_t handle, String recip, String mtype, String args[])
 Send a geenric message.
int samp_sendMsg (handle_t handle, String recip, Map msg)
 Send the specified message.
void samp_notify (handle_t handle, String recipId, Map msg)
 Make a notify() call to the Hub.
List samp_notifyAll (handle_t handle, Map msg)
 Make a notifyAll() call to the Hub.
String samp_call (handle_t handle, String recipId, String tag, Map msg)
 Make a call() call to the Hub.
int samp_callAll (handle_t handle, String msg_tag, Map msg)
 Make a callAll() call to the Hub.
int samp_callAndWait (handle_t handle, String recipId, String msg_tag, Map msg)
 Make a callAndWait() call to the Hub.
int samp_Reply (handle_t handle, String msg_id, Map resp)
 Reply to a message.
String samp_clientName (handle_t handle, String pubId)
 Get the Client name from a pubic-id.
int samp_setErr (handle_t handle, Map resp)
 Set the error response string.
String samp_getErr (handle_t handle)
 Get the error response string.
int samp_receiveCall (void *data)
 test.echo method
int samp_receiveNotification (void *data)
 receiveNotification () client method.
int samp_receiveResponse (void *data)
 receiveResponse () client method.
void samp_setUserHandler (handle_t handle, String mtype, void *func)
 Set the user-interface handler for the mtype.
void samp_setSampHandler (handle_t handle, String mtype, void *func)
 Set the SAMP interface handler for the mtype.
void * samp_getUserHandler (String mtype)
 Get the User handler for the named mtype.
void * samp_getSampHandler (String mtype)
 Get the Samphandler for the named mtype.
void samp_execUserHandler (String mtype, String sender, String msg_id, Map params)
 Execute the user-defined handler for the mtype.
int samp_genericMsgHandler (String sender, String mtype, String msg_id, Map msg_map)
int samp_PingHandler (String sender, String mtype, String msg_id, Map msg_map)
 Is app alive and responding to messages?
int samp_StatusHandler (String sender, String mtype, String msg_id, Map msg_map)
 Return status of the task.
int samp_imLoadHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle an image.load.fits message.
int samp_tbLoadHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a generic table.load.* message.
int samp_tbLoadFITSHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a generic table.load.fits message.
int samp_tbLoadVOTHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a generic table.load.votable message.
int samp_specLoadHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a spectrum.load.* message.
int samp_specSSAHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a spectrum.load.ssa-generic message.
int samp_tbHighlightHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a table.highlight.row message.
int samp_tbSelectHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a table.select.rowList message.
int samp_pointAtHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a coord.pointAt.sky message.
int samp_bibcodeHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a bibcode.load message.
int samp_cmdExecHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a client.cmd.exec message.
int samp_envGetHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a client.env.set message.
int samp_envSetHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a client.env.set message.
int samp_paramGetHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a client.param.set message.
int samp_paramSetHandler (String sender, String mtype, String msg_id, Map msg_map)
 Handle a client.param.set message.
int samp_resLoadHandler (String sender, String mtype, String msg_id, Map msg_map)
 handle a voresource.loadlist message
int samp_resConeHandler (String sender, String mtype, String msg_id, Map msg_map)
 handle a voresource.loadlist message
int samp_resSiapHandler (String sender, String mtype, String msg_id, Map msg_map)
 handle a voresource.loadlist message
int samp_resSsapHandler (String sender, String mtype, String msg_id, Map msg_map)
 handle a voresource.loadlist message
int samp_resTapHandler (String sender, String mtype, String msg_id, Map msg_map)
 handle a voresource.loadlist message
int samp_resVOSpaceHandler (String sender, String mtype, String msg_id, Map msg_map)
 handle a voresource.loadlist message
void samp_printMessage (String mtype, String sender, String msg_id, Map params)
void samp_printMap (String name, Map map)
int samp_nullResponse (void *data)
int samp_testEcho (void *data)
handle_t samp_hubOpen (Samp *samp)
 Discover and open a connection to the SAMP Hub.
int samp_hubClose (handle_t handle)
 Close a connection to the Hub.
List samp_getAvailableHubs (handle_t handle)
 Get a list of available Hubs.
char * samp_getActiveHubName (handle_t handle)
int samp_getActiveHub (handle_t handle)
int samp_hubInit (handle_t samp, char *appName, char *descr)
int samp_processHubEvent (String mtype, Map params)
 Determine the type of Hub event mtype.
int samp_hubEvent (String mtype)
 Determine the type of Hub event mtype.
int samp_hubRegister (Hub *hub)
 Send a Register message to the Hub.
int samp_hubUnRegister (Hub *hub)
 Send a UnRegister message to the Hub.
int samp_hubSendShutdown (Hub *hub)
 Send a samp.app.event.shutdown message to the Hub.
int samp_hubSetXmlrpcCallback (Hub *hub)
 Set the client callback and send to Hub.
int samp_hubPing (Hub *hub)
 Ping the Hub to see if it is alive.
int samp_hubDeclareMetadata (Hub *hub)
 Declare "standard" metadata to the Hub.
int samp_hubDeclareSubscriptions (Hub *hub)
 Declare mtype subscriptions to the Hub.
handle_t samp_newList ()
 Create a new List object.
void samp_freeList (List list)
 Free the given List object.
int samp_listLen (List list)
 Get number of elements in a List.
void samp_setStringInList (List list, char *value)
 Set a string in a List (append).
void samp_setMapInList (List list, Map map)
 Set a Map in a List (append).
void samp_setListInList (List list1, List list2)
 Set a List in another List (append).
void samp_setIntInList (List list, int value)
 Set an Int in a List (append).
void samp_setFloatInList (List list, float value)
 Set a Float in a List (append).
char * samp_getStringFromList (List list, int index)
 Get a string from the List.
Map samp_getMapFromList (List list, int index)
 Get a Map from the List.
List samp_getListFromList (List list, int index)
 Get a List from the List.
int samp_getIntFromList (List list, int index)
float samp_getFloatFromList (List list, int index)
 Get a Float from the List.
handle_t samp_newMap (void)
 Create a new Map object.
void samp_freeMap (Map map)
 Free the given Map object.
int samp_getMapSize (Map map)
char * samp_getMapKey (Map map, int index)
char * samp_getMapVal (Map map, int index)
void samp_setStringInMap (Map map, char *key, char *value)
 Set a string in a Map (append).
void samp_setMapInMap (Map map1, char *key, Map map2)
 Set a Map in a Map (append).
void samp_setListInMap (Map map, char *key, List list)
 Set a List in a Map (append).
void samp_setIntInMap (Map map, char *key, int value)
 Set a Int in a Map (append).
void samp_setFloatInMap (Map map, char *key, float value)
 Set a string in a Map (append).
char * samp_getStringFromMap (Map map, char *key)
 Get a string from the Map.
Map samp_getMapFromMap (Map map, char *key)
 Get a Map from the Map.
List samp_getListFromMap (Map map, char *key)
 Get a LIST from the Map.
int samp_getIntFromMap (Map map, char *key)
 Get a integer from the Map.
float samp_getFloatFromMap (Map map, char *key)
 Get a float from the Map.
Msg samp_newMsg (void)
 Create a new Msg object.
void samp_freeMsg (Msg msg)
 Free the given Msg object.
void samp_msgMType (Msg msg, String mtype)
void samp_msgParam (Msg msg, Param param)
 Add a parameter to the Msg.
char * samp_msgTag (void)
Param samp_newParam (void)
 Create a new Param object.
void samp_freeParam (Param param)
 Free the given Msg object.
Param samp_paramInit (Msg msg)
 Get number of Params.
void samp_addStringParam (Msg msg, char *keyw, String val)
void samp_addMapParam (Msg msg, char *keyw, Map val)
 Add a parameter to the Param.
void samp_addListParam (Msg msg, char *keyw, List val)
 Add a parameter to the Param.
void samp_addIntParam (Msg msg, char *keyw, int val)
 Add a <SAMP int>=""> parameter to the Param.
void samp_addFloatParam (Msg msg, char *keyw, float val)
 Add a <SAMP float>=""> parameter to the Param.
int samp_paramLen (Msg msg)
 Get number of Params.
void sampLog (handle_t handle, char *format,...)
 SAMP message logger.
void sampTrace (handle_t handle, char *format,...)
 SAMP tracer.
handle_t samp_newHandle (void *ptr)
void samp_freeHandle (handle_t handle)
handle_t samp_P2H (void *ptr)
void * samp_H2P (handle_t handle)
char * samp_app2id (handle_t handle, char *appName)
 Convert an application name to a public-ID.
char * samp_id2app (handle_t handle, char *pubId)
 Convert a public-ID to the application name.
int samp_serverPort (void)
 Return a unique port number for the server.
void samp_printMetadata (handle_t handle, char *name)
 Print the metadata for the application.
char * samp_getMetadata (handle_t handle, char *name)
 Get the metadata item for the application.

Detailed Description

SAMP interface method declarations.

SAMPDECL.H -- SAMP interface method declarations.

Author:
Mike FItzpatrick
Date:
8/10/11

Define Documentation

#define SZ_NAME   256

SAMP String datatype

Referenced by samp_addClient(), samp_bibcodeHandler(), samp_envGetHandler(), samp_envSetHandler(), samp_execUserHandler(), samp_hubRunning(), samp_imLoadHandler(), samp_mapClients(), samp_paramGetHandler(), samp_paramSetHandler(), samp_removeClient(), samp_resConeHandler(), samp_resLoadHandler(), samp_resourceLoad(), samp_resSiapHandler(), samp_resSsapHandler(), samp_resTapHandler(), samp_resVOSpaceHandler(), samp_sendGeneric(), samp_specLoadHandler(), samp_specSSAHandler(), samp_tbHighlightHandler(), samp_tbLoadFITSHandler(), samp_tbLoadHandler(), samp_tbLoadVOTHandler(), and samp_tbSelectHandler().

Typedef Documentation

typedef int List

SAMP Map datatype

typedef int Map

generic object handle

typedef int Msg

SAMP List datatype

typedef int Param

SAMP Msg datatype

typedef char* String

SAMP Param datatype

Function Documentation

int samp_addClient ( handle_t  handle,
String  name,
String  id 
)

SAMP_ADDCLIENT -- Add a newly registered client to the list of known apps so we can do the public-private name translation.

References Samp::clients, Client::name, Samp::nclients, and SZ_NAME.

Referenced by samp_processHubEvent().

void samp_addFloatParam ( Msg  msg,
char *  keyw,
float  val 
)

Add a <SAMP float>=""> parameter to the Param.

SAMP_ADDFLOATPARAM -- Add a <SAMP float>=""> parameter to the Param.

Parameters:
msg handle to Msg object
keyw map keyword
val floating point value
Returns:
nothing

References samp_paramInit().

void samp_addIntParam ( Msg  msg,
char *  keyw,
int  val 
)

Add a <SAMP int>=""> parameter to the Param.

SAMP_ADDINTPARAM -- Add a <SAMP int>=""> parameter to the Param.

Parameters:
msg handle to Msg object
keyw map keyword
val integer value
Returns:
nothing

References samp_paramInit().

void samp_addListParam ( Msg  msg,
char *  keyw,
List  val 
)

Add a parameter to the Param.

SAMP_ADDLISTPARAM -- Add a List parameter to the Param.

Parameters:
msg handle to Msg object
keyw map keyword
val value list
Returns:
nothing

References samp_paramInit().

void samp_addMapParam ( Msg  msg,
char *  keyw,
Map  val 
)

Add a parameter to the Param.

SAMP_ADDMAPPARAM -- Add a Map parameter to the Param.

Parameters:
msg handle to Msg object
keyw map keyword
val value map
Returns:
nothing

References samp_paramInit().

char* samp_app2id ( handle_t  handle,
char *  appName 
)

Convert an application name to a public-ID.

SAMP_APP2ID -- Convert an application name to a public-ID.

Parameters:
handle samp struct handle
appName name of registered application
Returns:
public ID of application

References Samp::clients, Client::name, and Samp::nclients.

int samp_bibcodeHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a bibcode.load message.

SAMP_BIBCODEHANDLER -- Handle a bibcode.load message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getStringFromMap(), samp_getUserHandler(), and SZ_NAME.

int samp_bibLoad ( handle_t  handle,
String  recip,
String  bibcode 
)

Exchange a bibcode.

SAMP_BIBLOAD -- Exchange a bibcode.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
bibcode Bibcode string
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

String samp_call ( handle_t  handle,
String  recipId,
String  msg_tag,
Map  msg 
)

Make a call() call to the Hub.

SAMP_CALL -- Make a call() call to the Hub

Parameters:
handle samp struct handle
recipId recipient ID
msg_tag message tag
msg message map
Returns:
message ID

References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp_app2id(), and Samp::trace.

int samp_callAll ( handle_t  handle,
String  msg_tag,
Map  msg 
)

Make a callAll() call to the Hub.

SAMP_CALLALL -- Make a callAll() call to the Hub

Parameters:
handle samp struct handle
msg_tag message tag
msg message map
Returns:
SAMP_OK or SAMP_ERR

References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp_setErr(), and Samp::trace.

int samp_callAndWait ( handle_t  handle,
String  recipId,
String  msg_tag,
Map  msg 
)

Make a callAndWait() call to the Hub.

SAMP_CALLANDWAIT -- Make a callAndWait() call to the Hub

Parameters:
handle samp struct handle
recipId recipient ID
msg_tag message tag
msg message map
Returns:
SAMP_OK or SAMP_ERR

References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp_app2id(), samp_setErr(), Hub::timeout, and Samp::trace.

String samp_clientName ( handle_t  handle,
String  pubId 
)

Get the Client name from a pubic-id.

SAMP_CLIENTNAME -- Get the Client name from a pubic-id.

Parameters:
handle samp struct handle
pubId public ID
Returns:
declared application name

int samp_cmdExec ( handle_t  handle,
String  recip,
String  cmd 
)

Execute a command in a remote application.

SAMP_CMDEXEC -- Execute a command in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
cmd Command string
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_cmdExecHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a client.cmd.exec message.

SAMP_CMDEXECHANDLER -- Handle a client.cmd.exec message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getStringFromMap(), and samp_getUserHandler().

int samp_coordPointAtSky ( handle_t  handle,
String  recip,
float  ra,
float  dec 
)

Tell an app to point at an RA/Dec coordinate.

SAMP_COORDPOINTATSKY -- Tell an app to point at an RA/Dec coordinate.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
ra RA of coord in degrees
dec Dec of coord in degrees
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_addFloatParam(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_DeclareMetadata ( handle_t  handle  ) 

(Re)Declare all of our metadata.

SAMP_DECLAREMETATA -- (Re)Declare all of our metadata.

Parameters:
handle samp struct handle
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, and samp_hubDeclareMetadata().

int samp_DeclareSubscriptions ( handle_t  handle  ) 

Declare the messages we're interested in.

SAMP_DECLARESUBSCRIPIONS -- Declare the messages we're interested in.

Parameters:
handle samp struct handle
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, and samp_hubDeclareSubscriptions().

void samp_defaultReplyHandler ( handle_t  handle  ) 

The interface's default Reply handler.

SAMP_DEFAULTREPLYHANDLER -- The interface's default Reply handler.

Parameters:
handle samp handle
Returns:
nothing

char* samp_envGet ( handle_t  handle,
String  recip,
String  name 
)

Get an environment variable in a remote application.

SAMP_ENVGET -- Get an environment variable in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
name Name of variable in receiver's environment
Returns:
NULL, Value of variable, or list of values

References Samp::clients, Samp::errortxt, Samp::hub, hub, Hub::id, Client::name, Samp::nclients, Hub::privateKey, samp_app2id(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and Hub::timeout.

int samp_envGetHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a client.env.set message.

SAMP_ENVGETHANDLER -- Handle a client.env.set message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_freeMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_newMap(), samp_setHandlerReply(), samp_setMapInMap(), samp_setStringInMap(), and SZ_NAME.

int samp_envSet ( handle_t  handle,
String  recip,
String  name,
String  value 
)

Set an environment variable in a remote application.

SAMP_ENVSET -- Set an environment variable in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
name Name of variable in receiver's environment
value Value of variable or NULL
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_envSetHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a client.env.set message.

SAMP_ENVSETHANDLER -- Handle a client.env.set message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getStringFromMap(), samp_getUserHandler(), and SZ_NAME.

void samp_execUserHandler ( String  sender,
String  mtype,
String  msg_id,
Map  params 
)

Execute the user-defined handler for the mtype.

SAMP_EXECUSERHANDLER -- Execute the user-defined handler for the mtype.

Parameters:
sender sender name
mtype mtype string
msg_id message-id string
params Mtype parameter Map
Returns:
nothing

References Samp::defaultUserFunc, Samp::handlerMode, samp_getFloatFromMap(), samp_getIntFromMap(), samp_getListFromMap(), samp_getMapFromMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_listLen(), and SZ_NAME.

void samp_freeList ( List  list  ) 

Free the given List object.

SAMP_FREELIST -- Free the given List object

Parameters:
list List object handle
Returns:
nothing

void samp_freeMap ( Map  map  ) 

Free the given Map object.

SAMP_FREEMAP -- Free the given Map object

Parameters:
map Map object to free
Returns:
nothing

void samp_freeMsg ( Msg  msg  ) 

Free the given Msg object.

SAMP_FREEMSG -- Free the given Msg object

Parameters:
msg Msg object to free
Returns:
nothing

void samp_freeParam ( Param  param  ) 

Free the given Msg object.

SAMP_FREEPARAM -- Free the given Param object

Parameters:
param Param object to free
Returns:
nothing

List samp_getAvailableHubs ( handle_t  handle  ) 

Get a list of available Hubs.

SAMP_GETAVAILABLEHUBS -- Get a list of available Hubs

Parameters:
handle hub handle
Returns:
List of hub handles

String samp_getErr ( handle_t  handle  ) 

Get the error response string.

SAMP_GETERR -- Get the error response string.

Parameters:
handle samp struct handle
Returns:
Error text string

References Samp::errortxt.

float samp_getFloatFromList ( List  list,
int  index 
)

Get a Float from the List.

SAMP_GETFLOATFROMLIST -- Get a Float from the List

Parameters:
list List object handle
index List index containing the desired value
Returns:
int value

float samp_getFloatFromMap ( Map  map,
char *  key 
)

Get a float from the Map.

SAMP_GETFLOATFROMMAP -- Get a float from the Map

Parameters:
map handle to Map object
key Map key
Returns:
floating point value

int samp_getIntFromMap ( Map  map,
char *  key 
)

Get a integer from the Map.

SAMP_GETINTFROMMAP -- Get a integer from the Map

Parameters:
map handle to Map object
key Map key
Returns:
integer value

List samp_getListFromList ( List  list,
int  index 
)

Get a List from the List.

Get an Int from the List.

SAMP_GETLISTFROMLIST -- Get a List from the List

Parameters:
list List object handle
index List index containing the List
Returns:
List handle
SAMP_GETINTFROMLIST -- Get an Int from the List

Parameters:
list List object handle
index List index containing the desired value
Returns:
int value

List samp_getListFromMap ( Map  map,
char *  key 
)

Get a LIST from the Map.

SAMP_GETLISTFROMMAP -- Get a LIST from the Map

Parameters:
map handle to Map object
key Map key
Returns:
handle to List value

Map samp_getMapFromList ( List  list,
int  index 
)

Get a Map from the List.

SAMP_GETMAPFROMLIST -- Get a Map from the List

Parameters:
list List object handle
index List index containing the Map
Returns:
Map handle

Map samp_getMapFromMap ( Map  map,
char *  key 
)

Get a Map from the Map.

SAMP_GETMAPFROMMAP -- Get a Map from the Map

Parameters:
map handle to Map object
key Map key
Returns:
handle to Map value

char* samp_getMetadata ( handle_t  handle,
String  name 
)

Get the metadata item for the application.

SAMP_GETMETADATA -- Get the metadata item for the application.

Parameters:
handle samp handle
Returns:
nothing

References appMD::aKey, appMD::aVal, Samp::description, appMD::docURL, appMD::iconURL, Samp::meta, and appMD::nkeys.

Map samp_GetMetadata ( handle_t  handle,
String  pubId 
)

Get the metadata for a specified app.

SAMP_GETMETADATA -- Get the metadata for a specified app.

Parameters:
handle samp struct handle
pubId App public-id
Returns:
Map to message response

References Samp::errortxt, Samp::hub, hub, Hub::id, and Hub::privateKey.

Map samp_getNullMap ( void   ) 

SAMP_GETNULLMAP -- Generate a 'Null' map we can return to the Hub.

References samp_newMap().

Map samp_getOKMap ( void   ) 

SAMP_GETOKMAP -- Generate an 'OK' map we can return to the Hub.

References nullMap, samp_newMap(), samp_setMapInMap(), and samp_setStringInMap().

List samp_GetRegisteredClients ( handle_t  handle  ) 

Get public-ids of the registered clients.

SAMP_GETREGISTEREDCLIENTS -- Get public-ids of the registered clients.

Parameters:
handle samp struct handle
Returns:
handle to list of registered clients

References Samp::hub, Hub::id, Hub::privateKey, samp_listLen(), samp_newList(), and samp_setStringInList().

void* samp_getSampHandler ( String  mtype  ) 

Get the Samphandler for the named mtype.

SAMP_GETSAMPHANDLER -- Get the Samphandler for the named mtype.

Parameters:
mtype mtype string
Returns:
nothing

References Samp::nsubs, and Subs::sampFunc.

char* samp_getStringFromList ( List  list,
int  index 
)

Get a string from the List.

SAMP_GETSTRINGFROMLIST -- Get a string from the List

Parameters:
list List object handle
index List index containing the string
Returns:
character string

char* samp_getStringFromMap ( Map  map,
char *  key 
)

Get a string from the Map.

SAMP_GETSTRINGFROMMAP -- Get a string from the Map

Parameters:
map handle to Map object
key Map key
Returns:
string value from Map

List samp_GetSubscribedClients ( handle_t  handle,
String  mtype 
)

Get clients matching the mtype subscription.

SAMP_GETSUBSCRIBEDCLIENTS -- Get clients matching the mtype subscription.

Parameters:
handle samp struct handle
mtype mtype string
Returns:
handle to list of clients having mtype subscription

References Samp::hub, Hub::id, Hub::privateKey, samp_listLen(), samp_newList(), and samp_setStringInList().

void* samp_getUserHandler ( String  mtype  ) 

Get the User handler for the named mtype.

SAMP_GETUSERHANDLER -- Get the User handler for the named mtype.

Parameters:
mtype mtype string
Returns:
nothing

References Samp::defaultUserFunc, Samp::nsubs, and Subs::userFunc.

int samp_hubClose ( handle_t  handle  ) 

Close a connection to the Hub.

SAMP_HUBCLOSE -- Close a connection to the Hub.

Parameters:
handle hub handle
Returns:
unregister status

References appMD::aKey, appMD::aVal, Hub::meta, appMD::nkeys, samp_freeHandle(), and samp_hubUnRegister().

int samp_hubDeclareMetadata ( Hub *  hub  ) 

Declare "standard" metadata to the Hub.

SAMP_DECLAREMETADATA -- Declare "standard" metadata to the Hub.

Parameters:
hub hub struct pointer
Returns:
status

References appMD::aKey, appMD::aVal, Hub::description, appMD::docURL, appMD::iconURL, Hub::id, Hub::meta, appMD::nkeys, and Hub::privateKey.

int samp_hubDeclareSubscriptions ( Hub *  hub  ) 

Declare mtype subscriptions to the Hub.

SAMP_HUBDECLARESUBSCRIPTIONS -- Declare mtype subscriptions to the Hub.

Parameters:
hub hub struct pointer
Returns:
status

References Hub::id, Samp::nsubs, nullMap, Hub::privateKey, Hub::samp, samp_freeMap(), and Subs::userFunc.

int samp_hubEvent ( String  mtype  ) 

Determine the type of Hub event mtype.

SAMP_HUBEVENT -- Determine the type of Hub event mtype.

Parameters:
mtype mtype string
Returns:
Hub event code or -1 if not found

References HUB_SHUTDOWN.

handle_t samp_hubOpen ( Samp *  sampP  ) 

Discover and open a connection to the SAMP Hub.

SAMP_HUBOPEN -- Discover and open a connection to the SAMP Hub.

Parameters:
samp Same structure
Returns:
hub handle

References Hub::appId, Samp::appVer, Hub::appVer, appMD::desc, Hub::description, Samp::description, Hub::id, Hub::meta, Hub::samp, samp_hubRegister(), samp_hubSetXmlrpcCallback(), samp_newHandle(), samp_P2H(), Hub::timeout, and Hub::url.

int samp_hubPing ( Hub *  hub  ) 

Ping the Hub to see if it is alive.

SAMP_HUBPING -- Ping the Hub to see if it is alive.

Parameters:
hub hub struct pointer
Returns:
status

References Hub::id, and Hub::privateKey.

int samp_hubRegister ( Hub *  hub  ) 

Send a Register message to the Hub.

SAMP_HUB_REGISTER -- Send a Register message to the Hub.

Parameters:
hub hub struct pointer
Returns:
status

References Hub::hubId, Hub::id, Hub::privateKey, Hub::secret, and Hub::selfId.

int samp_hubSendShutdown ( Hub *  hub  ) 

Send a samp.app.event.shutdown message to the Hub.

SAMP_HUBSENDSHUTDOWN -- Send a samp.app.event.shutdown message to the Hub.

Parameters:
hub hub struct pointer
Returns:
status

References Hub::id, Hub::privateKey, and samp_nullResponse().

int samp_hubSetXmlrpcCallback ( Hub *  hub  ) 

Set the client callback and send to Hub.

SAMP_HUBSETXMLRPCCALLBACK -- Set the client callback and send to Hub

Parameters:
hub hub struct pointer
Returns:
status

References Hub::id, Hub::privateKey, and samp_serverPort().

int samp_hubUnRegister ( Hub *  hub  ) 

Send a UnRegister message to the Hub.

SAMP_HUBUNREGISTER -- Send a UnRegister message to the Hub.

Parameters:
hub hub struct pointer
Returns:
status

References Hub::id, and Hub::privateKey.

char* samp_id2app ( handle_t  handle,
char *  pubId 
)

Convert a public-ID to the application name.

SAMP_ID2APP -- Convert a public-ID to the application name.

Parameters:
handle samp struct handle
pubId public ID of application
Returns:
name of registered application

References Samp::clients, Client::name, and Samp::nclients.

int samp_imageLoadFITS ( handle_t  handle,
String  recip,
String  url,
String  imageId,
String  name 
)

Tell an app to load a FITS image.

SAMP_IMAGELOADFITS -- Tell an app to load a FITS image.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
url URL to table to be loaded
imageId ID assigned to image (optional)
name Name assigned to image (optional)
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_imLoadHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle an image.load.fits message.

SAMP_IMLOADHANDLER -- Handle an image.load.fits message.

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getStringFromMap(), samp_getUserHandler(), and SZ_NAME.

int samp_listClients ( handle_t  handle  ) 

SAMP_LISTCLIENTS -- List the available clients to stdout.

References Samp::clients, Client::name, and Samp::nclients.

int samp_listLen ( List  list  ) 

Get number of elements in a List.

SAMP_LISTLEN -- Get number of elements in a List.

Parameters:
list List object handle
Returns:
nothing

int samp_mapClients ( handle_t  handle  ) 

SAMP_MAPCLIENTS -- Map the public-ids of registered clients to the appName.

References Samp::clients, Client::name, Samp::nclients, samp_freeList(), samp_GetMetadata(), samp_GetRegisteredClients(), samp_getStringFromList(), samp_listLen(), and SZ_NAME.

Referenced by sampStartup().

void samp_Metadata ( handle_t  handle,
String  field,
String  value 
)

Set a metadata field value for the application.

SAMP_METADATA -- Set a metadata field for the application. This will be sent to the Hub later in a declareMetadata() call.

Parameters:
handle samp handle
field metadata field to set (name, author, etc)
samp value of field
Returns:
nothing

References appMD::aKey, Samp::appVer, Hub::appVer, appMD::aVal, appMD::desc, Hub::description, Samp::description, appMD::docURL, Samp::hub, appMD::iconURL, Hub::meta, Samp::meta, appMD::nkeys, and sampTrace().

void samp_msgParam ( Msg  msg,
Param  param 
)

Add a parameter to the Msg.

SAMP_MSGPARAM -- Add a parameter to the Msg.

Parameters:
msg handle to Msg object
keyw map keyword
param parameter map
Returns:
nothing

handle_t samp_newList ( void   ) 

Create a new List object.

SAMP_NEWLIST -- Create a new List object

Returns:
handle to List object

handle_t samp_newMap ( void   ) 

Create a new Map object.

SAMP_NEWMAP -- Create a new Map object

Returns:
handle to new Map

Msg samp_newMsg ( void   ) 

Create a new Msg object.

SAMP_NEWMSG -- Create a new Msg object

Returns:
handle to new Msg

Param samp_newParam ( void   ) 

Create a new Param object.

SAMP_NEWPARAM -- Create a new Param object

Returns:
handle to new Param

void samp_notify ( handle_t  handle,
String  recipId,
Map  msg 
)

Make a notify() call to the Hub.

SAMP_NOTIFY -- Make a notify() call to the Hub

Parameters:
handle samp struct handle
recipId recipient ID
msg message map
Returns:
nothing

References Samp::hub, hub, Hub::id, Hub::privateKey, samp_app2id(), and samp_nullResponse().

List samp_notifyAll ( handle_t  handle,
Map  msg 
)

Make a notifyAll() call to the Hub.

SAMP_NOTIFYALL -- Make a notifyAll() call to the Hub

Parameters:
handle samp struct handle
msg message map
Returns:
nothing

References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, and Samp::trace.

int samp_nullResponse ( void *  data  ) 

SAMP_NULLRESPONSE -- Handler to ignore async replies.

char* samp_paramGet ( handle_t  handle,
String  recip,
String  name 
)

Get a parameter variable in a remote application.

SAMP_PARAMGET -- Get a parameter variable in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
name Name of variable in receiver's environment
Returns:
NULL, Value of variable, or list of values

References Samp::clients, Samp::errortxt, Samp::hub, hub, Hub::id, Client::name, Samp::nclients, Hub::privateKey, samp_app2id(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and Hub::timeout.

int samp_paramGetHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a client.param.set message.

SAMP_PARAMGETHANDLER -- Handle a client.param.set message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_freeMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_newMap(), samp_setHandlerReply(), samp_setMapInMap(), samp_setStringInMap(), and SZ_NAME.

Param samp_paramInit ( Msg  msg  ) 

Get number of Params.

SAMP_PARAMINIT -- Get number of Params.

Parameters:
msg handle to Msg object
Returns:
nothing

int samp_paramLen ( Msg  msg  ) 

Get number of Params.

SAMP_PARAMLEN -- Get number of Params.

Parameters:
msg handle to Msg object
Returns:
nothing

int samp_paramSet ( handle_t  handle,
String  recip,
String  name,
String  value 
)

Set an parameter variable in a remote application.

SAMP_PARAMSET -- Set an parameter variable in a remote application.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
name Name of variable in receiver's environment
value Value of variable or NULL
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_paramSetHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a client.param.set message.

SAMP_PARAMSETHANDLER -- Handle a client.param.set message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getStringFromMap(), samp_getUserHandler(), and SZ_NAME.

int samp_Ping ( handle_t  handle,
String  appName 
)

Ping the hub/app to see if it is alive (returns >0).

SAMP_PING -- Ping the hub/app to see if it is alive (returns >0).

Parameters:
handle samp struct handle
appName application name
Returns:
OK or ERR if no response

References Samp::hub, samp_app2id(), samp_callAll(), samp_callAndWait(), samp_freeMap(), samp_freeMsg(), samp_hubPing(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_setErr().

int samp_PingHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Is app alive and responding to messages?

SAMP_PINGHANDLER -- Simple aliveness test function.

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, and samp_getUserHandler().

int samp_pointAtHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a coord.pointAt.sky message.

SAMP_POINTATHANDLER -- Handle a coord.pointAt.sky message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getFloatFromMap(), and samp_getUserHandler().

void samp_printMap ( String  name,
Map  map 
)

SAMP_PRINTMAP -- Print the contents of a Map structure.

void samp_printMetadata ( handle_t  handle,
String  name 
)

Print the metadata for the application.

SAMP_PRINTMETADATA -- Print the metadata for the application.

Parameters:
handle samp handle
Returns:
nothing

References appMD::aKey, appMD::aVal, Samp::description, appMD::docURL, appMD::iconURL, Samp::meta, and appMD::nkeys.

int samp_processHubEvent ( String  mtype,
Map  params 
)

Determine the type of Hub event mtype.

SAMP_HUBEVENT -- Determine the type of Hub event mtype.

Parameters:
mtype mtype string
params message parameter Map
Returns:
non-zero value if a Hub event was processed

References HUB_SHUTDOWN, samp_addClient(), samp_hubEvent(), samp_mutex, samp_P2H(), samp_removeClient(), sampH, and sampShutdown().

int samp_receiveCall ( void *  data  ) 

test.echo method

receiveCall () client method.

SAMP_TESTECHO -- test.echo method

Parameters:
data caller param data
Returns:
status code or errno
SAMP_RECEIVECALL -- receiveCall() client method.

Parameters:
data caller param data
Returns:
status code or errno

References Samp::defaultUserFunc, OK_Map, samp_execUserHandler(), samp_getHandlerReply(), samp_getSampHandler(), samp_getUserHandler(), samp_Reply(), sampH, and Samp::trace.

int samp_receiveNotification ( void *  data  ) 

receiveNotification () client method.

SAMP_RECEIVENOTIFICATION -- receiveNotification() client method.

Parameters:
data caller param data
Returns:
status code or errno

References Samp::defaultUserFunc, OK_Map, samp_execUserHandler(), samp_getHandlerReply(), samp_getSampHandler(), samp_getUserHandler(), samp_processHubEvent(), and Samp::trace.

int samp_receiveResponse ( void *  data  ) 

receiveResponse () client method.

SAMP_RECEIVERESPONSE -- receiveResponse() client method.

Parameters:
data caller param data
Returns:
status code or errno

References Samp::defaultUserFunc, OK_Map, samp_execUserHandler(), and Samp::trace.

int samp_Register ( handle_t  handle  ) 

Register with the Hub using the currently stored metadata.

SAMP_REGISTER -- Register with the Hub using the currently stored metadata.

Parameters:
handle samp struct handle
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, Hub::hubId, Hub::id, Hub::privateKey, samp_replyStatus(), Hub::secret, and Hub::selfId.

int samp_removeClient ( handle_t  handle,
String  id 
)

SAMP_REMOVECLIENT -- Remove a registered client from the list of known apps that do the public-private name translation.

References Samp::clients, Client::name, Samp::nclients, and SZ_NAME.

Referenced by samp_processHubEvent().

int samp_Reply ( handle_t  handle,
String  msg_id,
Map  response 
)

Reply to a message.

SAMP_REPLY -- Reply to a message. All we do here is send the reply message, we require that the response Map already be defined.

Parameters:
handle samp struct handle
msg_id message ID
response response map
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, Hub::id, Hub::privateKey, and samp_nullResponse().

int samp_replyStatus ( handle_t  handle  ) 

Reply with the status of the last message sent.

SAMP_REPLYSTATUS -- Reply with the status of the last message sent.

May be used to 'poll' for a reponse from the caller in cases where use of a callback is a problem. Codes are: <0==ERR, 0==PENDING, 1==OK

Parameters:
samp samp struct ptr
Returns:
message status

Referenced by samp_Register().

int samp_resConeHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

handle a voresource.loadlist message

SAMP_RESCONEHANDLER -- Handle a voresource.loadlist.cone message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getMapFromMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_resLoadHandler(), and SZ_NAME.

int samp_resLoadHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

handle a voresource.loadlist message

SAMP_RESLOADHANDLER -- handle a voresource.loadlist.* message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getMapFromMap(), samp_getStringFromMap(), samp_getUserHandler(), and SZ_NAME.

int samp_resourceLoad ( handle_t  handle,
String  recip,
String  type,
String  name,
Map  resMap 
)

Exchange a resource list.

SAMP_RESOURCELOAD -- Exchange a resource list.

Parameters:
handle samp struct handle
recip Name of recipient (or 'all')
type Resource type (or NULL)
name Descriptive name (optional)
resMap Resource map
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_addMapParam(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), samp_sendMsg(), and SZ_NAME.

int samp_resSiapHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

handle a voresource.loadlist message

SAMP_RESSIAPHANDLER -- Handle a voresource.loadlist.siap message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getMapFromMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_resLoadHandler(), and SZ_NAME.

int samp_resSsapHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

handle a voresource.loadlist message

SAMP_RESSSAPHANDLER -- Handle a voresource.loadlist.ssap message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getMapFromMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_resLoadHandler(), and SZ_NAME.

int samp_resTapHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

handle a voresource.loadlist message

SAMP_RESTAPHANDLER -- Handle a voresource.loadlist.tap message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getMapFromMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_resLoadHandler(), and SZ_NAME.

int samp_resVOSpaceHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

handle a voresource.loadlist message

SAMP_RESVOSPACEHANDLER -- Handle a voresource.loadlist.vospace message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getMapFromMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_resLoadHandler(), and SZ_NAME.

int samp_sendGeneric ( handle_t  handle,
String  recip,
String  mtype,
String  args[] 
)

Send a geenric message.

SAMP_SENDGENERIC -- Send a generic message.

Parameters:
handle samp struct handle
recip Name of recipient (or 'all')
mtype Message type
args Argument list
Returns:
SAMP_OK or SAMP_ERR
This method can be used to send any user-defined message. The 'mtype' string is arbitrary, we just assume the receiving client can understand what it means. The 'args' String array can be an array of values in which case the parameter name will be a series of generic 'arg0' thru 'argN-1' names.

References Samp::hub, hub, samp_addFloatParam(), samp_addIntParam(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), samp_sendMsg(), and SZ_NAME.

int samp_sendMsg ( handle_t  handle,
String  recip,
Map  msg 
)

Send the specified message.

SAMP_SENDMSG -- Send the specified message.

Parameters:
handle samp struct handle
recip Name of recipient (or 'all')
msg Message map
Returns:
SAMP_OK or SAMP_ERR

References Samp::clients, Samp::msgMode, Samp::nclients, samp_app2id(), samp_call(), samp_callAll(), samp_callAndWait(), samp_notify(), samp_notifyAll(), and samp_setErr().

int samp_serverPort ( void   ) 

Return a unique port number for the server.

SAMP_SERVERPORT -- Return a unique port number for the server.

Returns:
port number

void samp_setAppVersion ( handle_t  handle,
String  version 
)

Set the application name string.

Set the application version string.

SAMP_SETAPPNAME -- Set the application name string.

Parameters:
handle samp handle
name application name
Returns:
nothing
SAMP_SETAPPVERSION -- Set the application version string.

Parameters:
handle samp handle
name application version
Returns:
nothing

References Hub::appVer, Samp::appVer, and Samp::hub.

void samp_setASyncMode ( handle_t  handle  ) 

Set the calling mode to use asynchronous messaging.

SAMP_SETASYNCMODE -- Set the calling mode to use asynchronous messaging.

Parameters:
handle samp handle
Returns:
nothing

References Samp::msgMode.

void samp_setCallByRef ( handle_t  handle  ) 

Have interface call user handlers by reference.

SAMP_SETCALLBYREF -- Have interface call user handlers by reference.

Parameters:
handle samp handle
Returns:
nothing

References Samp::handlerMode.

void samp_setCallMode ( handle_t  handle,
int  mode 
)

Set the default calling mode (synch or asynch).

SAMP_SETCALLMODE -- Set the default calling mode (synch or asynch)

Parameters:
handle samp handle
mode call mode (synch or asynch)
Returns:
nothing

References Samp::msgMode.

int samp_setErr ( handle_t  handle,
Map  resp 
)

Set the error response string.

SAMP_SETERR -- Set the error response string/code.

Parameters:
handle samp struct handle
resp Response map
Returns:
SAMP_OK or SAMP_ERR

References Samp::errortxt.

void samp_setFloatInList ( List  list,
float  rval 
)

Set a Float in a List (append).

SAMP_SETFLOATINLIST -- Set a Float in a List (append)

Parameters:
list1 List object handle
rval Float value to be appended
Returns:
nothing

void samp_setFloatInMap ( Map  map,
char *  key,
float  value 
)

Set a string in a Map (append).

SAMP_SETFLOATINMAP -- Set a Float in a Map (append)

Parameters:
map handle to Map object
key Map key
value value
Returns:
nothing

void samp_setIntInList ( List  list,
int  ival 
)

Set an Int in a List (append).

SAMP_SETINTINLIST -- Set an Int in a List (append)

Parameters:
list1 List object handle
ival Integer value to be appended
Returns:
nothing

void samp_setIntInMap ( Map  map,
char *  key,
int  value 
)

Set a Int in a Map (append).

SAMP_SETINTINMAP -- Set a Int in a Map (append)

Parameters:
map handle to Map object
key Map key
value value
Returns:
nothing

void samp_setListInList ( List  list1,
List  list2 
)

Set a List in another List (append).

SAMP_SETLISTINLIST -- Set a List in another List (append)

Parameters:
list1 List object handle
list2 List to be appended
Returns:
nothing

void samp_setListInMap ( Map  map,
char *  key,
List  list 
)

Set a List in a Map (append).

SAMP_SETLISTINMAP -- Set a List in a Map (append)

Parameters:
map handle to Map object
key Map key
list handle to List object to set
Returns:
nothing

void samp_setMapInList ( List  list,
Map  map 
)

Set a Map in a List (append).

SAMP_SETMAPINLIST -- Set a Map in a List (append)

Parameters:
list List object handle
map Map object to be set
Returns:
nothing

void samp_setMapInMap ( Map  map1,
char *  key,
Map  map2 
)

Set a Map in a Map (append).

SAMP_SETMAPINMAP -- Set a Map in a Map (append)

Parameters:
map1 handle to Map object
key Map key
map2 handle to Map object to set
Returns:
nothing

void samp_setNotifyMode ( handle_t  handle  ) 

Set the calling mode to use notification messaging.

SAMP_SETNOTIFYMODE -- Set the calling mode to use notification messaging.

Parameters:
handle samp handle
Returns:
nothing

References Samp::msgMode.

void samp_setReplyCallback ( handle_t  handle,
int *  func 
)

Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func).

SAMP_SETREPLYCALLBACK -- Set the Reply callback.

Parameters:
handle samp handle
func callback for Reply message
Returns:
nothing

void samp_setResponseCallback ( handle_t  handle,
int *  func 
)

Set the Response callback. samp_setResponseCallback (handle_t handle, int *func).

SAMP_SETRESPONSECALLBACK -- Set the Response callback.

Parameters:
handle samp handle
func callback for message response
Returns:
nothing

void samp_setSampHandler ( handle_t  handle,
String  mtype,
void *  func 
)

Set the SAMP interface handler for the mtype.

SAMP_SETSAMPHANDLER -- Set the SAMP interface handler for the mtype.

Parameters:
handle user handle to samp struct
mtype mtype name
func callback function
Returns:
nothing

References Samp::nsubs, and Subs::sampFunc.

void samp_setStringInList ( List  list,
char *  value 
)

Set a string in a List (append).

SAMP_SETSTRINGINLIST -- Set a string in a List (append)

Parameters:
list List object handle
value string value to set
Returns:
nothing

void samp_setStringInMap ( Map  map,
char *  key,
char *  value 
)

Set a string in a Map (append).

SAMP_SETSTRINGINMAP -- Set a string in a Map (append)

Parameters:
map handle to Map object
key Map key
value Map value
Returns:
nothing

void samp_setSyncMode ( handle_t  handle  ) 

Set the calling mode to use synchronous messaging.

SAMP_SETSYNCMODE -- Set the calling mode to use synchronous messaging.

Parameters:
handle samp handle
Returns:
nothing

References Samp::msgMode.

void samp_setTimeout ( handle_t  handle,
int  timeout 
)

Set the message timeout value (in seconds).

SAMP_SETTIMEOUT -- Set the message timeout value (in seconds).

Parameters:
handle samp handle
name application name
Returns:
nothing

References Samp::hub, and Hub::timeout.

void samp_setUserHandler ( handle_t  handle,
String  mtype,
void *  func 
)

Set the user-interface handler for the mtype.

SAMP_SETUSERHANDLER -- Set the user-interface handler for the mtype.

Parameters:
handle user handle to samp struct
mtype mtype name
func callback function
Returns:
nothing

References Samp::defaultUserFunc, Samp::nsubs, and Subs::userFunc.

int samp_specLoadHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a spectrum.load.* message.

SAMP_SPECLOADHANDLER -- Handle a spectrum.load.* message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getMapFromMap(), samp_getStringFromMap(), samp_getUserHandler(), and SZ_NAME.

int samp_specLoadSSAGeneric ( handle_t  handle,
String  recip,
String  url,
Map  meta,
String  spectrumId,
String  name 
)

Load a generic spectrum from an SSA service.

SAMP_SPECLOADSSAGENERIC -- Load a generic spectrum from an SSA service.

Parameters:
handle samp struct handle
recip name of recipient (or 'all')
url URL of spectrum to load
meta Metadata map describing data found at the URL
spectrumId Identifier for spectrum (optional)
name Name used to label spectrum (optional);
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_addMapParam(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_specSSAHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a spectrum.load.ssa-generic message.

SAMP_SPECSSAHANDLER -- Handle a spectrum.load.ssa-generic message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getMapFromMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_specLoadHandler(), and SZ_NAME.

int samp_StatusHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Return status of the task.

SAMP_STATUSHANDLER -- Return status of the task.

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, and samp_getUserHandler().

void samp_Subscribe ( handle_t  handle,
String  mtype,
void *  userFunc 
)

Subscribe to a given mtype.

SAMP_SUBSCRIBE -- Subscribe to a given mtype.

Parameters:
handle user handle to samp struct
mtype mtype name
func callback function
Returns:
nothing

References Samp::nsubs, samp_getSampHandler(), samp_setSampHandler(), and samp_setUserHandler().

int samp_tableHighlightRow ( handle_t  handle,
String  recip,
String  tableId,
String  url,
int  row 
)

Tell an app to highlight a table row.

SAMP_TABLEHIGHLIGHTROW -- Tell an app to highlight a table row.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
tableId ID associated with a previously loaded table
url URL to table to be loaded
rows List of (zero-based) row indices
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_addIntParam(), samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_tableLoadFITS ( handle_t  handle,
String  recip,
String  url,
String  tableId,
String  name 
)

Tell an app to load a FITS table.

SAMP_TABLELOADFITS -- Tell an app to load a FITS table.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
url URL to table to be loaded
tableId ID assigned to table (optional)
name Name assigned to table (optional)
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_tableLoadVOTable ( handle_t  handle,
String  recip,
String  url,
String  tableId,
String  name 
)

Tell an app to load a VOTable.

SAMP_TABLELOADVOTABLE -- Tell an app to load a VOTable.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
url URL to table to be loaded
tableId ID assigned to table (optional)
name Name assigned to table (optional)
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_freeMsg(), samp_msgParam(), samp_newMsg(), samp_newParam(), and samp_sendMsg().

int samp_tableSelectRowList ( handle_t  handle,
String  recip,
String  tableId,
String  url,
int  rows[],
int  nrows 
)

Tell an app to select a list of table rows.

SAMP_TABLESELECTROWLIST -- Tell an app to select a list of table rows.

Parameters:
handle samp struct handle
recip Message recipient (or "all" for broadcast)
tableId ID associated with a previously loaded table
url URL to table to be loaded
rows Array of (zero-based) row indices
nrows Number of rows
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, samp_addListParam(), samp_freeList(), samp_freeMsg(), samp_msgParam(), samp_newList(), samp_newMsg(), samp_newParam(), samp_sendMsg(), and samp_setIntInList().

int samp_tbHighlightHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a table.highlight.row message.

SAMP_TBHIGHLIGHTHANDLER -- Handle a table.highlight.row message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getIntFromMap(), samp_getStringFromMap(), samp_getUserHandler(), and SZ_NAME.

int samp_tbLoadFITSHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a generic table.load.fits message.

SAMP_TBLOADFITSHANDLER -- Handle a generic table.load.fits message *

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getStringFromMap(), samp_getUserHandler(), samp_tbLoadHandler(), and SZ_NAME.

int samp_tbLoadHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a generic table.load.* message.

SAMP_TBLOADHANDLER -- Handle a generic table.load.* message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getStringFromMap(), samp_getUserHandler(), and SZ_NAME.

int samp_tbLoadVOTHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a generic table.load.votable message.

SAMP_TBLOADVOTHANDLER -- Handle a generic table.load.votable message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getStringFromMap(), samp_getUserHandler(), samp_tbLoadHandler(), and SZ_NAME.

int samp_tbSelectHandler ( String  sender,
String  mtype,
String  msg_id,
Map  msg_map 
)

Handle a table.select.rowList message.

SAMP_TBSELECTHANDLER -- Handle a table.select.rowList message

Parameters:
sender sender name
mtype mtype string
msg_id message id
msg_map message map struct
Returns:
SAMP_OK or SAMP_ERR

References Samp::handlerMode, samp_getListFromMap(), samp_getStringFromMap(), samp_getUserHandler(), samp_listLen(), and SZ_NAME.

int samp_UnRegister ( handle_t  handle  ) 

Un-Register from the hub.

SAMP_UNREGISTER -- Un-Register from the hub.

Parameters:
handle samp struct handle
Returns:
SAMP_OK or SAMP_ERR

References Samp::hub, hub, and samp_hubUnRegister().

void samp_Unsubscribe ( handle_t  handle,
String  mtype 
)

Unsubscribe to a given mtype.

SAMP_UNSUBSCRIBE -- Unsubscribe to a given mtype.

Parameters:
handle user handle to samp struct
mtype mtype name
Returns:
nothing

References Samp::nsubs, samp_DeclareSubscriptions(), Subs::sampFunc, and Subs::userFunc.

void sampClose ( handle_t  handle  ) 

Close the SAMP interface and free resources.

SAMP_CLOSE -- Close the SAMP interface.

Parameters:
handle user handle to samp struct
Returns:
nothing

References Samp::hub, Samp::hubHandle, samp_freeHandle(), samp_hubClose(), sampTrace(), and Samp::verbose.

handle_t sampInit ( String  appName,
String  description 
)

Initialize the SAMP interface.

Prototype declarations.

SAMP_INIT -- Initialize the SAMP interface.

Parameters:
appName application name
description description of application
Returns:
samp handle

References nullList, nullMap, OK_Map, samp_hubOpen(), samp_newHandle(), samp_newList(), samp_newMap(), samp_serverPort(), samp_setMapInMap(), samp_setStringInMap(), sampH, and sampTrace().

void sampLog ( handle_t  handle,
char *  format,
  ... 
)

SAMP message logger.

SAMPLOG -- SAMP message logger.

Parameters:
handle SAMP handle
format message format string
Returns:
nothing

References Samp::debug, and Samp::logfd.

int sampShutdown ( handle_t  handle  ) 

Shut down the active SAMP interface.

SAMP_SHUTDOWN -- Shut down the active SAMP interface.

Parameters:
handle user handle to samp struct
Returns:
nothing

References Samp::active, Samp::hubHandle, samp_hubClose(), Samp::svrThread, and Samp::verbose.

Referenced by samp_processHubEvent().

int sampStartup ( handle_t  handle  ) 

Startup the SAMP interface to send/receive messages.

SAMP_STARTUP -- Startup the SAMP interface to send/receive messages.

Parameters:
handle user handle to samp struct
Returns:
nothing

References Samp::active, Samp::clients, Samp::hub, Samp::hubHandle, Hub::id, Samp::mapClients, Client::name, Samp::nclients, samp_hubDeclareMetadata(), samp_hubDeclareSubscriptions(), samp_hubOpen(), samp_mapClients(), Samp::trace, and Samp::verbose.

void sampTrace ( handle_t  handle,
char *  format,
  ... 
)

SAMP tracer.

SAMPTRACE -- SAMP tracer.

Parameters:
handle SAMP handle
format message format string
Returns:
nothing

References Samp::trace.

Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by  doxygen 1.5.9