Samp Struct Reference

#include <samp.h>

Data Fields
char	appName [SZ_NAME]
char	appVer [SZ_LINE]
char	description [SZ_NAME]
char	errortxt [SZ_LINE]
appMD	meta
pthread_t	svrThread
int(*	defaultUserFunc )(char *sender, char *msgid, Map map)
Subs	subs [MAX_SUBS]
int	nsubs
Client	clients [MAX_CLIENTS]
int	nclients
int	serverTid
int	serverPort
Hub *	hub
handle_t	hubHandle
int	hubThreadID
int	active
int	mapClients
int	msgMode
int	handlerMode
FILE *	logfd
int	debug
int	verbose
int	trace

---

Detailed Description

SAMP application description. By default this describes our app by may be used to store information about other apps in the network as well.

---

Field Documentation

int Samp::active

Hub thread id

Referenced by samp_hubActive(), sampShutdown(), and sampStartup().

char Samp::appVer

application name

Referenced by samp_hubOpen(), samp_Metadata(), and samp_setAppVersion().

Client Samp::clients

number of subscriptions

Referenced by samp_addClient(), samp_app2id(), samp_envGet(), samp_id2app(), samp_listClients(), samp_mapClients(), samp_paramGet(), samp_removeClient(), samp_sendMsg(), and sampStartup().

int Samp::debug

log file descriptor

Referenced by samp_call(), samp_callAll(), samp_callAndWait(), samp_notifyAll(), sampDebug(), and sampLog().

int(* Samp::defaultUserFunc)(char *sender, char *msgid, Map map)	(	char *	sender,
		char *	msgid,
		Map	map
	)

server thread number default user handler

Referenced by samp_execUserHandler(), samp_getUserHandler(), samp_receiveCall(), samp_receiveNotification(), samp_receiveResponse(), and samp_setUserHandler().

char Samp::description

application version

Referenced by samp_getMetadata(), samp_hubOpen(), samp_Metadata(), and samp_printMetadata().

char Samp::errortxt

application description

Referenced by samp_call(), samp_callAll(), samp_callAndWait(), samp_envGet(), samp_getErr(), samp_GetMetadata(), samp_notifyAll(), samp_paramGet(), and samp_setErr().

int Samp::handlerMode

(a)synch message mode

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

Hub * Samp::hub

samp server port

Referenced by samp_bibLoad(), samp_call(), samp_callAll(), samp_callAndWait(), samp_cmdExec(), samp_coordPointAtSky(), samp_DeclareMetadata(), samp_DeclareSubscriptions(), samp_envGet(), samp_envSet(), samp_GetMetadata(), samp_GetRegisteredClients(), samp_GetSubscribedClients(), samp_imageLoadFITS(), samp_Metadata(), samp_notify(), samp_notifyAll(), samp_paramGet(), samp_paramSet(), samp_Ping(), samp_Register(), samp_Reply(), samp_resourceLoad(), samp_sendGeneric(), samp_setAppVersion(), samp_setTimeout(), samp_specLoadSSAGeneric(), samp_tableHighlightRow(), samp_tableLoadFITS(), samp_tableLoadVOTable(), samp_tableSelectRowList(), samp_UnRegister(), sampClose(), and sampStartup().

handle_t Samp::hubHandle

Hub connection

Referenced by sampClose(), sampShutdown(), and sampStartup().

int Samp::hubThreadID

Hub handle alias

FILE * Samp::logfd

CBR / CBV for user handlers

Referenced by sampLog().

int Samp::mapClients

is interface active

Referenced by sampStartup().

appMD Samp::meta

last msh error string

Referenced by samp_getMetadata(), samp_Metadata(), and samp_printMetadata().

int Samp::msgMode

map other clients

is interface active

Referenced by samp_sendMsg(), samp_setASyncMode(), samp_setCallMode(), samp_setMsgMode(), samp_setNotifyMode(), and samp_setSyncMode().

int Samp::nclients

samp clients

Referenced by samp_addClient(), samp_app2id(), samp_envGet(), samp_id2app(), samp_listClients(), samp_mapClients(), samp_paramGet(), samp_removeClient(), samp_sendMsg(), and sampStartup().

int Samp::nsubs

message subscriptions

Referenced by samp_getSampHandler(), samp_getUserHandler(), samp_hubDeclareSubscriptions(), samp_setSampHandler(), samp_setUserHandler(), samp_Subscribe(), and samp_Unsubscribe().

int Samp::serverPort

samp server threadId

int Samp::serverTid

number of samp clients

pthread_t Samp::svrThread

metadata

Referenced by sampShutdown().

int Samp::trace

verbose flag

debug flag

Referenced by samp_call(), samp_callAll(), samp_callAndWait(), samp_notifyAll(), samp_receiveCall(), samp_receiveNotification(), samp_receiveResponse(), sampStartup(), and sampTrace().

int Samp::verbose

debug flag

Referenced by sampClose(), sampDebug(), sampShutdown(), sampStartup(), and sampVerbose().

---

The documentation for this struct was generated from the following files:

• samp.h
• sampDecl.h