Hub Struct Reference

#include <samp.h>

Data Fields
char	appName [SZ_LINE]
char	appVer [SZ_LINE]
char	description [SZ_LINE]
appMD	meta
char	secret [SZ_SECRET]
char	url [SZ_URL]
char	version [SZ_NAME]
int	id
char	appId [SZ_NAME]
char	privateKey [SZ_LINE]
char	hubId [SZ_LINE]
char	selfId [SZ_LINE]
char	timeout [SZ_NAME]
void *	samp

---

Detailed Description

Hub description. Our application connects to this hub by default, but the structure will be valid for any Hub.

---

Field Documentation

char Hub::appId

Hub XML-RPC connection

Referenced by samp_hubOpen().

char Hub::appVer

application name

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

char Hub::description

application version

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

char Hub::hubId

client key value

Referenced by samp_hubRegister(), and samp_Register().

int Hub::id

Hub version string

Referenced by samp_call(), samp_callAll(), samp_callAndWait(), samp_envGet(), samp_GetMetadata(), samp_GetRegisteredClients(), samp_GetSubscribedClients(), samp_hubDeclareMetadata(), samp_hubDeclareSubscriptions(), samp_hubOpen(), samp_hubPing(), samp_hubRegister(), samp_hubSendShutdown(), samp_hubSetXmlrpcCallback(), samp_hubUnRegister(), samp_notify(), samp_notifyAll(), samp_paramGet(), samp_Register(), samp_Reply(), and sampStartup().

appMD Hub::meta

descriptive text

Referenced by samp_hubClose(), samp_hubDeclareMetadata(), samp_hubOpen(), and samp_Metadata().

char Hub::privateKey

client key

Referenced by samp_call(), samp_callAll(), samp_callAndWait(), samp_envGet(), samp_GetMetadata(), samp_GetRegisteredClients(), samp_GetSubscribedClients(), samp_hubDeclareMetadata(), samp_hubDeclareSubscriptions(), samp_hubPing(), samp_hubRegister(), samp_hubSendShutdown(), samp_hubSetXmlrpcCallback(), samp_hubUnRegister(), samp_notify(), samp_notifyAll(), samp_paramGet(), samp_Register(), and samp_Reply().

void * Hub::samp

Sync msg timeout (str)

Referenced by samp_hubDeclareSubscriptions(), and samp_hubOpen().

char Hub::secret

metadata

Referenced by samp_hubRegister(), and samp_Register().

char Hub::selfId

Hub id value

Referenced by samp_hubRegister(), and samp_Register().

char Hub::timeout

Client id value

Referenced by samp_callAndWait(), samp_envGet(), samp_hubOpen(), samp_paramGet(), and samp_setTimeout().

char Hub::url

registration string

Referenced by samp_hubOpen().

char Hub::version

Hub service endpoint

---

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

• samp.h
• sampDecl.h