sampHandlers.c File Reference

Message handlers for the interface. More...

#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
#include <string.h>
#include <time.h>
#include <ctype.h>
#include "samp.h"

Defines
#define	METH_DBG   (getenv("METH_DBG")!=NULL||access("/tmp/METH_DBG",F_OK)==0)
#define	OK_Map   samp_getOKMap()
#define	MATCH(s)   (func&&strncasecmp(mtype,s,min(len,16))==0)
#define	PMATCH(s)   (strcasecmp(mtype,s)==0)
#define	POPT(s)   (s[0]?s:"INDEF")
Functions
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 sender, String mtype, String msg_id, Map params)
	Execute the user-defined handler for the mtype.
int	samp_hubHandler (String sender, String mtype, String msg_id, Map msg_map)
	Handle Hub event messages.
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_genericMsgHandler (String sender, String mtype, String msg_id, Map msg_map)
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_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_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_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_bibcodeHandler (String sender, String mtype, String msg_id, Map msg_map)
	Handle a bibcode.load 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)
Variables
Map	nullMap
List	nullList
Samp *	sampP
handle_t	sampH

---

Detailed Description

Message handlers for the interface.

SAMPHANDLERS.C -- Message handlers for the interface.

Author:

Mike Fitzpatrick

Date:

7/10/09

---

Function Documentation

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_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_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_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.

Referenced by samp_receiveCall(), samp_receiveNotification(), and samp_receiveResponse().

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.

Referenced by samp_receiveCall(), samp_receiveNotification(), and samp_Subscribe().

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.

Referenced by samp_bibcodeHandler(), samp_cmdExecHandler(), samp_envGetHandler(), samp_envSetHandler(), samp_execUserHandler(), samp_imLoadHandler(), samp_paramGetHandler(), samp_paramSetHandler(), samp_PingHandler(), samp_pointAtHandler(), samp_receiveCall(), samp_receiveNotification(), samp_resConeHandler(), samp_resLoadHandler(), samp_resSiapHandler(), samp_resSsapHandler(), samp_resTapHandler(), samp_resVOSpaceHandler(), samp_specLoadHandler(), samp_specSSAHandler(), samp_StatusHandler(), samp_tbHighlightHandler(), samp_tbLoadFITSHandler(), samp_tbLoadHandler(), samp_tbLoadVOTHandler(), and samp_tbSelectHandler().

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

Handle Hub event messages.

SAMP_HUBHANDLER -- Handle Hub event messages.

Parameters:

	sender	sender name
	mtype	mtype string
	msg_id	message id
	msg_map	message map struct

Returns:

SAMP_OK or SAMP_ERR

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_nullResponse

(

void *

data

)

SAMP_NULLRESPONSE -- Handler to ignore async replies.

Referenced by samp_hubSendShutdown(), samp_notify(), and samp_Reply().

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.

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_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.

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.

Referenced by samp_resConeHandler(), samp_resSiapHandler(), samp_resSsapHandler(), samp_resTapHandler(), and samp_resVOSpaceHandler().

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.

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.

Referenced by samp_Subscribe().

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.

Referenced by samp_Subscribe().

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.

Referenced by samp_specSSAHandler().

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().

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.

Referenced by samp_tbLoadFITSHandler(), and samp_tbLoadVOTHandler().

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.

---

Variable Documentation

List nullList

SAMP_OK Map struct

Map nullMap

SAMP handle

handle_t sampH

SAMP struct pointer