diff options
Diffstat (limited to 'vendor/voclient/libsamp/doc')
72 files changed, 38888 insertions, 0 deletions
diff --git a/vendor/voclient/libsamp/doc/html/annotated.html b/vendor/voclient/libsamp/doc/html/annotated.html new file mode 100644 index 00000000..50be4f37 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/annotated.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Structures</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Data Structures</h1>Here are the data structures with brief descriptions:<table> + <tr><td class="indexkey"><a class="el" href="structappMD.html">appMD</a></td><td class="indexvalue"></td></tr> + <tr><td class="indexkey"><a class="el" href="structClient.html">Client</a></td><td class="indexvalue"></td></tr> + <tr><td class="indexkey"><a class="el" href="structHub.html">Hub</a></td><td class="indexvalue"></td></tr> + <tr><td class="indexkey"><a class="el" href="structSamp.html">Samp</a></td><td class="indexvalue"></td></tr> + <tr><td class="indexkey"><a class="el" href="structSubs.html">Subs</a></td><td class="indexvalue"></td></tr> +</table> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/classes.html b/vendor/voclient/libsamp/doc/html/classes.html new file mode 100644 index 00000000..6ce31513 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/classes.html @@ -0,0 +1,36 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Alphabetical List</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Data Structure Index</h1><p><div class="qindex"><a class="qindex" href="#letter_A">A</a> | <a class="qindex" href="#letter_C">C</a> | <a class="qindex" href="#letter_H">H</a> | <a class="qindex" href="#letter_S">S</a></div><p> +<table align="center" width="95%" border="0" cellspacing="0" cellpadding="0"> +<tr><td><a name="letter_A"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> A </div></td></tr></table> +</td><td><a name="letter_C"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> C </div></td></tr></table> +</td><td><a name="letter_H"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> H </div></td></tr></table> +</td><td><a name="letter_S"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> S </div></td></tr></table> +</td><td><a class="el" href="structSubs.html">Subs</a> </td></tr><tr><td><a class="el" href="structappMD.html">appMD</a> </td><td><a class="el" href="structClient.html">Client</a> </td><td><a class="el" href="structHub.html">Hub</a> </td><td><a class="el" href="structSamp.html">Samp</a> </td></tr></table><p><div class="qindex"><a class="qindex" href="#letter_A">A</a> | <a class="qindex" href="#letter_C">C</a> | <a class="qindex" href="#letter_H">H</a> | <a class="qindex" href="#letter_S">S</a></div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/doxygen.css b/vendor/voclient/libsamp/doc/html/doxygen.css new file mode 100644 index 00000000..3767dc95 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/doxygen.css @@ -0,0 +1,441 @@ +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + text-align: center; + font-size: 150%; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +/* @end */ + +caption { + font-weight: bold; +} + +div.qindex, div.navtab{ + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #153788; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #1b77c5; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { +} + +a.codeRef { +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + padding: 4px 6px; + margin: 4px 8px 4px 2px; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} + +td.indexkey { + background-color: #e8eef2; + font-weight: bold; + border: 1px solid #CCCCCC; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #e8eef2; + border: 1px solid #CCCCCC; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #f0f0f0; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} + +th.dirtab { + background: #e8eef2; + font-weight: bold; +} + +hr { + height: 0; + border: none; + border-top: 1px solid #666; +} + +/* @group Member Descriptions */ + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #FAFAFA; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #ccc; +} + +.memTemplParams { + color: #606060; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} + +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.memitem { + padding: 0; +} + +.memname { + white-space: nowrap; + font-weight: bold; +} + +.memproto, .memdoc { + border: 1px solid #84b0c7; +} + +.memproto { + padding: 0; + background-color: #d5e1e8; + font-weight: bold; + -webkit-border-top-left-radius: 8px; + -webkit-border-top-right-radius: 8px; + -moz-border-radius-topleft: 8px; + -moz-border-radius-topright: 8px; +} + +.memdoc { + padding: 2px 5px; + background-color: #eef3f5; + border-top-width: 0; + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0.5em; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +address { + font-style: normal; + color: #333; +} diff --git a/vendor/voclient/libsamp/doc/html/doxygen.png b/vendor/voclient/libsamp/doc/html/doxygen.png Binary files differnew file mode 100644 index 00000000..f0a274bb --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/doxygen.png diff --git a/vendor/voclient/libsamp/doc/html/files.html b/vendor/voclient/libsamp/doc/html/files.html new file mode 100644 index 00000000..cb9fd771 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/files.html @@ -0,0 +1,46 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: File Index</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table> + <tr><td class="indexkey"><a class="el" href="samp_8c.html">samp.c</a></td><td class="indexvalue">Top-level interface to the SAMP library </td></tr> + <tr><td class="indexkey"><a class="el" href="samp_8h.html">samp.h</a> <a href="samp_8h_source.html">[code]</a></td><td class="indexvalue">SAMP interface include file </td></tr> + <tr><td class="indexkey"><a class="el" href="sampClient_8c.html">sampClient.c</a></td><td class="indexvalue"><a class="el" href="structClient.html">Client</a> callable methods </td></tr> + <tr><td class="indexkey"><a class="el" href="sampCommands_8c.html">sampCommands.c</a></td><td class="indexvalue">SAMP commands used by app to send administrative messages </td></tr> + <tr><td class="indexkey"><a class="el" href="sampDecl_8h.html">sampDecl.h</a> <a href="sampDecl_8h_source.html">[code]</a></td><td class="indexvalue">SAMP interface method declarations </td></tr> + <tr><td class="indexkey"><a class="el" href="sampHandlers_8c.html">sampHandlers.c</a></td><td class="indexvalue">Message handlers for the interface </td></tr> + <tr><td class="indexkey"><a class="el" href="sampHub_8c.html">sampHub.c</a></td><td class="indexvalue">Methods related to the SAMP <a class="el" href="structHub.html">Hub</a> interface </td></tr> + <tr><td class="indexkey"><a class="el" href="sampList_8c.html">sampList.c</a></td><td class="indexvalue">(Internal) interface to support the List structure </td></tr> + <tr><td class="indexkey"><a class="el" href="sampLog_8c.html">sampLog.c</a></td><td class="indexvalue">SAMP trace and logging interface </td></tr> + <tr><td class="indexkey"><a class="el" href="sampMap_8c.html">sampMap.c</a></td><td class="indexvalue">(Internal) Interface to support the Map structure </td></tr> + <tr><td class="indexkey"><a class="el" href="sampMethods_8c.html">sampMethods.c</a></td><td class="indexvalue">SAMP methods implemented by a callable client </td></tr> + <tr><td class="indexkey"><a class="el" href="sampMsg_8c.html">sampMsg.c</a></td><td class="indexvalue">(Internal) Interface to Message objects </td></tr> + <tr><td class="indexkey"><a class="el" href="sampMTypes_8c.html">sampMTypes.c</a></td><td class="indexvalue">SAMP interface procedures for application mtypes </td></tr> + <tr><td class="indexkey"><a class="el" href="sampParam_8c.html">sampParam.c</a></td><td class="indexvalue">(Internal) Interface to Param objects </td></tr> + <tr><td class="indexkey"><a class="el" href="sampUtil_8c.html">sampUtil.c</a></td><td class="indexvalue">Utility methods to convert struct pointers to user handles </td></tr> +</table> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/functions.html b/vendor/voclient/libsamp/doc/html/functions.html new file mode 100644 index 00000000..fcce9c07 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/functions.html @@ -0,0 +1,170 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="functions.html"><span>All</span></a></li> + <li><a href="functions_vars.html"><span>Variables</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="#index_a"><span>a</span></a></li> + <li><a href="#index_c"><span>c</span></a></li> + <li><a href="#index_d"><span>d</span></a></li> + <li><a href="#index_e"><span>e</span></a></li> + <li><a href="#index_h"><span>h</span></a></li> + <li><a href="#index_i"><span>i</span></a></li> + <li><a href="#index_l"><span>l</span></a></li> + <li><a href="#index_m"><span>m</span></a></li> + <li><a href="#index_n"><span>n</span></a></li> + <li><a href="#index_p"><span>p</span></a></li> + <li><a href="#index_s"><span>s</span></a></li> + <li><a href="#index_t"><span>t</span></a></li> + <li><a href="#index_u"><span>u</span></a></li> + <li><a href="#index_v"><span>v</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all documented struct and union fields with links to the struct/union documentation for each field: +<p> +<h3><a class="anchor" name="index_a">- a -</a></h3><ul> +<li>active +: <a class="el" href="structSamp.html#32402da48b11693c13252edbdca7673c">Samp</a> +<li>aKey +: <a class="el" href="structappMD.html#cf4d62dbfeb28cb8c503d6a4d1598a8d">appMD</a> +<li>appId +: <a class="el" href="structHub.html#83ae1eed61525e4dd8795d7076b9a844">Hub</a> +<li>appVer +: <a class="el" href="structHub.html#b6cbad1270ab46610f03837d4a01648f">Hub</a> +, <a class="el" href="structSamp.html#df7c497b6dbffc08e8ef5d7edd4ee97e">Samp</a> +<li>aVal +: <a class="el" href="structappMD.html#13ae9876a351aee3fe5b861733aff77a">appMD</a> +</ul> +<h3><a class="anchor" name="index_c">- c -</a></h3><ul> +<li>clients +: <a class="el" href="structSamp.html#2cc1f00b9e4bae456e0e72b90147df7b">Samp</a> +</ul> +<h3><a class="anchor" name="index_d">- d -</a></h3><ul> +<li>debug +: <a class="el" href="structSamp.html#d8469d2447cd872101fb83d92f85049e">Samp</a> +<li>defaultUserFunc +: <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp</a> +<li>desc +: <a class="el" href="structappMD.html#fe527cb05f296f8e8b8144bf444beffd">appMD</a> +<li>descHTML +: <a class="el" href="structappMD.html#652f4b568b3de167fa0886613c8c6656">appMD</a> +<li>description +: <a class="el" href="structHub.html#d96b607b83480697b7147f95f84132fb">Hub</a> +, <a class="el" href="structSamp.html#d672d7d425e8180b93c7ca2229d1acd8">Samp</a> +<li>docURL +: <a class="el" href="structappMD.html#53945cba18e159fcdd4fb627b1d1d312">appMD</a> +</ul> +<h3><a class="anchor" name="index_e">- e -</a></h3><ul> +<li>errortxt +: <a class="el" href="structSamp.html#62629ad2155a2a1a7676e32ef9fb9ffd">Samp</a> +</ul> +<h3><a class="anchor" name="index_h">- h -</a></h3><ul> +<li>handlerMode +: <a class="el" href="structSamp.html#14f6ed59a947504d37bd8cdd1f2f8e8d">Samp</a> +<li>hub +: <a class="el" href="structSamp.html#14811ec2253a6e2e75a8ec863c4150b0">Samp</a> +<li>hubHandle +: <a class="el" href="structSamp.html#03918136809ece7e60de4e30c64b6224">Samp</a> +<li>hubId +: <a class="el" href="structHub.html#c5ecb8cd6b3d61ab9e0fddfb643c65c3">Hub</a> +<li>hubThreadID +: <a class="el" href="structSamp.html#723b2538cfd65122c49783b36a7d30b5">Samp</a> +</ul> +<h3><a class="anchor" name="index_i">- i -</a></h3><ul> +<li>iconURL +: <a class="el" href="structappMD.html#8ff19215559267a838fe300ca4f743a7">appMD</a> +<li>id +: <a class="el" href="structHub.html#3546ac45740591096b9bdc4c37b8d5f5">Hub</a> +</ul> +<h3><a class="anchor" name="index_l">- l -</a></h3><ul> +<li>logfd +: <a class="el" href="structSamp.html#79f2ee1f48cb40edaf9b63ccdbb6942f">Samp</a> +</ul> +<h3><a class="anchor" name="index_m">- m -</a></h3><ul> +<li>mapClients +: <a class="el" href="structSamp.html#c8eee2b56f226f59d814fd1baa751b77">Samp</a> +<li>meta +: <a class="el" href="structHub.html#cfe9051f3f0d6fd908ddf394283d1262">Hub</a> +, <a class="el" href="structSamp.html#0884021074d1ed14342187005e0b78e7">Samp</a> +<li>msgMode +: <a class="el" href="structSamp.html#30ca22535582e7bf6416627d1cd46525">Samp</a> +</ul> +<h3><a class="anchor" name="index_n">- n -</a></h3><ul> +<li>name +: <a class="el" href="structClient.html#67f4b49f5eda3f6cf1ff33a6fe883bf6">Client</a> +<li>nclients +: <a class="el" href="structSamp.html#97ef8ad57159f4b6c4fcd93a12853b69">Samp</a> +<li>nkeys +: <a class="el" href="structappMD.html#4b9f5ebb7d20beb53a7bfe192009e89a">appMD</a> +<li>nsubs +: <a class="el" href="structSamp.html#36f4cfae3407b8961e57a77abca7d599">Samp</a> +</ul> +<h3><a class="anchor" name="index_p">- p -</a></h3><ul> +<li>privateKey +: <a class="el" href="structHub.html#53b0a5acf4419ffff98c6510e84a9f62">Hub</a> +</ul> +<h3><a class="anchor" name="index_s">- s -</a></h3><ul> +<li>samp +: <a class="el" href="structHub.html#cfd1b13e1f462d6595ce4e0b5ab08cb9">Hub</a> +<li>sampFunc +: <a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">Subs</a> +<li>secret +: <a class="el" href="structHub.html#52a6b65f54e98c4f3b7441808e30fa6c">Hub</a> +<li>selfId +: <a class="el" href="structHub.html#ce254c7adba1a20deb1dff7e112dd2a8">Hub</a> +<li>serverPort +: <a class="el" href="structSamp.html#8849cb13cbedae805b4e35327bc449e2">Samp</a> +<li>serverTid +: <a class="el" href="structSamp.html#69b05b2fa1ab19729d81659ad64387a0">Samp</a> +<li>svrThread +: <a class="el" href="structSamp.html#e7db0cac0c4ad61c9ed7f3d344b623cf">Samp</a> +</ul> +<h3><a class="anchor" name="index_t">- t -</a></h3><ul> +<li>timeout +: <a class="el" href="structHub.html#b69adb014b0cef61d6632e60fb2dff5b">Hub</a> +<li>trace +: <a class="el" href="structSamp.html#25ddaf846639c7c67ea651a578b804ad">Samp</a> +</ul> +<h3><a class="anchor" name="index_u">- u -</a></h3><ul> +<li>url +: <a class="el" href="structHub.html#81adb6d0cab27f61c0aaebbb7b7685e4">Hub</a> +<li>userFunc +: <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs</a> +</ul> +<h3><a class="anchor" name="index_v">- v -</a></h3><ul> +<li>verbose +: <a class="el" href="structSamp.html#981b01bd09deddb039db3567825bd653">Samp</a> +<li>version +: <a class="el" href="structHub.html#0e07ef26e39ed1282042364297591df5">Hub</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/functions_vars.html b/vendor/voclient/libsamp/doc/html/functions_vars.html new file mode 100644 index 00000000..6d72cb8e --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/functions_vars.html @@ -0,0 +1,170 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields - Variables</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="functions.html"><span>All</span></a></li> + <li class="current"><a href="functions_vars.html"><span>Variables</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="#index_a"><span>a</span></a></li> + <li><a href="#index_c"><span>c</span></a></li> + <li><a href="#index_d"><span>d</span></a></li> + <li><a href="#index_e"><span>e</span></a></li> + <li><a href="#index_h"><span>h</span></a></li> + <li><a href="#index_i"><span>i</span></a></li> + <li><a href="#index_l"><span>l</span></a></li> + <li><a href="#index_m"><span>m</span></a></li> + <li><a href="#index_n"><span>n</span></a></li> + <li><a href="#index_p"><span>p</span></a></li> + <li><a href="#index_s"><span>s</span></a></li> + <li><a href="#index_t"><span>t</span></a></li> + <li><a href="#index_u"><span>u</span></a></li> + <li><a href="#index_v"><span>v</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<h3><a class="anchor" name="index_a">- a -</a></h3><ul> +<li>active +: <a class="el" href="structSamp.html#32402da48b11693c13252edbdca7673c">Samp</a> +<li>aKey +: <a class="el" href="structappMD.html#cf4d62dbfeb28cb8c503d6a4d1598a8d">appMD</a> +<li>appId +: <a class="el" href="structHub.html#83ae1eed61525e4dd8795d7076b9a844">Hub</a> +<li>appVer +: <a class="el" href="structHub.html#b6cbad1270ab46610f03837d4a01648f">Hub</a> +, <a class="el" href="structSamp.html#df7c497b6dbffc08e8ef5d7edd4ee97e">Samp</a> +<li>aVal +: <a class="el" href="structappMD.html#13ae9876a351aee3fe5b861733aff77a">appMD</a> +</ul> +<h3><a class="anchor" name="index_c">- c -</a></h3><ul> +<li>clients +: <a class="el" href="structSamp.html#2cc1f00b9e4bae456e0e72b90147df7b">Samp</a> +</ul> +<h3><a class="anchor" name="index_d">- d -</a></h3><ul> +<li>debug +: <a class="el" href="structSamp.html#d8469d2447cd872101fb83d92f85049e">Samp</a> +<li>defaultUserFunc +: <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp</a> +<li>desc +: <a class="el" href="structappMD.html#fe527cb05f296f8e8b8144bf444beffd">appMD</a> +<li>descHTML +: <a class="el" href="structappMD.html#652f4b568b3de167fa0886613c8c6656">appMD</a> +<li>description +: <a class="el" href="structHub.html#d96b607b83480697b7147f95f84132fb">Hub</a> +, <a class="el" href="structSamp.html#d672d7d425e8180b93c7ca2229d1acd8">Samp</a> +<li>docURL +: <a class="el" href="structappMD.html#53945cba18e159fcdd4fb627b1d1d312">appMD</a> +</ul> +<h3><a class="anchor" name="index_e">- e -</a></h3><ul> +<li>errortxt +: <a class="el" href="structSamp.html#62629ad2155a2a1a7676e32ef9fb9ffd">Samp</a> +</ul> +<h3><a class="anchor" name="index_h">- h -</a></h3><ul> +<li>handlerMode +: <a class="el" href="structSamp.html#14f6ed59a947504d37bd8cdd1f2f8e8d">Samp</a> +<li>hub +: <a class="el" href="structSamp.html#14811ec2253a6e2e75a8ec863c4150b0">Samp</a> +<li>hubHandle +: <a class="el" href="structSamp.html#03918136809ece7e60de4e30c64b6224">Samp</a> +<li>hubId +: <a class="el" href="structHub.html#c5ecb8cd6b3d61ab9e0fddfb643c65c3">Hub</a> +<li>hubThreadID +: <a class="el" href="structSamp.html#723b2538cfd65122c49783b36a7d30b5">Samp</a> +</ul> +<h3><a class="anchor" name="index_i">- i -</a></h3><ul> +<li>iconURL +: <a class="el" href="structappMD.html#8ff19215559267a838fe300ca4f743a7">appMD</a> +<li>id +: <a class="el" href="structHub.html#3546ac45740591096b9bdc4c37b8d5f5">Hub</a> +</ul> +<h3><a class="anchor" name="index_l">- l -</a></h3><ul> +<li>logfd +: <a class="el" href="structSamp.html#79f2ee1f48cb40edaf9b63ccdbb6942f">Samp</a> +</ul> +<h3><a class="anchor" name="index_m">- m -</a></h3><ul> +<li>mapClients +: <a class="el" href="structSamp.html#c8eee2b56f226f59d814fd1baa751b77">Samp</a> +<li>meta +: <a class="el" href="structHub.html#cfe9051f3f0d6fd908ddf394283d1262">Hub</a> +, <a class="el" href="structSamp.html#0884021074d1ed14342187005e0b78e7">Samp</a> +<li>msgMode +: <a class="el" href="structSamp.html#30ca22535582e7bf6416627d1cd46525">Samp</a> +</ul> +<h3><a class="anchor" name="index_n">- n -</a></h3><ul> +<li>name +: <a class="el" href="structClient.html#67f4b49f5eda3f6cf1ff33a6fe883bf6">Client</a> +<li>nclients +: <a class="el" href="structSamp.html#97ef8ad57159f4b6c4fcd93a12853b69">Samp</a> +<li>nkeys +: <a class="el" href="structappMD.html#4b9f5ebb7d20beb53a7bfe192009e89a">appMD</a> +<li>nsubs +: <a class="el" href="structSamp.html#36f4cfae3407b8961e57a77abca7d599">Samp</a> +</ul> +<h3><a class="anchor" name="index_p">- p -</a></h3><ul> +<li>privateKey +: <a class="el" href="structHub.html#53b0a5acf4419ffff98c6510e84a9f62">Hub</a> +</ul> +<h3><a class="anchor" name="index_s">- s -</a></h3><ul> +<li>samp +: <a class="el" href="structHub.html#cfd1b13e1f462d6595ce4e0b5ab08cb9">Hub</a> +<li>sampFunc +: <a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">Subs</a> +<li>secret +: <a class="el" href="structHub.html#52a6b65f54e98c4f3b7441808e30fa6c">Hub</a> +<li>selfId +: <a class="el" href="structHub.html#ce254c7adba1a20deb1dff7e112dd2a8">Hub</a> +<li>serverPort +: <a class="el" href="structSamp.html#8849cb13cbedae805b4e35327bc449e2">Samp</a> +<li>serverTid +: <a class="el" href="structSamp.html#69b05b2fa1ab19729d81659ad64387a0">Samp</a> +<li>svrThread +: <a class="el" href="structSamp.html#e7db0cac0c4ad61c9ed7f3d344b623cf">Samp</a> +</ul> +<h3><a class="anchor" name="index_t">- t -</a></h3><ul> +<li>timeout +: <a class="el" href="structHub.html#b69adb014b0cef61d6632e60fb2dff5b">Hub</a> +<li>trace +: <a class="el" href="structSamp.html#25ddaf846639c7c67ea651a578b804ad">Samp</a> +</ul> +<h3><a class="anchor" name="index_u">- u -</a></h3><ul> +<li>url +: <a class="el" href="structHub.html#81adb6d0cab27f61c0aaebbb7b7685e4">Hub</a> +<li>userFunc +: <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs</a> +</ul> +<h3><a class="anchor" name="index_v">- v -</a></h3><ul> +<li>verbose +: <a class="el" href="structSamp.html#981b01bd09deddb039db3567825bd653">Samp</a> +<li>version +: <a class="el" href="structHub.html#0e07ef26e39ed1282042364297591df5">Hub</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals.html b/vendor/voclient/libsamp/doc/html/globals.html new file mode 100644 index 00000000..8e0c8d64 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html#index_h"><span>h</span></a></li> + <li><a href="globals_0x6c.html#index_l"><span>l</span></a></li> + <li><a href="globals_0x6d.html#index_m"><span>m</span></a></li> + <li><a href="globals_0x6e.html#index_n"><span>n</span></a></li> + <li><a href="globals_0x6f.html#index_o"><span>o</span></a></li> + <li><a href="globals_0x70.html#index_p"><span>p</span></a></li> + <li><a href="globals_0x73.html#index_s"><span>s</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +<p> +<h3><a class="anchor" name="index_h">- h -</a></h3><ul> +<li>hub +: <a class="el" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">samp.c</a> +, <a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">sampHub.c</a> +<li>HUB_SHUTDOWN +: <a class="el" href="samp_8h.html#fc367e0d449c3afa2d429eedc85407aa">samp.h</a> +<li>hubHandles +: <a class="el" href="samp_8c.html#dbf72aff0293f6556c1c6a2f4a62e2b9">samp.c</a> +, <a class="el" href="sampHub_8c.html#86b0db44d25bc3079d8d9d75e01a0ecd">sampHub.c</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_0x6c.html b/vendor/voclient/libsamp/doc/html/globals_0x6c.html new file mode 100644 index 00000000..8bfefc64 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_0x6c.html @@ -0,0 +1,56 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html#index_h"><span>h</span></a></li> + <li class="current"><a href="globals_0x6c.html#index_l"><span>l</span></a></li> + <li><a href="globals_0x6d.html#index_m"><span>m</span></a></li> + <li><a href="globals_0x6e.html#index_n"><span>n</span></a></li> + <li><a href="globals_0x6f.html#index_o"><span>o</span></a></li> + <li><a href="globals_0x70.html#index_p"><span>p</span></a></li> + <li><a href="globals_0x73.html#index_s"><span>s</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +<p> +<h3><a class="anchor" name="index_l">- l -</a></h3><ul> +<li>List +: <a class="el" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">samp.h</a> +, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">sampDecl.h</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_0x6d.html b/vendor/voclient/libsamp/doc/html/globals_0x6d.html new file mode 100644 index 00000000..8e11ad5f --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_0x6d.html @@ -0,0 +1,59 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html#index_h"><span>h</span></a></li> + <li><a href="globals_0x6c.html#index_l"><span>l</span></a></li> + <li class="current"><a href="globals_0x6d.html#index_m"><span>m</span></a></li> + <li><a href="globals_0x6e.html#index_n"><span>n</span></a></li> + <li><a href="globals_0x6f.html#index_o"><span>o</span></a></li> + <li><a href="globals_0x70.html#index_p"><span>p</span></a></li> + <li><a href="globals_0x73.html#index_s"><span>s</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +<p> +<h3><a class="anchor" name="index_m">- m -</a></h3><ul> +<li>Map +: <a class="el" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">samp.h</a> +, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">sampDecl.h</a> +<li>Msg +: <a class="el" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">sampDecl.h</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_0x6e.html b/vendor/voclient/libsamp/doc/html/globals_0x6e.html new file mode 100644 index 00000000..3d4bdbf9 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_0x6e.html @@ -0,0 +1,65 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html#index_h"><span>h</span></a></li> + <li><a href="globals_0x6c.html#index_l"><span>l</span></a></li> + <li><a href="globals_0x6d.html#index_m"><span>m</span></a></li> + <li class="current"><a href="globals_0x6e.html#index_n"><span>n</span></a></li> + <li><a href="globals_0x6f.html#index_o"><span>o</span></a></li> + <li><a href="globals_0x70.html#index_p"><span>p</span></a></li> + <li><a href="globals_0x73.html#index_s"><span>s</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +<p> +<h3><a class="anchor" name="index_n">- n -</a></h3><ul> +<li>nullList +: <a class="el" href="samp_8c.html#a2106c7fe3a5747178c046238fbd5d55">samp.c</a> +, <a class="el" href="sampHandlers_8c.html#a2106c7fe3a5747178c046238fbd5d55">sampHandlers.c</a> +, <a class="el" href="sampMethods_8c.html#a2106c7fe3a5747178c046238fbd5d55">sampMethods.c</a> +<li>nullMap +: <a class="el" href="sampMethods_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">sampMethods.c</a> +, <a class="el" href="samp_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">samp.c</a> +, <a class="el" href="sampHandlers_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">sampHandlers.c</a> +, <a class="el" href="sampHub_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">sampHub.c</a> +<li>numHubs +: <a class="el" href="sampHub_8c.html#037f00cb1101b007b4bf45e8bee1bd3e">sampHub.c</a> +, <a class="el" href="samp_8c.html#037f00cb1101b007b4bf45e8bee1bd3e">samp.c</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_0x6f.html b/vendor/voclient/libsamp/doc/html/globals_0x6f.html new file mode 100644 index 00000000..9b6f518f --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_0x6f.html @@ -0,0 +1,55 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html#index_h"><span>h</span></a></li> + <li><a href="globals_0x6c.html#index_l"><span>l</span></a></li> + <li><a href="globals_0x6d.html#index_m"><span>m</span></a></li> + <li><a href="globals_0x6e.html#index_n"><span>n</span></a></li> + <li class="current"><a href="globals_0x6f.html#index_o"><span>o</span></a></li> + <li><a href="globals_0x70.html#index_p"><span>p</span></a></li> + <li><a href="globals_0x73.html#index_s"><span>s</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +<p> +<h3><a class="anchor" name="index_o">- o -</a></h3><ul> +<li>OK_Map +: <a class="el" href="samp_8c.html#a68efe925f0d8f29fa203c0f3747a6e2">samp.c</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_0x70.html b/vendor/voclient/libsamp/doc/html/globals_0x70.html new file mode 100644 index 00000000..e8e3097e --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_0x70.html @@ -0,0 +1,56 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html#index_h"><span>h</span></a></li> + <li><a href="globals_0x6c.html#index_l"><span>l</span></a></li> + <li><a href="globals_0x6d.html#index_m"><span>m</span></a></li> + <li><a href="globals_0x6e.html#index_n"><span>n</span></a></li> + <li><a href="globals_0x6f.html#index_o"><span>o</span></a></li> + <li class="current"><a href="globals_0x70.html#index_p"><span>p</span></a></li> + <li><a href="globals_0x73.html#index_s"><span>s</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +<p> +<h3><a class="anchor" name="index_p">- p -</a></h3><ul> +<li>Param +: <a class="el" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">samp.h</a> +, <a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">sampDecl.h</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_0x73.html b/vendor/voclient/libsamp/doc/html/globals_0x73.html new file mode 100644 index 00000000..96e37b25 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_0x73.html @@ -0,0 +1,671 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html#index_h"><span>h</span></a></li> + <li><a href="globals_0x6c.html#index_l"><span>l</span></a></li> + <li><a href="globals_0x6d.html#index_m"><span>m</span></a></li> + <li><a href="globals_0x6e.html#index_n"><span>n</span></a></li> + <li><a href="globals_0x6f.html#index_o"><span>o</span></a></li> + <li><a href="globals_0x70.html#index_p"><span>p</span></a></li> + <li class="current"><a href="globals_0x73.html#index_s"><span>s</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +<p> +<h3><a class="anchor" name="index_s">- s -</a></h3><ul> +<li>samp_addClient() +: <a class="el" href="samp_8c.html#8a2111bbe4c88cef635e3bf67e899563">samp.c</a> +, <a class="el" href="samp_8h.html#8a2111bbe4c88cef635e3bf67e899563">samp.h</a> +, <a class="el" href="sampDecl_8h.html#8a2111bbe4c88cef635e3bf67e899563">sampDecl.h</a> +<li>samp_addFloatParam() +: <a class="el" href="samp_8h.html#d297770f4ab1338697d69b2705d6c1d9">samp.h</a> +, <a class="el" href="sampDecl_8h.html#d297770f4ab1338697d69b2705d6c1d9">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#d297770f4ab1338697d69b2705d6c1d9">sampParam.c</a> +<li>samp_addIntParam() +: <a class="el" href="sampDecl_8h.html#6897da75444209fc1819042bde906aa6">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#6897da75444209fc1819042bde906aa6">sampParam.c</a> +, <a class="el" href="samp_8h.html#6897da75444209fc1819042bde906aa6">samp.h</a> +<li>samp_addListParam() +: <a class="el" href="samp_8h.html#24f72c4ed033ed2f219b420e491b3c0f">samp.h</a> +, <a class="el" href="sampDecl_8h.html#24f72c4ed033ed2f219b420e491b3c0f">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#24f72c4ed033ed2f219b420e491b3c0f">sampParam.c</a> +<li>samp_addMapParam() +: <a class="el" href="samp_8h.html#e3e90c84dd6b1a08d8af18ca9e168b37">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e3e90c84dd6b1a08d8af18ca9e168b37">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#e3e90c84dd6b1a08d8af18ca9e168b37">sampParam.c</a> +<li>samp_app2id() +: <a class="el" href="samp_8h.html#5e555288172e59ccf28c901c6bc10793">samp.h</a> +, <a class="el" href="sampDecl_8h.html#aed9017996a8361f8abf5b5c6a954414">sampDecl.h</a> +, <a class="el" href="sampUtil_8c.html#aed9017996a8361f8abf5b5c6a954414">sampUtil.c</a> +<li>samp_bibcodeHandler() +: <a class="el" href="samp_8h.html#262bf09278c61b60b5189fef7f26d26b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#262bf09278c61b60b5189fef7f26d26b">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#262bf09278c61b60b5189fef7f26d26b">sampHandlers.c</a> +<li>samp_bibLoad() +: <a class="el" href="samp_8h.html#abeaa1ac9d09a666a9fa34a7d274483d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#ae7f51c1f6169b918568a1202d0fa031">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#ae7f51c1f6169b918568a1202d0fa031">sampMTypes.c</a> +<li>samp_call() +: <a class="el" href="samp_8h.html#919cca4cfc557e0c05914b805401fbd3">samp.h</a> +, <a class="el" href="sampClient_8c.html#68d7703657197a3d9256729cf2971033">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#77f32922cfe662f4b423b678ba09513c">sampDecl.h</a> +<li>samp_callAll() +: <a class="el" href="samp_8h.html#2cbf26c662884a4ae9587f7b9f4113a6">samp.h</a> +, <a class="el" href="sampClient_8c.html#66d67a1ba0dff1f6dab68f74299f500a">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#66d67a1ba0dff1f6dab68f74299f500a">sampDecl.h</a> +<li>samp_callAndWait() +: <a class="el" href="sampClient_8c.html#6780568b9e9dfae5b361c2b2e52c16ed">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#6780568b9e9dfae5b361c2b2e52c16ed">sampDecl.h</a> +, <a class="el" href="samp_8h.html#c69c39e8ee091c006289b486dee10711">samp.h</a> +<li>samp_clientName() +: <a class="el" href="samp_8h.html#0a61726448d9b1a026b20ff6beead44e">samp.h</a> +, <a class="el" href="sampClient_8c.html#0a996f4e24693c2eacba579ecbceedbb">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#0a996f4e24693c2eacba579ecbceedbb">sampDecl.h</a> +<li>samp_cmdExec() +: <a class="el" href="samp_8h.html#be012673358bfd254e2c6ad9f6e92240">samp.h</a> +, <a class="el" href="sampDecl_8h.html#5900317c1609ddd5b6da70dc0eb2040c">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#5900317c1609ddd5b6da70dc0eb2040c">sampMTypes.c</a> +<li>samp_cmdExecHandler() +: <a class="el" href="samp_8h.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b">sampHandlers.c</a> +<li>samp_coordPointAtSky() +: <a class="el" href="samp_8h.html#0651eec8ddc8707bb8fbc4dfdcfff5e2">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e1e86e79d9a1768e5f265cbb44279172">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#e1e86e79d9a1768e5f265cbb44279172">sampMTypes.c</a> +<li>samp_DeclareMetadata() +: <a class="el" href="samp_8h.html#94cdccbcfa524fa515de77544b6c6eaa">samp.h</a> +, <a class="el" href="sampCommands_8c.html#9c6024ae76103069355256c29ee22722">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#9c6024ae76103069355256c29ee22722">sampDecl.h</a> +<li>samp_DeclareSubscriptions() +: <a class="el" href="samp_8h.html#ef695801c121c6191d3af4574569ab8c">samp.h</a> +, <a class="el" href="sampCommands_8c.html#d2b0bdea58688142f55faeffcfc65525">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#d2b0bdea58688142f55faeffcfc65525">sampDecl.h</a> +<li>samp_defaultReplyHandler() +: <a class="el" href="samp_8c.html#114bf9fb0d3e6eabd8bb93f3c87f5233">samp.c</a> +, <a class="el" href="samp_8h.html#96851f1c15e4baf67949d86d15f2568d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#96851f1c15e4baf67949d86d15f2568d">sampDecl.h</a> +<li>samp_envGet() +: <a class="el" href="samp_8h.html#ba313c7608a7658c673065c83113ec5b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#9c64fef9c158d7fd4ff7f72691ccd319">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#9c64fef9c158d7fd4ff7f72691ccd319">sampMTypes.c</a> +<li>samp_envGetHandler() +: <a class="el" href="samp_8h.html#e25a92f57babd71d43653d7fcb81025c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e25a92f57babd71d43653d7fcb81025c">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#e25a92f57babd71d43653d7fcb81025c">sampHandlers.c</a> +<li>samp_envSet() +: <a class="el" href="samp_8h.html#e842347910a3cfd746def74b0fd564aa">samp.h</a> +, <a class="el" href="sampDecl_8h.html#ded4b8bdac87c5b6faa7f13d8abb22a1">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#ded4b8bdac87c5b6faa7f13d8abb22a1">sampMTypes.c</a> +<li>samp_envSetHandler() +: <a class="el" href="samp_8h.html#0910e6b9d11cdd3111c1f18450de394a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#0910e6b9d11cdd3111c1f18450de394a">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#0910e6b9d11cdd3111c1f18450de394a">sampHandlers.c</a> +<li>samp_execUserHandler() +: <a class="el" href="samp_8h.html#e09217f0e615e01dfcffbdebda2516e8">samp.h</a> +, <a class="el" href="sampDecl_8h.html#979664bde900a1e1bf7bc499dc92898e">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#23644999b70eebfe75f52c465d1ed97f">sampHandlers.c</a> +<li>samp_freeHandle() +: <a class="el" href="samp_8h.html#f02a7c646a9ed56e545d8bf33434c207">samp.h</a> +<li>samp_freeList() +: <a class="el" href="samp_8h.html#b162ae9b9f98da80f6bb5c34b5cbcbf6">samp.h</a> +, <a class="el" href="sampDecl_8h.html#b162ae9b9f98da80f6bb5c34b5cbcbf6">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#b162ae9b9f98da80f6bb5c34b5cbcbf6">sampList.c</a> +<li>samp_freeMap() +: <a class="el" href="samp_8h.html#fe80438de542c6657d623993360b37d1">samp.h</a> +, <a class="el" href="sampDecl_8h.html#fe80438de542c6657d623993360b37d1">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#fe80438de542c6657d623993360b37d1">sampMap.c</a> +<li>samp_freeMsg() +: <a class="el" href="samp_8h.html#adf2979a5fad0c9a855740330b7fd9ce">samp.h</a> +, <a class="el" href="sampDecl_8h.html#adf2979a5fad0c9a855740330b7fd9ce">sampDecl.h</a> +, <a class="el" href="sampMsg_8c.html#adf2979a5fad0c9a855740330b7fd9ce">sampMsg.c</a> +<li>samp_freeParam() +: <a class="el" href="samp_8h.html#5a6fbf3ac37164268afae80c35666c5e">samp.h</a> +, <a class="el" href="sampDecl_8h.html#5a6fbf3ac37164268afae80c35666c5e">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#5a6fbf3ac37164268afae80c35666c5e">sampParam.c</a> +<li>samp_getAvailableHubs() +: <a class="el" href="samp_8h.html#d0343ad884d5a958d7d91928ad06a369">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e792eedc70daa9b2d010ca6cd8e57fe8">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#e792eedc70daa9b2d010ca6cd8e57fe8">sampHub.c</a> +<li>samp_getErr() +: <a class="el" href="samp_8h.html#fd8a4da020cd2fedaf70ae8af0b6a1c8">samp.h</a> +, <a class="el" href="sampClient_8c.html#4946a754670217dbdbc83cca92217022">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#4946a754670217dbdbc83cca92217022">sampDecl.h</a> +<li>samp_getFloatFromList() +: <a class="el" href="samp_8h.html#cf9b570dd76203d2299ed7bdba048bb9">samp.h</a> +, <a class="el" href="sampDecl_8h.html#4e8339b2b3f5ff1a58cebb74eddca9e6">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#4e8339b2b3f5ff1a58cebb74eddca9e6">sampList.c</a> +<li>samp_getFloatFromMap() +: <a class="el" href="samp_8h.html#89c38f762afd50c85f6ff659bdf0a923">samp.h</a> +, <a class="el" href="sampDecl_8h.html#b0d3768990294554a298c4057b3b315d">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#b0d3768990294554a298c4057b3b315d">sampMap.c</a> +<li>samp_getHandlerReply() +: <a class="el" href="samp_8h.html#0a0d9e41bebb554869f099dcf142a7bf">samp.h</a> +, <a class="el" href="sampMethods_8c.html#eebed5000d39977556e0bc330a020915">sampMethods.c</a> +<li>samp_getIntFromMap() +: <a class="el" href="samp_8h.html#594a51772e9b0693a3c77006eb88c96a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#210fc0eba30abddf1bdc2e780d58072c">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#210fc0eba30abddf1bdc2e780d58072c">sampMap.c</a> +<li>samp_getListFromList() +: <a class="el" href="samp_8h.html#b74e90fdfe79b1c4f7668fdb28d041a1">samp.h</a> +, <a class="el" href="sampDecl_8h.html#1ec1ddadb4e889792b6fa7df6f6c3125">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#1ec1ddadb4e889792b6fa7df6f6c3125">sampList.c</a> +<li>samp_getListFromMap() +: <a class="el" href="samp_8h.html#31ddb90cf2184ae0151b9e7ec8c1a51f">samp.h</a> +, <a class="el" href="sampDecl_8h.html#31ddb90cf2184ae0151b9e7ec8c1a51f">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#31ddb90cf2184ae0151b9e7ec8c1a51f">sampMap.c</a> +<li>samp_getMapFromList() +: <a class="el" href="samp_8h.html#33ca96ee3a8e7d26356c7b66f469da74">samp.h</a> +, <a class="el" href="sampDecl_8h.html#33ca96ee3a8e7d26356c7b66f469da74">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#33ca96ee3a8e7d26356c7b66f469da74">sampList.c</a> +<li>samp_getMapFromMap() +: <a class="el" href="samp_8h.html#525e8ffdfa32867f392f2c1340215453">samp.h</a> +, <a class="el" href="sampDecl_8h.html#525e8ffdfa32867f392f2c1340215453">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#525e8ffdfa32867f392f2c1340215453">sampMap.c</a> +<li>samp_GetMetadata() +: <a class="el" href="samp_8h.html#636e11796b78ae9881e7c61df8516d2a">samp.h</a> +, <a class="el" href="sampCommands_8c.html#2ac4b5c50094c394a74f18d6ebe3cd91">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#2ac4b5c50094c394a74f18d6ebe3cd91">sampDecl.h</a> +<li>samp_getMetadata() +: <a class="el" href="samp_8h.html#def0598aa30c5c1a2276cdddf705de69">samp.h</a> +, <a class="el" href="sampDecl_8h.html#f9622190e1976c42efebd30f0c51cfe4">sampDecl.h</a> +, <a class="el" href="sampUtil_8c.html#ed777ec70a7f11254f04a2ee11be391b">sampUtil.c</a> +<li>samp_getNullMap() +: <a class="el" href="samp_8c.html#6bb8b1f5c6268ad8c7f165733d4af86d">samp.c</a> +, <a class="el" href="samp_8h.html#27baec44edb57136951b5f86ae893246">samp.h</a> +, <a class="el" href="sampDecl_8h.html#27baec44edb57136951b5f86ae893246">sampDecl.h</a> +<li>samp_getOKMap() +: <a class="el" href="samp_8c.html#f299ea13607279f60f16b8639a00658f">samp.c</a> +, <a class="el" href="samp_8h.html#cbf9b52550a9ab0b3515c32e692c46fb">samp.h</a> +, <a class="el" href="sampDecl_8h.html#cbf9b52550a9ab0b3515c32e692c46fb">sampDecl.h</a> +<li>samp_GetRegisteredClients() +: <a class="el" href="samp_8h.html#2c532e076dd6446f079691ed02197a57">samp.h</a> +, <a class="el" href="sampCommands_8c.html#954712a523e3f86826b4711abd35b165">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#954712a523e3f86826b4711abd35b165">sampDecl.h</a> +<li>samp_getSampHandler() +: <a class="el" href="sampDecl_8h.html#6ef18dbc5870f58d2161c9ba03a81d26">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#6ef18dbc5870f58d2161c9ba03a81d26">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#f295f9e7746644f834ac54b1deb95b4c">samp.h</a> +<li>samp_getStringFromList() +: <a class="el" href="samp_8h.html#b101c5b1175490474e41ac9060bdaabf">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2d1cd41c4583ac300aaa2d50ad3f76ed">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#2d1cd41c4583ac300aaa2d50ad3f76ed">sampList.c</a> +<li>samp_getStringFromMap() +: <a class="el" href="samp_8h.html#e615ad9482fa88705b2488a37c987c2a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#96ca606e0e7da659c3dc0a30846bcd66">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#96ca606e0e7da659c3dc0a30846bcd66">sampMap.c</a> +<li>samp_GetSubscribedClients() +: <a class="el" href="samp_8h.html#d28a9085ab8cacbe978e300ac99f6ae5">samp.h</a> +, <a class="el" href="sampCommands_8c.html#367a24fc0aa7a81416e6a0d0dbfcd93f">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#367a24fc0aa7a81416e6a0d0dbfcd93f">sampDecl.h</a> +<li>samp_getUserHandler() +: <a class="el" href="samp_8h.html#ce2ea31b9bd82db4c5040ffd0511bd8b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#6bb258d378627da1aa0254fccdb6bd2c">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#6bb258d378627da1aa0254fccdb6bd2c">sampHandlers.c</a> +<li>samp_hubActive() +: <a class="el" href="samp_8c.html#b2f9c71819e1956e1c29e969968f453c">samp.c</a> +, <a class="el" href="samp_8h.html#14a1f14f60ac385c758346aed0f0272b">samp.h</a> +<li>samp_hubClose() +: <a class="el" href="samp_8h.html#39a580ced499e50d39d327f7709834e7">samp.h</a> +, <a class="el" href="sampDecl_8h.html#52f471568663ac6f0116d57a9ce00f00">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#52f471568663ac6f0116d57a9ce00f00">sampHub.c</a> +<li>samp_hubDeclareMetadata() +: <a class="el" href="samp_8h.html#bf1ae8a1c9c8cf520a22e6ea4d815712">samp.h</a> +, <a class="el" href="sampDecl_8h.html#088f1e762175d0dbc315853d06e50149">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#088f1e762175d0dbc315853d06e50149">sampHub.c</a> +<li>samp_hubDeclareSubscriptions() +: <a class="el" href="samp_8h.html#a6c0f67a76bd1f27898a66fe26b53fdd">samp.h</a> +, <a class="el" href="sampDecl_8h.html#7be493427eac28b2a064eedd8a7d63ff">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#7be493427eac28b2a064eedd8a7d63ff">sampHub.c</a> +<li>samp_hubEvent() +: <a class="el" href="samp_8h.html#a48b9a99f22537127df46a94dfa9ae4a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#19f64b527fcc431541206e41f8e36132">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#19f64b527fcc431541206e41f8e36132">sampHub.c</a> +<li>samp_hubHandler() +: <a class="el" href="sampHandlers_8c.html#bea5fa0cd958545710afcf3c5da9dc15">sampHandlers.c</a> +<li>samp_hubOpen() +: <a class="el" href="samp_8h.html#ef92557afa5ed6731ac0a0a1ba6dfd7c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2b208c34c0e6017f071b9ce654d0f3d6">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#ab66aed8f93a9cd5734a8dd62e427418">sampHub.c</a> +<li>samp_hubPing() +: <a class="el" href="samp_8h.html#155739318fa72883a3e32fccf8a6d5c9">samp.h</a> +, <a class="el" href="sampDecl_8h.html#47b1a9a4627fde97f95b40b372153cf6">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#47b1a9a4627fde97f95b40b372153cf6">sampHub.c</a> +<li>samp_hubRegister() +: <a class="el" href="samp_8h.html#77a14721e2373c805b58f69a018ea69c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#13ad32079ae1db571e3114b7bd8ba356">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#13ad32079ae1db571e3114b7bd8ba356">sampHub.c</a> +<li>samp_hubRunning() +: <a class="el" href="samp_8h.html#a927eb8dcb67e245aeb5a8a4feeb6230">samp.h</a> +, <a class="el" href="sampHub_8c.html#a927eb8dcb67e245aeb5a8a4feeb6230">sampHub.c</a> +<li>samp_hubSendShutdown() +: <a class="el" href="samp_8h.html#6c7b8a8ff1f3c2435d153bc08da87dce">samp.h</a> +, <a class="el" href="sampDecl_8h.html#a704d2a0d290f2fdfb3ebfffc39adcb3">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#a704d2a0d290f2fdfb3ebfffc39adcb3">sampHub.c</a> +<li>samp_hubSetXmlrpcCallback() +: <a class="el" href="samp_8h.html#fc0bfbd699ab2cbce2f755a0506ca6dc">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2fcb0032e5ae98fff93becdb06da49f9">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#2fcb0032e5ae98fff93becdb06da49f9">sampHub.c</a> +<li>samp_hubUnRegister() +: <a class="el" href="samp_8h.html#b0c37311ca30e1fdadfdd1fd16ff3ab4">samp.h</a> +, <a class="el" href="sampDecl_8h.html#6d4e32ed0eb19f02cc8a75f75a98deec">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#6d4e32ed0eb19f02cc8a75f75a98deec">sampHub.c</a> +<li>samp_id2app() +: <a class="el" href="samp_8h.html#343e25bf33431d973d9f81bc25eddcf7">samp.h</a> +, <a class="el" href="sampDecl_8h.html#a75368198ec8cd2fff6ad304806862b8">sampDecl.h</a> +, <a class="el" href="sampUtil_8c.html#a75368198ec8cd2fff6ad304806862b8">sampUtil.c</a> +<li>samp_imageLoadFITS() +: <a class="el" href="samp_8h.html#2ec386ef5bd7dee20ffa1fead0b0210a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#4812b571ed87f7842ca20b7024770df3">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#4812b571ed87f7842ca20b7024770df3">sampMTypes.c</a> +<li>samp_imLoadHandler() +: <a class="el" href="samp_8h.html#9bd8036dd65dc4f874f39568b691a123">samp.h</a> +, <a class="el" href="sampDecl_8h.html#9bd8036dd65dc4f874f39568b691a123">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#9bd8036dd65dc4f874f39568b691a123">sampHandlers.c</a> +<li>samp_listClients() +: <a class="el" href="samp_8c.html#1e494e73abe2ddfd946fb39e84da42a9">samp.c</a> +, <a class="el" href="samp_8h.html#1e494e73abe2ddfd946fb39e84da42a9">samp.h</a> +, <a class="el" href="sampDecl_8h.html#1e494e73abe2ddfd946fb39e84da42a9">sampDecl.h</a> +<li>samp_listLen() +: <a class="el" href="samp_8h.html#c260afb0cbf19b427e3eba96a2341e52">samp.h</a> +, <a class="el" href="sampDecl_8h.html#c260afb0cbf19b427e3eba96a2341e52">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#c260afb0cbf19b427e3eba96a2341e52">sampList.c</a> +<li>samp_mapClients() +: <a class="el" href="samp_8c.html#ff4d125fc9594be25984989fad2fd3c8">samp.c</a> +, <a class="el" href="samp_8h.html#ff4d125fc9594be25984989fad2fd3c8">samp.h</a> +, <a class="el" href="sampDecl_8h.html#ff4d125fc9594be25984989fad2fd3c8">sampDecl.h</a> +<li>samp_Metadata() +: <a class="el" href="samp_8c.html#1428f653b9502c6e6d540f873de2b24f">samp.c</a> +, <a class="el" href="samp_8h.html#2e77115e730e95b31d897b8c50999b74">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2e77115e730e95b31d897b8c50999b74">sampDecl.h</a> +<li>samp_msgParam() +: <a class="el" href="samp_8h.html#281c8f7f8b21a74704dd200d5aaed481">samp.h</a> +, <a class="el" href="sampDecl_8h.html#281c8f7f8b21a74704dd200d5aaed481">sampDecl.h</a> +, <a class="el" href="sampMsg_8c.html#281c8f7f8b21a74704dd200d5aaed481">sampMsg.c</a> +<li>samp_mutex +: <a class="el" href="sampHub_8c.html#c49d9bc6850c63f257c18f2920915d9c">sampHub.c</a> +<li>samp_newHandle() +: <a class="el" href="samp_8h.html#711aa545f55e9307f662062deefd5903">samp.h</a> +<li>samp_newList() +: <a class="el" href="samp_8h.html#cdc925da798ee7a1ce30427d47812bd2">samp.h</a> +, <a class="el" href="sampDecl_8h.html#b5375a6478dccefe7df2b48416604b29">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#b5375a6478dccefe7df2b48416604b29">sampList.c</a> +<li>samp_newMap() +: <a class="el" href="samp_8h.html#d88b5d5e9014deba8071f7defd220dbb">samp.h</a> +, <a class="el" href="sampDecl_8h.html#55c96c3dfe79d00b8445a60769785dae">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#9985b96289047cafc24f2adbfeed977f">sampMap.c</a> +<li>samp_newMsg() +: <a class="el" href="samp_8h.html#d343c08e241ff4e17a0eb8fa3d9f4781">samp.h</a> +, <a class="el" href="sampDecl_8h.html#1a66c53bb9e023fb0219ab9baeded3d6">sampDecl.h</a> +, <a class="el" href="sampMsg_8c.html#d6dfdab2715ea070713515754dd499dd">sampMsg.c</a> +<li>samp_newParam() +: <a class="el" href="samp_8h.html#3e2fe98bee9ac2b0c882de78e9b5085f">samp.h</a> +, <a class="el" href="sampDecl_8h.html#c58f0b105566a61785fb9f2ed9b42830">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#8750d9db641826f700973dae3fcdc920">sampParam.c</a> +<li>samp_notify() +: <a class="el" href="samp_8h.html#c73788ae17493c4042948f6b861ddd74">samp.h</a> +, <a class="el" href="sampClient_8c.html#c73788ae17493c4042948f6b861ddd74">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#c73788ae17493c4042948f6b861ddd74">sampDecl.h</a> +<li>samp_notifyAll() +: <a class="el" href="samp_8h.html#a046d61f43fce831a71621f98b6d9741">samp.h</a> +, <a class="el" href="sampClient_8c.html#f48228224c20ddaf8b4b4ce39fa6ec16">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#f48228224c20ddaf8b4b4ce39fa6ec16">sampDecl.h</a> +<li>samp_nullResponse() +: <a class="el" href="samp_8h.html#5361571754505eaefdf5739cd3e9519e">samp.h</a> +, <a class="el" href="sampDecl_8h.html#5361571754505eaefdf5739cd3e9519e">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#5361571754505eaefdf5739cd3e9519e">sampHandlers.c</a> +<li>samp_P2H() +: <a class="el" href="samp_8h.html#4d0aef2f09b9cce38d4ea8024831c6e5">samp.h</a> +<li>samp_paramGet() +: <a class="el" href="samp_8h.html#4c75de6ddcffde6e3dde7beea68de81c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#19b75403d63714c4fccc8a8d4fa4c8cf">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#19b75403d63714c4fccc8a8d4fa4c8cf">sampMTypes.c</a> +<li>samp_paramGetHandler() +: <a class="el" href="samp_8h.html#659c272ce881662c1826a04728dc06f6">samp.h</a> +, <a class="el" href="sampDecl_8h.html#659c272ce881662c1826a04728dc06f6">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#659c272ce881662c1826a04728dc06f6">sampHandlers.c</a> +<li>samp_paramInit() +: <a class="el" href="samp_8h.html#f2953eb691b695482ffbbea71948374f">samp.h</a> +, <a class="el" href="sampDecl_8h.html#d8c5669be313874fef1c484643683f49">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#d8c5669be313874fef1c484643683f49">sampParam.c</a> +<li>samp_paramLen() +: <a class="el" href="sampDecl_8h.html#7680995e5d4f26ea3d91bf72c9c72e51">sampDecl.h</a> +, <a class="el" href="samp_8h.html#5a44618b7681acff67b3883341494d2d">samp.h</a> +, <a class="el" href="sampParam_8c.html#7680995e5d4f26ea3d91bf72c9c72e51">sampParam.c</a> +<li>samp_paramSet() +: <a class="el" href="sampMTypes_8c.html#535cb6760c733a75746d2f104b1a01be">sampMTypes.c</a> +, <a class="el" href="samp_8h.html#7a5c9f092b57dfb3206c8decc8558fd3">samp.h</a> +, <a class="el" href="sampDecl_8h.html#535cb6760c733a75746d2f104b1a01be">sampDecl.h</a> +<li>samp_paramSetHandler() +: <a class="el" href="samp_8h.html#071aa9e32f2e94d5b667e87cf65d2bdf">samp.h</a> +, <a class="el" href="sampDecl_8h.html#071aa9e32f2e94d5b667e87cf65d2bdf">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#071aa9e32f2e94d5b667e87cf65d2bdf">sampHandlers.c</a> +<li>samp_Ping() +: <a class="el" href="samp_8h.html#7688cbf8ef852483c077be96151763a6">samp.h</a> +, <a class="el" href="sampCommands_8c.html#2be0812dc8d34c68407c62762f727c51">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#2be0812dc8d34c68407c62762f727c51">sampDecl.h</a> +<li>samp_PingHandler() +: <a class="el" href="sampDecl_8h.html#16d8b8822d169107b8702ae753797923">sampDecl.h</a> +, <a class="el" href="samp_8h.html#16d8b8822d169107b8702ae753797923">samp.h</a> +, <a class="el" href="sampHandlers_8c.html#16d8b8822d169107b8702ae753797923">sampHandlers.c</a> +<li>samp_pointAtHandler() +: <a class="el" href="sampHandlers_8c.html#3f5632858a2b09759ffe98cd2e183cfb">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#3f5632858a2b09759ffe98cd2e183cfb">samp.h</a> +, <a class="el" href="sampDecl_8h.html#3f5632858a2b09759ffe98cd2e183cfb">sampDecl.h</a> +<li>samp_printMap() +: <a class="el" href="samp_8h.html#a8a947c24f2c9333adf4e5d7fa11d134">samp.h</a> +, <a class="el" href="sampDecl_8h.html#a8a947c24f2c9333adf4e5d7fa11d134">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#a8a947c24f2c9333adf4e5d7fa11d134">sampHandlers.c</a> +<li>samp_printMetadata() +: <a class="el" href="sampDecl_8h.html#ace22fd6ada035930ef93e5a54c375b1">sampDecl.h</a> +, <a class="el" href="sampUtil_8c.html#c7538c339e59556bfd0a87973ad61a43">sampUtil.c</a> +, <a class="el" href="samp_8h.html#5b2ef060b3adb18aea7a5a6099c4d0d0">samp.h</a> +<li>samp_processHubEvent() +: <a class="el" href="samp_8h.html#265b5d07cce485a6979fe5f4a2217624">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2933b26ac05c440196368edad0167bdf">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#2933b26ac05c440196368edad0167bdf">sampHub.c</a> +<li>samp_receiveCall() +: <a class="el" href="samp_8h.html#59f85e0fce4c9ae7121c98e137d3f743">samp.h</a> +, <a class="el" href="sampDecl_8h.html#59f85e0fce4c9ae7121c98e137d3f743">sampDecl.h</a> +, <a class="el" href="sampMethods_8c.html#59f85e0fce4c9ae7121c98e137d3f743">sampMethods.c</a> +<li>samp_receiveNotification() +: <a class="el" href="samp_8h.html#03be7cc9e154a6ccdd499286df640936">samp.h</a> +, <a class="el" href="sampDecl_8h.html#03be7cc9e154a6ccdd499286df640936">sampDecl.h</a> +, <a class="el" href="sampMethods_8c.html#03be7cc9e154a6ccdd499286df640936">sampMethods.c</a> +<li>samp_receiveResponse() +: <a class="el" href="sampDecl_8h.html#754b50ad59145c7fd1e4c8f4277f11e4">sampDecl.h</a> +, <a class="el" href="sampMethods_8c.html#754b50ad59145c7fd1e4c8f4277f11e4">sampMethods.c</a> +, <a class="el" href="samp_8h.html#754b50ad59145c7fd1e4c8f4277f11e4">samp.h</a> +<li>samp_Register() +: <a class="el" href="samp_8h.html#aef9c2f86c7e4f49fe3df343ef06f3ba">samp.h</a> +, <a class="el" href="sampDecl_8h.html#84ffd50bd4b8dc79e9cf32398c6b3d69">sampDecl.h</a> +, <a class="el" href="sampCommands_8c.html#84ffd50bd4b8dc79e9cf32398c6b3d69">sampCommands.c</a> +<li>samp_removeClient() +: <a class="el" href="samp_8c.html#e30e492f306a40f853a454faf60ab479">samp.c</a> +, <a class="el" href="samp_8h.html#e30e492f306a40f853a454faf60ab479">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e30e492f306a40f853a454faf60ab479">sampDecl.h</a> +<li>samp_Reply() +: <a class="el" href="samp_8h.html#89fc488147fe2e08b4f3c044c7079962">samp.h</a> +, <a class="el" href="sampClient_8c.html#ae0a6eaf06027e28ade8865196f1e2c6">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#9c6ff3d76997c3d7301a977309a117e0">sampDecl.h</a> +<li>samp_replyStatus() +: <a class="el" href="samp_8h.html#d47754f3b9fceff4d3019821519432b4">samp.h</a> +, <a class="el" href="sampDecl_8h.html#d47754f3b9fceff4d3019821519432b4">sampDecl.h</a> +, <a class="el" href="samp_8c.html#985afa0baeb135c9ee72d09394314ff1">samp.c</a> +<li>samp_resConeHandler() +: <a class="el" href="samp_8h.html#287569451dc1bf59d1f9f6d13b56716d">samp.h</a> +, <a class="el" href="sampHandlers_8c.html#287569451dc1bf59d1f9f6d13b56716d">sampHandlers.c</a> +, <a class="el" href="sampDecl_8h.html#287569451dc1bf59d1f9f6d13b56716d">sampDecl.h</a> +<li>samp_resLoadHandler() +: <a class="el" href="samp_8h.html#c0bf7cf7fea362c0c82ad7bc3f267c48">samp.h</a> +, <a class="el" href="sampDecl_8h.html#c0bf7cf7fea362c0c82ad7bc3f267c48">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#c0bf7cf7fea362c0c82ad7bc3f267c48">sampHandlers.c</a> +<li>samp_resourceLoad() +: <a class="el" href="samp_8h.html#a0bb33d232fcb52aaa470d1f1b1a89d7">samp.h</a> +, <a class="el" href="sampDecl_8h.html#8013c549ef47e0507edf39c8ab1b62aa">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#8013c549ef47e0507edf39c8ab1b62aa">sampMTypes.c</a> +<li>samp_resSiapHandler() +: <a class="el" href="samp_8h.html#8b2300222d7b11f144eb4385412e69a5">samp.h</a> +, <a class="el" href="sampDecl_8h.html#8b2300222d7b11f144eb4385412e69a5">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#8b2300222d7b11f144eb4385412e69a5">sampHandlers.c</a> +<li>samp_resSsapHandler() +: <a class="el" href="samp_8h.html#866578a01c3b762435823b1b11869c42">samp.h</a> +, <a class="el" href="sampHandlers_8c.html#866578a01c3b762435823b1b11869c42">sampHandlers.c</a> +, <a class="el" href="sampDecl_8h.html#866578a01c3b762435823b1b11869c42">sampDecl.h</a> +<li>samp_resTapHandler() +: <a class="el" href="samp_8h.html#ad42ca17cbaf23012ad497559ea45e4c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#ad42ca17cbaf23012ad497559ea45e4c">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#ad42ca17cbaf23012ad497559ea45e4c">sampHandlers.c</a> +<li>samp_resVOSpaceHandler() +: <a class="el" href="samp_8h.html#fa207ebdc587ba5eeab60fbf79b635d4">samp.h</a> +, <a class="el" href="sampDecl_8h.html#fa207ebdc587ba5eeab60fbf79b635d4">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#fa207ebdc587ba5eeab60fbf79b635d4">sampHandlers.c</a> +<li>samp_sendGeneric() +: <a class="el" href="samp_8h.html#5837826e5b4e86b2dda0892c48b96faf">samp.h</a> +, <a class="el" href="sampDecl_8h.html#b2ff2e029c57b56ad57416c624341fe6">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#b2ff2e029c57b56ad57416c624341fe6">sampMTypes.c</a> +<li>samp_sendMsg() +: <a class="el" href="samp_8h.html#4607721d55904450d4066c360d3dcddd">samp.h</a> +, <a class="el" href="sampMTypes_8c.html#80ef1a82845b96091857c7d4a3c7972c">sampMTypes.c</a> +, <a class="el" href="sampDecl_8h.html#80ef1a82845b96091857c7d4a3c7972c">sampDecl.h</a> +<li>samp_serverPort() +: <a class="el" href="sampUtil_8c.html#0fb77074a0a38a4eab5dcf4e397dfef3">sampUtil.c</a> +, <a class="el" href="samp_8h.html#6157dc4b47c65323a3015a434cd02e69">samp.h</a> +, <a class="el" href="sampDecl_8h.html#0af6dba3d1022e6b220a9b1076021353">sampDecl.h</a> +<li>samp_setAppVersion() +: <a class="el" href="samp_8h.html#8fbfdc550ede5d52840300ab33639c49">samp.h</a> +, <a class="el" href="sampDecl_8h.html#8fbfdc550ede5d52840300ab33639c49">sampDecl.h</a> +, <a class="el" href="samp_8c.html#0f50f8dbae701aa6b19912fc99f6475a">samp.c</a> +<li>samp_setASyncMode() +: <a class="el" href="samp_8c.html#9b2292b819e590b1f7c63bbdfaa09e31">samp.c</a> +, <a class="el" href="sampDecl_8h.html#a9aef12dd82bfd38a2382a4ac88c54af">sampDecl.h</a> +, <a class="el" href="samp_8h.html#a9aef12dd82bfd38a2382a4ac88c54af">samp.h</a> +<li>samp_setCallByRef() +: <a class="el" href="samp_8h.html#d4c1514e94c9ef511cfcd27004c38c4d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#d4c1514e94c9ef511cfcd27004c38c4d">sampDecl.h</a> +, <a class="el" href="samp_8c.html#b6b49029386c3efd0520daa93a4ab3eb">samp.c</a> +<li>samp_setCallMode() +: <a class="el" href="samp_8c.html#3e01437224c73b91e49c6428cb69735d">samp.c</a> +, <a class="el" href="samp_8h.html#fc27715ec9a5cb60cf0b5415eb7f9a48">samp.h</a> +, <a class="el" href="sampDecl_8h.html#fc27715ec9a5cb60cf0b5415eb7f9a48">sampDecl.h</a> +<li>samp_setErr() +: <a class="el" href="sampDecl_8h.html#91aeabe77e920fc1924b1cdc4f088e64">sampDecl.h</a> +, <a class="el" href="samp_8h.html#3c026895e4d28567eb63c3b9cc16cd40">samp.h</a> +, <a class="el" href="sampClient_8c.html#91aeabe77e920fc1924b1cdc4f088e64">sampClient.c</a> +<li>samp_setFloatInList() +: <a class="el" href="sampList_8c.html#18d586491620a63b3a4d6c3667ee2aa5">sampList.c</a> +, <a class="el" href="sampDecl_8h.html#041a551aff57ca03f3ff72a9803e2b58">sampDecl.h</a> +, <a class="el" href="samp_8h.html#041a551aff57ca03f3ff72a9803e2b58">samp.h</a> +<li>samp_setFloatInMap() +: <a class="el" href="samp_8h.html#0f07ae542f5b317311b3799bd96a88fd">samp.h</a> +, <a class="el" href="sampMap_8c.html#0f07ae542f5b317311b3799bd96a88fd">sampMap.c</a> +, <a class="el" href="sampDecl_8h.html#0f07ae542f5b317311b3799bd96a88fd">sampDecl.h</a> +<li>samp_setHandlerReply() +: <a class="el" href="samp_8h.html#1cd88b9e964d61403d6aad89dddce591">samp.h</a> +, <a class="el" href="sampMethods_8c.html#82fec51207e326e6373e174bb6855634">sampMethods.c</a> +<li>samp_setIntInList() +: <a class="el" href="sampDecl_8h.html#2d8a8a26d7284bb211a933895cddd29c">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#a803bead8b452de6e1d08b8b3b9e8828">sampList.c</a> +, <a class="el" href="samp_8h.html#2d8a8a26d7284bb211a933895cddd29c">samp.h</a> +<li>samp_setIntInMap() +: <a class="el" href="samp_8h.html#c22ec42dbf9a01c9b4e00cf011e7eb9d">samp.h</a> +, <a class="el" href="sampMap_8c.html#c22ec42dbf9a01c9b4e00cf011e7eb9d">sampMap.c</a> +, <a class="el" href="sampDecl_8h.html#c22ec42dbf9a01c9b4e00cf011e7eb9d">sampDecl.h</a> +<li>samp_setListInList() +: <a class="el" href="samp_8h.html#0ff97d44e62b7c88a046a29324552400">samp.h</a> +, <a class="el" href="sampDecl_8h.html#0ff97d44e62b7c88a046a29324552400">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#0ff97d44e62b7c88a046a29324552400">sampList.c</a> +<li>samp_setListInMap() +: <a class="el" href="samp_8h.html#362c2f670c98dd6a3ef69debd1871604">samp.h</a> +, <a class="el" href="sampMap_8c.html#362c2f670c98dd6a3ef69debd1871604">sampMap.c</a> +, <a class="el" href="sampDecl_8h.html#362c2f670c98dd6a3ef69debd1871604">sampDecl.h</a> +<li>samp_setMapInList() +: <a class="el" href="sampDecl_8h.html#ea188bb711f3b5549d11204b0ff2da08">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#ea188bb711f3b5549d11204b0ff2da08">sampList.c</a> +, <a class="el" href="samp_8h.html#ea188bb711f3b5549d11204b0ff2da08">samp.h</a> +<li>samp_setMapInMap() +: <a class="el" href="sampMap_8c.html#f102490efe1b92d99b67f244dc498c7b">sampMap.c</a> +, <a class="el" href="samp_8h.html#f102490efe1b92d99b67f244dc498c7b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#f102490efe1b92d99b67f244dc498c7b">sampDecl.h</a> +<li>samp_setMsgMode() +: <a class="el" href="samp_8c.html#01721eabf3e664bae3bea0c2b72268e2">samp.c</a> +, <a class="el" href="samp_8h.html#68b51d70127bbff10fd30396e40a482d">samp.h</a> +<li>samp_setNotifyMode() +: <a class="el" href="samp_8h.html#9056a8601300892f918835259c7fdb3b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#9056a8601300892f918835259c7fdb3b">sampDecl.h</a> +, <a class="el" href="samp_8c.html#7bfbc2e767fe234f83c13b8316a09ecd">samp.c</a> +<li>samp_setReplyCallback() +: <a class="el" href="samp_8c.html#a3c0bdb4c512357dbc53b0ad7a7d5b01">samp.c</a> +, <a class="el" href="sampDecl_8h.html#a3c0bdb4c512357dbc53b0ad7a7d5b01">sampDecl.h</a> +, <a class="el" href="samp_8h.html#a3c0bdb4c512357dbc53b0ad7a7d5b01">samp.h</a> +<li>samp_setResponseCallback() +: <a class="el" href="samp_8h.html#3db66f28546459327665f8491ea97f4d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#3db66f28546459327665f8491ea97f4d">sampDecl.h</a> +, <a class="el" href="samp_8c.html#3db66f28546459327665f8491ea97f4d">samp.c</a> +<li>samp_setSampHandler() +: <a class="el" href="sampDecl_8h.html#2e8ec01a0dd96314622ae313206583db">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#2e8ec01a0dd96314622ae313206583db">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#8b83cf8a75c16c45c547be68f0bf9f64">samp.h</a> +<li>samp_setStringInList() +: <a class="el" href="sampDecl_8h.html#5b69180b036e58528c98b1cf5a42825a">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#5b69180b036e58528c98b1cf5a42825a">sampList.c</a> +, <a class="el" href="samp_8h.html#5b69180b036e58528c98b1cf5a42825a">samp.h</a> +<li>samp_setStringInMap() +: <a class="el" href="sampDecl_8h.html#b9b2157de89369eb5cd95bfe804eb89a">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#b9b2157de89369eb5cd95bfe804eb89a">sampMap.c</a> +, <a class="el" href="samp_8h.html#b9b2157de89369eb5cd95bfe804eb89a">samp.h</a> +<li>samp_setSyncMode() +: <a class="el" href="sampDecl_8h.html#1d00dc78292cfbc01262ef65ab055063">sampDecl.h</a> +, <a class="el" href="samp_8h.html#1d00dc78292cfbc01262ef65ab055063">samp.h</a> +, <a class="el" href="samp_8c.html#d636ae12dd05df43a077f91882a197ec">samp.c</a> +<li>samp_setTimeout() +: <a class="el" href="samp_8c.html#c057d32437a96a527c63f938757099af">samp.c</a> +, <a class="el" href="samp_8h.html#e11a97c262ab5ab4438eca6c60c0d8cf">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e11a97c262ab5ab4438eca6c60c0d8cf">sampDecl.h</a> +<li>samp_setUserHandler() +: <a class="el" href="sampHandlers_8c.html#81222e1f3572585fa30f11a78aa08c3f">sampHandlers.c</a> +, <a class="el" href="sampDecl_8h.html#81222e1f3572585fa30f11a78aa08c3f">sampDecl.h</a> +, <a class="el" href="samp_8h.html#b969017f97d850b092bde60a2d445a2b">samp.h</a> +<li>samp_specLoadHandler() +: <a class="el" href="sampHandlers_8c.html#bc319b97b3dbea29bd79c4f723db5438">sampHandlers.c</a> +, <a class="el" href="sampDecl_8h.html#bc319b97b3dbea29bd79c4f723db5438">sampDecl.h</a> +, <a class="el" href="samp_8h.html#bc319b97b3dbea29bd79c4f723db5438">samp.h</a> +<li>samp_specLoadSSAGeneric() +: <a class="el" href="sampDecl_8h.html#18b351385bd175581a6788a4f7342f07">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#18b351385bd175581a6788a4f7342f07">sampMTypes.c</a> +, <a class="el" href="samp_8h.html#4869a1bb04a96514f153dc5bfbed8e6e">samp.h</a> +<li>samp_specSSAHandler() +: <a class="el" href="sampHandlers_8c.html#dd2bca8fa3bf3b4ebbf449edc6b65d85">sampHandlers.c</a> +, <a class="el" href="sampDecl_8h.html#dd2bca8fa3bf3b4ebbf449edc6b65d85">sampDecl.h</a> +, <a class="el" href="samp_8h.html#dd2bca8fa3bf3b4ebbf449edc6b65d85">samp.h</a> +<li>samp_StatusHandler() +: <a class="el" href="sampHandlers_8c.html#2e342b672e77e012cc98a6f5506a44be">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#2e342b672e77e012cc98a6f5506a44be">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2e342b672e77e012cc98a6f5506a44be">sampDecl.h</a> +<li>samp_Subscribe() +: <a class="el" href="sampDecl_8h.html#c6b76655d73825acdacfac8b5a1139ee">sampDecl.h</a> +, <a class="el" href="samp_8h.html#c6b76655d73825acdacfac8b5a1139ee">samp.h</a> +, <a class="el" href="samp_8c.html#ed050606c5076a4a34eb8f0f982a25d4">samp.c</a> +<li>samp_tableHighlightRow() +: <a class="el" href="samp_8h.html#0503d3ee247a6a962a2a8da672261ab7">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e38ac987f1dfd87ad64f97d55396270e">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#e38ac987f1dfd87ad64f97d55396270e">sampMTypes.c</a> +<li>samp_tableLoadFITS() +: <a class="el" href="sampDecl_8h.html#74aeaaf742121348390ec854c30c1479">sampDecl.h</a> +, <a class="el" href="samp_8h.html#6b950e53c7fdf481a13c8a2ec353dca1">samp.h</a> +, <a class="el" href="sampMTypes_8c.html#74aeaaf742121348390ec854c30c1479">sampMTypes.c</a> +<li>samp_tableLoadVOTable() +: <a class="el" href="sampDecl_8h.html#34e9d38073f36daaf41c418f8d680ee5">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#34e9d38073f36daaf41c418f8d680ee5">sampMTypes.c</a> +, <a class="el" href="samp_8h.html#45c2023312cd2adfa40feb2eb8a3e143">samp.h</a> +<li>samp_tableSelectRowList() +: <a class="el" href="sampMTypes_8c.html#f133efb67fe4bcfd2b9c8ab9d23b4c5e">sampMTypes.c</a> +, <a class="el" href="samp_8h.html#a410ef908863f7c5b2c99844ebb73d35">samp.h</a> +, <a class="el" href="sampDecl_8h.html#f133efb67fe4bcfd2b9c8ab9d23b4c5e">sampDecl.h</a> +<li>samp_tbHighlightHandler() +: <a class="el" href="sampDecl_8h.html#d9184eb45a5bc93b5205fd5b1c6ef688">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#d9184eb45a5bc93b5205fd5b1c6ef688">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#d9184eb45a5bc93b5205fd5b1c6ef688">samp.h</a> +<li>samp_tbLoadFITSHandler() +: <a class="el" href="sampDecl_8h.html#750c0fee0c7a99e135299c08751f288c">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#750c0fee0c7a99e135299c08751f288c">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#750c0fee0c7a99e135299c08751f288c">samp.h</a> +<li>samp_tbLoadHandler() +: <a class="el" href="sampHandlers_8c.html#26f96dc6cbf72283e2ee9cb8b4619ed3">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#26f96dc6cbf72283e2ee9cb8b4619ed3">samp.h</a> +, <a class="el" href="sampDecl_8h.html#26f96dc6cbf72283e2ee9cb8b4619ed3">sampDecl.h</a> +<li>samp_tbLoadVOTHandler() +: <a class="el" href="sampDecl_8h.html#144ec2329355d91022d5ea38736c0093">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#144ec2329355d91022d5ea38736c0093">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#144ec2329355d91022d5ea38736c0093">samp.h</a> +<li>samp_tbSelectHandler() +: <a class="el" href="sampHandlers_8c.html#98d68d7091c0b7790631bb53e0ace656">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#98d68d7091c0b7790631bb53e0ace656">samp.h</a> +, <a class="el" href="sampDecl_8h.html#98d68d7091c0b7790631bb53e0ace656">sampDecl.h</a> +<li>samp_UnRegister() +: <a class="el" href="sampDecl_8h.html#106fc27544de7c25625ed60eb48e4edd">sampDecl.h</a> +, <a class="el" href="sampCommands_8c.html#106fc27544de7c25625ed60eb48e4edd">sampCommands.c</a> +, <a class="el" href="samp_8h.html#5e3a44429f332694cc2cedc2e38856ce">samp.h</a> +<li>samp_Unsubscribe() +: <a class="el" href="sampDecl_8h.html#b3fded97bbbf3751c4916543959f16a5">sampDecl.h</a> +, <a class="el" href="samp_8h.html#b3fded97bbbf3751c4916543959f16a5">samp.h</a> +, <a class="el" href="samp_8c.html#dc0e418fbaee507e661260c4480ecfcd">samp.c</a> +<li>sampClose() +: <a class="el" href="sampDecl_8h.html#123413db26ad50a84bd41863af5deae5">sampDecl.h</a> +, <a class="el" href="samp_8c.html#f861f637942c5f971bab824708581f82">samp.c</a> +, <a class="el" href="samp_8h.html#123413db26ad50a84bd41863af5deae5">samp.h</a> +<li>sampDebug() +: <a class="el" href="samp_8h.html#124214f79e99619b377d98ed2fd93eb9">samp.h</a> +, <a class="el" href="samp_8c.html#6bfd947988e5dbc846af7f99bcd99ee7">samp.c</a> +<li>sampH +: <a class="el" href="sampMethods_8c.html#b04b61ee02d86e15b02b861699ae7424">sampMethods.c</a> +, <a class="el" href="samp_8c.html#b04b61ee02d86e15b02b861699ae7424">samp.c</a> +, <a class="el" href="sampHandlers_8c.html#b04b61ee02d86e15b02b861699ae7424">sampHandlers.c</a> +<li>sampInit() +: <a class="el" href="samp_8c.html#db03c60f2933ed9785bfb4457c359af2">samp.c</a> +, <a class="el" href="samp_8h.html#30f39c72c3783055faa82ad3860f3d1d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#30f39c72c3783055faa82ad3860f3d1d">sampDecl.h</a> +<li>sampLog() +: <a class="el" href="samp_8h.html#329a8a5f83162ed49baa28f008131d45">samp.h</a> +, <a class="el" href="sampDecl_8h.html#4919f892b6fccced4e6b9d777071b781">sampDecl.h</a> +, <a class="el" href="sampLog_8c.html#4919f892b6fccced4e6b9d777071b781">sampLog.c</a> +<li>sampShutdown() +: <a class="el" href="samp_8c.html#d634392fbb12cf4e1b2eb05da34759c5">samp.c</a> +, <a class="el" href="sampDecl_8h.html#65908d088c8b917d10db38c147590ad9">sampDecl.h</a> +, <a class="el" href="samp_8h.html#65908d088c8b917d10db38c147590ad9">samp.h</a> +<li>sampStartup() +: <a class="el" href="sampDecl_8h.html#8e18ae12df031094ace47863f93b3634">sampDecl.h</a> +, <a class="el" href="samp_8h.html#8e18ae12df031094ace47863f93b3634">samp.h</a> +, <a class="el" href="samp_8c.html#1f6d544576fec785be1acfeaf3f2cf63">samp.c</a> +<li>sampTrace() +: <a class="el" href="sampDecl_8h.html#2b3dd1662e61c83e29109126689b08b9">sampDecl.h</a> +, <a class="el" href="sampLog_8c.html#2b3dd1662e61c83e29109126689b08b9">sampLog.c</a> +, <a class="el" href="samp_8h.html#65e3987c9b510018dcdd91203b437e40">samp.h</a> +<li>sampVerbose() +: <a class="el" href="samp_8h.html#c0c812e5d3f2c9ee6c54067e4c81b3dd">samp.h</a> +, <a class="el" href="samp_8c.html#e3a6e918b3fe22db2fe014da16f81aad">samp.c</a> +<li>String +: <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">sampDecl.h</a> +, <a class="el" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">samp.h</a> +<li>SZ_CLIENT_LIST +: <a class="el" href="samp_8c.html#92d198f56296c0b6a531ce4bce977185">samp.c</a> +<li>SZ_NAME +: <a class="el" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">sampDecl.h</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_defs.html b/vendor/voclient/libsamp/doc/html/globals_defs.html new file mode 100644 index 00000000..abc68a7f --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_defs.html @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li class="current"><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<ul> +<li>HUB_SHUTDOWN +: <a class="el" href="samp_8h.html#fc367e0d449c3afa2d429eedc85407aa">samp.h</a> +<li>SZ_CLIENT_LIST +: <a class="el" href="samp_8c.html#92d198f56296c0b6a531ce4bce977185">samp.c</a> +<li>SZ_NAME +: <a class="el" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">sampDecl.h</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_func.html b/vendor/voclient/libsamp/doc/html/globals_func.html new file mode 100644 index 00000000..19f275e2 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_func.html @@ -0,0 +1,652 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html"><span>All</span></a></li> + <li class="current"><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li class="current"><a href="globals_func.html#index_s"><span>s</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<h3><a class="anchor" name="index_s">- s -</a></h3><ul> +<li>samp_addClient() +: <a class="el" href="samp_8c.html#8a2111bbe4c88cef635e3bf67e899563">samp.c</a> +, <a class="el" href="samp_8h.html#8a2111bbe4c88cef635e3bf67e899563">samp.h</a> +, <a class="el" href="sampDecl_8h.html#8a2111bbe4c88cef635e3bf67e899563">sampDecl.h</a> +<li>samp_addFloatParam() +: <a class="el" href="samp_8h.html#d297770f4ab1338697d69b2705d6c1d9">samp.h</a> +, <a class="el" href="sampDecl_8h.html#d297770f4ab1338697d69b2705d6c1d9">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#d297770f4ab1338697d69b2705d6c1d9">sampParam.c</a> +<li>samp_addIntParam() +: <a class="el" href="sampDecl_8h.html#6897da75444209fc1819042bde906aa6">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#6897da75444209fc1819042bde906aa6">sampParam.c</a> +, <a class="el" href="samp_8h.html#6897da75444209fc1819042bde906aa6">samp.h</a> +<li>samp_addListParam() +: <a class="el" href="samp_8h.html#24f72c4ed033ed2f219b420e491b3c0f">samp.h</a> +, <a class="el" href="sampDecl_8h.html#24f72c4ed033ed2f219b420e491b3c0f">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#24f72c4ed033ed2f219b420e491b3c0f">sampParam.c</a> +<li>samp_addMapParam() +: <a class="el" href="samp_8h.html#e3e90c84dd6b1a08d8af18ca9e168b37">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e3e90c84dd6b1a08d8af18ca9e168b37">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#e3e90c84dd6b1a08d8af18ca9e168b37">sampParam.c</a> +<li>samp_app2id() +: <a class="el" href="samp_8h.html#5e555288172e59ccf28c901c6bc10793">samp.h</a> +, <a class="el" href="sampDecl_8h.html#aed9017996a8361f8abf5b5c6a954414">sampDecl.h</a> +, <a class="el" href="sampUtil_8c.html#aed9017996a8361f8abf5b5c6a954414">sampUtil.c</a> +<li>samp_bibcodeHandler() +: <a class="el" href="samp_8h.html#262bf09278c61b60b5189fef7f26d26b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#262bf09278c61b60b5189fef7f26d26b">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#262bf09278c61b60b5189fef7f26d26b">sampHandlers.c</a> +<li>samp_bibLoad() +: <a class="el" href="samp_8h.html#abeaa1ac9d09a666a9fa34a7d274483d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#ae7f51c1f6169b918568a1202d0fa031">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#ae7f51c1f6169b918568a1202d0fa031">sampMTypes.c</a> +<li>samp_call() +: <a class="el" href="samp_8h.html#919cca4cfc557e0c05914b805401fbd3">samp.h</a> +, <a class="el" href="sampClient_8c.html#68d7703657197a3d9256729cf2971033">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#77f32922cfe662f4b423b678ba09513c">sampDecl.h</a> +<li>samp_callAll() +: <a class="el" href="samp_8h.html#2cbf26c662884a4ae9587f7b9f4113a6">samp.h</a> +, <a class="el" href="sampClient_8c.html#66d67a1ba0dff1f6dab68f74299f500a">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#66d67a1ba0dff1f6dab68f74299f500a">sampDecl.h</a> +<li>samp_callAndWait() +: <a class="el" href="sampClient_8c.html#6780568b9e9dfae5b361c2b2e52c16ed">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#6780568b9e9dfae5b361c2b2e52c16ed">sampDecl.h</a> +, <a class="el" href="samp_8h.html#c69c39e8ee091c006289b486dee10711">samp.h</a> +<li>samp_clientName() +: <a class="el" href="samp_8h.html#0a61726448d9b1a026b20ff6beead44e">samp.h</a> +, <a class="el" href="sampClient_8c.html#0a996f4e24693c2eacba579ecbceedbb">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#0a996f4e24693c2eacba579ecbceedbb">sampDecl.h</a> +<li>samp_cmdExec() +: <a class="el" href="samp_8h.html#be012673358bfd254e2c6ad9f6e92240">samp.h</a> +, <a class="el" href="sampDecl_8h.html#5900317c1609ddd5b6da70dc0eb2040c">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#5900317c1609ddd5b6da70dc0eb2040c">sampMTypes.c</a> +<li>samp_cmdExecHandler() +: <a class="el" href="samp_8h.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b">sampHandlers.c</a> +<li>samp_coordPointAtSky() +: <a class="el" href="samp_8h.html#0651eec8ddc8707bb8fbc4dfdcfff5e2">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e1e86e79d9a1768e5f265cbb44279172">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#e1e86e79d9a1768e5f265cbb44279172">sampMTypes.c</a> +<li>samp_DeclareMetadata() +: <a class="el" href="samp_8h.html#94cdccbcfa524fa515de77544b6c6eaa">samp.h</a> +, <a class="el" href="sampCommands_8c.html#9c6024ae76103069355256c29ee22722">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#9c6024ae76103069355256c29ee22722">sampDecl.h</a> +<li>samp_DeclareSubscriptions() +: <a class="el" href="samp_8h.html#ef695801c121c6191d3af4574569ab8c">samp.h</a> +, <a class="el" href="sampCommands_8c.html#d2b0bdea58688142f55faeffcfc65525">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#d2b0bdea58688142f55faeffcfc65525">sampDecl.h</a> +<li>samp_defaultReplyHandler() +: <a class="el" href="samp_8c.html#114bf9fb0d3e6eabd8bb93f3c87f5233">samp.c</a> +, <a class="el" href="samp_8h.html#96851f1c15e4baf67949d86d15f2568d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#96851f1c15e4baf67949d86d15f2568d">sampDecl.h</a> +<li>samp_envGet() +: <a class="el" href="samp_8h.html#ba313c7608a7658c673065c83113ec5b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#9c64fef9c158d7fd4ff7f72691ccd319">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#9c64fef9c158d7fd4ff7f72691ccd319">sampMTypes.c</a> +<li>samp_envGetHandler() +: <a class="el" href="samp_8h.html#e25a92f57babd71d43653d7fcb81025c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e25a92f57babd71d43653d7fcb81025c">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#e25a92f57babd71d43653d7fcb81025c">sampHandlers.c</a> +<li>samp_envSet() +: <a class="el" href="samp_8h.html#e842347910a3cfd746def74b0fd564aa">samp.h</a> +, <a class="el" href="sampDecl_8h.html#ded4b8bdac87c5b6faa7f13d8abb22a1">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#ded4b8bdac87c5b6faa7f13d8abb22a1">sampMTypes.c</a> +<li>samp_envSetHandler() +: <a class="el" href="samp_8h.html#0910e6b9d11cdd3111c1f18450de394a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#0910e6b9d11cdd3111c1f18450de394a">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#0910e6b9d11cdd3111c1f18450de394a">sampHandlers.c</a> +<li>samp_execUserHandler() +: <a class="el" href="samp_8h.html#e09217f0e615e01dfcffbdebda2516e8">samp.h</a> +, <a class="el" href="sampDecl_8h.html#979664bde900a1e1bf7bc499dc92898e">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#23644999b70eebfe75f52c465d1ed97f">sampHandlers.c</a> +<li>samp_freeHandle() +: <a class="el" href="samp_8h.html#f02a7c646a9ed56e545d8bf33434c207">samp.h</a> +<li>samp_freeList() +: <a class="el" href="samp_8h.html#b162ae9b9f98da80f6bb5c34b5cbcbf6">samp.h</a> +, <a class="el" href="sampDecl_8h.html#b162ae9b9f98da80f6bb5c34b5cbcbf6">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#b162ae9b9f98da80f6bb5c34b5cbcbf6">sampList.c</a> +<li>samp_freeMap() +: <a class="el" href="samp_8h.html#fe80438de542c6657d623993360b37d1">samp.h</a> +, <a class="el" href="sampDecl_8h.html#fe80438de542c6657d623993360b37d1">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#fe80438de542c6657d623993360b37d1">sampMap.c</a> +<li>samp_freeMsg() +: <a class="el" href="samp_8h.html#adf2979a5fad0c9a855740330b7fd9ce">samp.h</a> +, <a class="el" href="sampDecl_8h.html#adf2979a5fad0c9a855740330b7fd9ce">sampDecl.h</a> +, <a class="el" href="sampMsg_8c.html#adf2979a5fad0c9a855740330b7fd9ce">sampMsg.c</a> +<li>samp_freeParam() +: <a class="el" href="samp_8h.html#5a6fbf3ac37164268afae80c35666c5e">samp.h</a> +, <a class="el" href="sampDecl_8h.html#5a6fbf3ac37164268afae80c35666c5e">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#5a6fbf3ac37164268afae80c35666c5e">sampParam.c</a> +<li>samp_getAvailableHubs() +: <a class="el" href="samp_8h.html#d0343ad884d5a958d7d91928ad06a369">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e792eedc70daa9b2d010ca6cd8e57fe8">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#e792eedc70daa9b2d010ca6cd8e57fe8">sampHub.c</a> +<li>samp_getErr() +: <a class="el" href="samp_8h.html#fd8a4da020cd2fedaf70ae8af0b6a1c8">samp.h</a> +, <a class="el" href="sampClient_8c.html#4946a754670217dbdbc83cca92217022">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#4946a754670217dbdbc83cca92217022">sampDecl.h</a> +<li>samp_getFloatFromList() +: <a class="el" href="samp_8h.html#cf9b570dd76203d2299ed7bdba048bb9">samp.h</a> +, <a class="el" href="sampDecl_8h.html#4e8339b2b3f5ff1a58cebb74eddca9e6">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#4e8339b2b3f5ff1a58cebb74eddca9e6">sampList.c</a> +<li>samp_getFloatFromMap() +: <a class="el" href="samp_8h.html#89c38f762afd50c85f6ff659bdf0a923">samp.h</a> +, <a class="el" href="sampDecl_8h.html#b0d3768990294554a298c4057b3b315d">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#b0d3768990294554a298c4057b3b315d">sampMap.c</a> +<li>samp_getHandlerReply() +: <a class="el" href="samp_8h.html#0a0d9e41bebb554869f099dcf142a7bf">samp.h</a> +, <a class="el" href="sampMethods_8c.html#eebed5000d39977556e0bc330a020915">sampMethods.c</a> +<li>samp_getIntFromMap() +: <a class="el" href="samp_8h.html#594a51772e9b0693a3c77006eb88c96a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#210fc0eba30abddf1bdc2e780d58072c">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#210fc0eba30abddf1bdc2e780d58072c">sampMap.c</a> +<li>samp_getListFromList() +: <a class="el" href="samp_8h.html#b74e90fdfe79b1c4f7668fdb28d041a1">samp.h</a> +, <a class="el" href="sampDecl_8h.html#1ec1ddadb4e889792b6fa7df6f6c3125">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#1ec1ddadb4e889792b6fa7df6f6c3125">sampList.c</a> +<li>samp_getListFromMap() +: <a class="el" href="samp_8h.html#31ddb90cf2184ae0151b9e7ec8c1a51f">samp.h</a> +, <a class="el" href="sampDecl_8h.html#31ddb90cf2184ae0151b9e7ec8c1a51f">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#31ddb90cf2184ae0151b9e7ec8c1a51f">sampMap.c</a> +<li>samp_getMapFromList() +: <a class="el" href="samp_8h.html#33ca96ee3a8e7d26356c7b66f469da74">samp.h</a> +, <a class="el" href="sampDecl_8h.html#33ca96ee3a8e7d26356c7b66f469da74">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#33ca96ee3a8e7d26356c7b66f469da74">sampList.c</a> +<li>samp_getMapFromMap() +: <a class="el" href="samp_8h.html#525e8ffdfa32867f392f2c1340215453">samp.h</a> +, <a class="el" href="sampDecl_8h.html#525e8ffdfa32867f392f2c1340215453">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#525e8ffdfa32867f392f2c1340215453">sampMap.c</a> +<li>samp_GetMetadata() +: <a class="el" href="samp_8h.html#636e11796b78ae9881e7c61df8516d2a">samp.h</a> +, <a class="el" href="sampCommands_8c.html#2ac4b5c50094c394a74f18d6ebe3cd91">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#2ac4b5c50094c394a74f18d6ebe3cd91">sampDecl.h</a> +<li>samp_getMetadata() +: <a class="el" href="samp_8h.html#def0598aa30c5c1a2276cdddf705de69">samp.h</a> +, <a class="el" href="sampDecl_8h.html#f9622190e1976c42efebd30f0c51cfe4">sampDecl.h</a> +, <a class="el" href="sampUtil_8c.html#ed777ec70a7f11254f04a2ee11be391b">sampUtil.c</a> +<li>samp_getNullMap() +: <a class="el" href="samp_8c.html#6bb8b1f5c6268ad8c7f165733d4af86d">samp.c</a> +, <a class="el" href="samp_8h.html#27baec44edb57136951b5f86ae893246">samp.h</a> +, <a class="el" href="sampDecl_8h.html#27baec44edb57136951b5f86ae893246">sampDecl.h</a> +<li>samp_getOKMap() +: <a class="el" href="samp_8c.html#f299ea13607279f60f16b8639a00658f">samp.c</a> +, <a class="el" href="samp_8h.html#cbf9b52550a9ab0b3515c32e692c46fb">samp.h</a> +, <a class="el" href="sampDecl_8h.html#cbf9b52550a9ab0b3515c32e692c46fb">sampDecl.h</a> +<li>samp_GetRegisteredClients() +: <a class="el" href="samp_8h.html#2c532e076dd6446f079691ed02197a57">samp.h</a> +, <a class="el" href="sampCommands_8c.html#954712a523e3f86826b4711abd35b165">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#954712a523e3f86826b4711abd35b165">sampDecl.h</a> +<li>samp_getSampHandler() +: <a class="el" href="sampDecl_8h.html#6ef18dbc5870f58d2161c9ba03a81d26">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#6ef18dbc5870f58d2161c9ba03a81d26">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#f295f9e7746644f834ac54b1deb95b4c">samp.h</a> +<li>samp_getStringFromList() +: <a class="el" href="samp_8h.html#b101c5b1175490474e41ac9060bdaabf">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2d1cd41c4583ac300aaa2d50ad3f76ed">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#2d1cd41c4583ac300aaa2d50ad3f76ed">sampList.c</a> +<li>samp_getStringFromMap() +: <a class="el" href="samp_8h.html#e615ad9482fa88705b2488a37c987c2a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#96ca606e0e7da659c3dc0a30846bcd66">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#96ca606e0e7da659c3dc0a30846bcd66">sampMap.c</a> +<li>samp_GetSubscribedClients() +: <a class="el" href="samp_8h.html#d28a9085ab8cacbe978e300ac99f6ae5">samp.h</a> +, <a class="el" href="sampCommands_8c.html#367a24fc0aa7a81416e6a0d0dbfcd93f">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#367a24fc0aa7a81416e6a0d0dbfcd93f">sampDecl.h</a> +<li>samp_getUserHandler() +: <a class="el" href="samp_8h.html#ce2ea31b9bd82db4c5040ffd0511bd8b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#6bb258d378627da1aa0254fccdb6bd2c">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#6bb258d378627da1aa0254fccdb6bd2c">sampHandlers.c</a> +<li>samp_hubActive() +: <a class="el" href="samp_8c.html#b2f9c71819e1956e1c29e969968f453c">samp.c</a> +, <a class="el" href="samp_8h.html#14a1f14f60ac385c758346aed0f0272b">samp.h</a> +<li>samp_hubClose() +: <a class="el" href="samp_8h.html#39a580ced499e50d39d327f7709834e7">samp.h</a> +, <a class="el" href="sampDecl_8h.html#52f471568663ac6f0116d57a9ce00f00">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#52f471568663ac6f0116d57a9ce00f00">sampHub.c</a> +<li>samp_hubDeclareMetadata() +: <a class="el" href="samp_8h.html#bf1ae8a1c9c8cf520a22e6ea4d815712">samp.h</a> +, <a class="el" href="sampDecl_8h.html#088f1e762175d0dbc315853d06e50149">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#088f1e762175d0dbc315853d06e50149">sampHub.c</a> +<li>samp_hubDeclareSubscriptions() +: <a class="el" href="samp_8h.html#a6c0f67a76bd1f27898a66fe26b53fdd">samp.h</a> +, <a class="el" href="sampDecl_8h.html#7be493427eac28b2a064eedd8a7d63ff">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#7be493427eac28b2a064eedd8a7d63ff">sampHub.c</a> +<li>samp_hubEvent() +: <a class="el" href="samp_8h.html#a48b9a99f22537127df46a94dfa9ae4a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#19f64b527fcc431541206e41f8e36132">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#19f64b527fcc431541206e41f8e36132">sampHub.c</a> +<li>samp_hubHandler() +: <a class="el" href="sampHandlers_8c.html#bea5fa0cd958545710afcf3c5da9dc15">sampHandlers.c</a> +<li>samp_hubOpen() +: <a class="el" href="samp_8h.html#ef92557afa5ed6731ac0a0a1ba6dfd7c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2b208c34c0e6017f071b9ce654d0f3d6">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#ab66aed8f93a9cd5734a8dd62e427418">sampHub.c</a> +<li>samp_hubPing() +: <a class="el" href="samp_8h.html#155739318fa72883a3e32fccf8a6d5c9">samp.h</a> +, <a class="el" href="sampDecl_8h.html#47b1a9a4627fde97f95b40b372153cf6">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#47b1a9a4627fde97f95b40b372153cf6">sampHub.c</a> +<li>samp_hubRegister() +: <a class="el" href="samp_8h.html#77a14721e2373c805b58f69a018ea69c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#13ad32079ae1db571e3114b7bd8ba356">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#13ad32079ae1db571e3114b7bd8ba356">sampHub.c</a> +<li>samp_hubRunning() +: <a class="el" href="samp_8h.html#a927eb8dcb67e245aeb5a8a4feeb6230">samp.h</a> +, <a class="el" href="sampHub_8c.html#a927eb8dcb67e245aeb5a8a4feeb6230">sampHub.c</a> +<li>samp_hubSendShutdown() +: <a class="el" href="samp_8h.html#6c7b8a8ff1f3c2435d153bc08da87dce">samp.h</a> +, <a class="el" href="sampDecl_8h.html#a704d2a0d290f2fdfb3ebfffc39adcb3">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#a704d2a0d290f2fdfb3ebfffc39adcb3">sampHub.c</a> +<li>samp_hubSetXmlrpcCallback() +: <a class="el" href="samp_8h.html#fc0bfbd699ab2cbce2f755a0506ca6dc">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2fcb0032e5ae98fff93becdb06da49f9">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#2fcb0032e5ae98fff93becdb06da49f9">sampHub.c</a> +<li>samp_hubUnRegister() +: <a class="el" href="samp_8h.html#b0c37311ca30e1fdadfdd1fd16ff3ab4">samp.h</a> +, <a class="el" href="sampDecl_8h.html#6d4e32ed0eb19f02cc8a75f75a98deec">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#6d4e32ed0eb19f02cc8a75f75a98deec">sampHub.c</a> +<li>samp_id2app() +: <a class="el" href="samp_8h.html#343e25bf33431d973d9f81bc25eddcf7">samp.h</a> +, <a class="el" href="sampDecl_8h.html#a75368198ec8cd2fff6ad304806862b8">sampDecl.h</a> +, <a class="el" href="sampUtil_8c.html#a75368198ec8cd2fff6ad304806862b8">sampUtil.c</a> +<li>samp_imageLoadFITS() +: <a class="el" href="samp_8h.html#2ec386ef5bd7dee20ffa1fead0b0210a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#4812b571ed87f7842ca20b7024770df3">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#4812b571ed87f7842ca20b7024770df3">sampMTypes.c</a> +<li>samp_imLoadHandler() +: <a class="el" href="samp_8h.html#9bd8036dd65dc4f874f39568b691a123">samp.h</a> +, <a class="el" href="sampDecl_8h.html#9bd8036dd65dc4f874f39568b691a123">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#9bd8036dd65dc4f874f39568b691a123">sampHandlers.c</a> +<li>samp_listClients() +: <a class="el" href="samp_8c.html#1e494e73abe2ddfd946fb39e84da42a9">samp.c</a> +, <a class="el" href="samp_8h.html#1e494e73abe2ddfd946fb39e84da42a9">samp.h</a> +, <a class="el" href="sampDecl_8h.html#1e494e73abe2ddfd946fb39e84da42a9">sampDecl.h</a> +<li>samp_listLen() +: <a class="el" href="samp_8h.html#c260afb0cbf19b427e3eba96a2341e52">samp.h</a> +, <a class="el" href="sampDecl_8h.html#c260afb0cbf19b427e3eba96a2341e52">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#c260afb0cbf19b427e3eba96a2341e52">sampList.c</a> +<li>samp_mapClients() +: <a class="el" href="samp_8c.html#ff4d125fc9594be25984989fad2fd3c8">samp.c</a> +, <a class="el" href="samp_8h.html#ff4d125fc9594be25984989fad2fd3c8">samp.h</a> +, <a class="el" href="sampDecl_8h.html#ff4d125fc9594be25984989fad2fd3c8">sampDecl.h</a> +<li>samp_Metadata() +: <a class="el" href="samp_8c.html#1428f653b9502c6e6d540f873de2b24f">samp.c</a> +, <a class="el" href="samp_8h.html#2e77115e730e95b31d897b8c50999b74">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2e77115e730e95b31d897b8c50999b74">sampDecl.h</a> +<li>samp_msgParam() +: <a class="el" href="samp_8h.html#281c8f7f8b21a74704dd200d5aaed481">samp.h</a> +, <a class="el" href="sampDecl_8h.html#281c8f7f8b21a74704dd200d5aaed481">sampDecl.h</a> +, <a class="el" href="sampMsg_8c.html#281c8f7f8b21a74704dd200d5aaed481">sampMsg.c</a> +<li>samp_newHandle() +: <a class="el" href="samp_8h.html#711aa545f55e9307f662062deefd5903">samp.h</a> +<li>samp_newList() +: <a class="el" href="samp_8h.html#cdc925da798ee7a1ce30427d47812bd2">samp.h</a> +, <a class="el" href="sampDecl_8h.html#b5375a6478dccefe7df2b48416604b29">sampDecl.h</a> +, <a class="el" href="sampList_8c.html#b5375a6478dccefe7df2b48416604b29">sampList.c</a> +<li>samp_newMap() +: <a class="el" href="samp_8h.html#d88b5d5e9014deba8071f7defd220dbb">samp.h</a> +, <a class="el" href="sampDecl_8h.html#55c96c3dfe79d00b8445a60769785dae">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#9985b96289047cafc24f2adbfeed977f">sampMap.c</a> +<li>samp_newMsg() +: <a class="el" href="samp_8h.html#d343c08e241ff4e17a0eb8fa3d9f4781">samp.h</a> +, <a class="el" href="sampDecl_8h.html#1a66c53bb9e023fb0219ab9baeded3d6">sampDecl.h</a> +, <a class="el" href="sampMsg_8c.html#d6dfdab2715ea070713515754dd499dd">sampMsg.c</a> +<li>samp_newParam() +: <a class="el" href="samp_8h.html#3e2fe98bee9ac2b0c882de78e9b5085f">samp.h</a> +, <a class="el" href="sampDecl_8h.html#c58f0b105566a61785fb9f2ed9b42830">sampDecl.h</a> +, <a class="el" href="sampParam_8c.html#8750d9db641826f700973dae3fcdc920">sampParam.c</a> +<li>samp_notify() +: <a class="el" href="samp_8h.html#c73788ae17493c4042948f6b861ddd74">samp.h</a> +, <a class="el" href="sampClient_8c.html#c73788ae17493c4042948f6b861ddd74">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#c73788ae17493c4042948f6b861ddd74">sampDecl.h</a> +<li>samp_notifyAll() +: <a class="el" href="samp_8h.html#a046d61f43fce831a71621f98b6d9741">samp.h</a> +, <a class="el" href="sampClient_8c.html#f48228224c20ddaf8b4b4ce39fa6ec16">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#f48228224c20ddaf8b4b4ce39fa6ec16">sampDecl.h</a> +<li>samp_nullResponse() +: <a class="el" href="samp_8h.html#5361571754505eaefdf5739cd3e9519e">samp.h</a> +, <a class="el" href="sampDecl_8h.html#5361571754505eaefdf5739cd3e9519e">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#5361571754505eaefdf5739cd3e9519e">sampHandlers.c</a> +<li>samp_P2H() +: <a class="el" href="samp_8h.html#4d0aef2f09b9cce38d4ea8024831c6e5">samp.h</a> +<li>samp_paramGet() +: <a class="el" href="samp_8h.html#4c75de6ddcffde6e3dde7beea68de81c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#19b75403d63714c4fccc8a8d4fa4c8cf">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#19b75403d63714c4fccc8a8d4fa4c8cf">sampMTypes.c</a> +<li>samp_paramGetHandler() +: <a class="el" href="samp_8h.html#659c272ce881662c1826a04728dc06f6">samp.h</a> +, <a class="el" href="sampDecl_8h.html#659c272ce881662c1826a04728dc06f6">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#659c272ce881662c1826a04728dc06f6">sampHandlers.c</a> +<li>samp_paramInit() +: <a class="el" href="sampDecl_8h.html#d8c5669be313874fef1c484643683f49">sampDecl.h</a> +, <a class="el" href="samp_8h.html#f2953eb691b695482ffbbea71948374f">samp.h</a> +, <a class="el" href="sampParam_8c.html#d8c5669be313874fef1c484643683f49">sampParam.c</a> +<li>samp_paramLen() +: <a class="el" href="sampParam_8c.html#7680995e5d4f26ea3d91bf72c9c72e51">sampParam.c</a> +, <a class="el" href="samp_8h.html#5a44618b7681acff67b3883341494d2d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#7680995e5d4f26ea3d91bf72c9c72e51">sampDecl.h</a> +<li>samp_paramSet() +: <a class="el" href="samp_8h.html#7a5c9f092b57dfb3206c8decc8558fd3">samp.h</a> +, <a class="el" href="sampDecl_8h.html#535cb6760c733a75746d2f104b1a01be">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#535cb6760c733a75746d2f104b1a01be">sampMTypes.c</a> +<li>samp_paramSetHandler() +: <a class="el" href="samp_8h.html#071aa9e32f2e94d5b667e87cf65d2bdf">samp.h</a> +, <a class="el" href="sampDecl_8h.html#071aa9e32f2e94d5b667e87cf65d2bdf">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#071aa9e32f2e94d5b667e87cf65d2bdf">sampHandlers.c</a> +<li>samp_Ping() +: <a class="el" href="samp_8h.html#7688cbf8ef852483c077be96151763a6">samp.h</a> +, <a class="el" href="sampCommands_8c.html#2be0812dc8d34c68407c62762f727c51">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#2be0812dc8d34c68407c62762f727c51">sampDecl.h</a> +<li>samp_PingHandler() +: <a class="el" href="sampHandlers_8c.html#16d8b8822d169107b8702ae753797923">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#16d8b8822d169107b8702ae753797923">samp.h</a> +, <a class="el" href="sampDecl_8h.html#16d8b8822d169107b8702ae753797923">sampDecl.h</a> +<li>samp_pointAtHandler() +: <a class="el" href="samp_8h.html#3f5632858a2b09759ffe98cd2e183cfb">samp.h</a> +, <a class="el" href="sampDecl_8h.html#3f5632858a2b09759ffe98cd2e183cfb">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#3f5632858a2b09759ffe98cd2e183cfb">sampHandlers.c</a> +<li>samp_printMap() +: <a class="el" href="samp_8h.html#a8a947c24f2c9333adf4e5d7fa11d134">samp.h</a> +, <a class="el" href="sampDecl_8h.html#a8a947c24f2c9333adf4e5d7fa11d134">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#a8a947c24f2c9333adf4e5d7fa11d134">sampHandlers.c</a> +<li>samp_printMetadata() +: <a class="el" href="sampUtil_8c.html#c7538c339e59556bfd0a87973ad61a43">sampUtil.c</a> +, <a class="el" href="sampDecl_8h.html#ace22fd6ada035930ef93e5a54c375b1">sampDecl.h</a> +, <a class="el" href="samp_8h.html#5b2ef060b3adb18aea7a5a6099c4d0d0">samp.h</a> +<li>samp_processHubEvent() +: <a class="el" href="samp_8h.html#265b5d07cce485a6979fe5f4a2217624">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2933b26ac05c440196368edad0167bdf">sampDecl.h</a> +, <a class="el" href="sampHub_8c.html#2933b26ac05c440196368edad0167bdf">sampHub.c</a> +<li>samp_receiveCall() +: <a class="el" href="samp_8h.html#59f85e0fce4c9ae7121c98e137d3f743">samp.h</a> +, <a class="el" href="sampDecl_8h.html#59f85e0fce4c9ae7121c98e137d3f743">sampDecl.h</a> +, <a class="el" href="sampMethods_8c.html#59f85e0fce4c9ae7121c98e137d3f743">sampMethods.c</a> +<li>samp_receiveNotification() +: <a class="el" href="sampDecl_8h.html#03be7cc9e154a6ccdd499286df640936">sampDecl.h</a> +, <a class="el" href="sampMethods_8c.html#03be7cc9e154a6ccdd499286df640936">sampMethods.c</a> +, <a class="el" href="samp_8h.html#03be7cc9e154a6ccdd499286df640936">samp.h</a> +<li>samp_receiveResponse() +: <a class="el" href="samp_8h.html#754b50ad59145c7fd1e4c8f4277f11e4">samp.h</a> +, <a class="el" href="sampMethods_8c.html#754b50ad59145c7fd1e4c8f4277f11e4">sampMethods.c</a> +, <a class="el" href="sampDecl_8h.html#754b50ad59145c7fd1e4c8f4277f11e4">sampDecl.h</a> +<li>samp_Register() +: <a class="el" href="samp_8h.html#aef9c2f86c7e4f49fe3df343ef06f3ba">samp.h</a> +, <a class="el" href="sampCommands_8c.html#84ffd50bd4b8dc79e9cf32398c6b3d69">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#84ffd50bd4b8dc79e9cf32398c6b3d69">sampDecl.h</a> +<li>samp_removeClient() +: <a class="el" href="samp_8c.html#e30e492f306a40f853a454faf60ab479">samp.c</a> +, <a class="el" href="samp_8h.html#e30e492f306a40f853a454faf60ab479">samp.h</a> +, <a class="el" href="sampDecl_8h.html#e30e492f306a40f853a454faf60ab479">sampDecl.h</a> +<li>samp_Reply() +: <a class="el" href="samp_8h.html#89fc488147fe2e08b4f3c044c7079962">samp.h</a> +, <a class="el" href="sampClient_8c.html#ae0a6eaf06027e28ade8865196f1e2c6">sampClient.c</a> +, <a class="el" href="sampDecl_8h.html#9c6ff3d76997c3d7301a977309a117e0">sampDecl.h</a> +<li>samp_replyStatus() +: <a class="el" href="samp_8c.html#985afa0baeb135c9ee72d09394314ff1">samp.c</a> +, <a class="el" href="sampDecl_8h.html#d47754f3b9fceff4d3019821519432b4">sampDecl.h</a> +, <a class="el" href="samp_8h.html#d47754f3b9fceff4d3019821519432b4">samp.h</a> +<li>samp_resConeHandler() +: <a class="el" href="samp_8h.html#287569451dc1bf59d1f9f6d13b56716d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#287569451dc1bf59d1f9f6d13b56716d">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#287569451dc1bf59d1f9f6d13b56716d">sampHandlers.c</a> +<li>samp_resLoadHandler() +: <a class="el" href="samp_8h.html#c0bf7cf7fea362c0c82ad7bc3f267c48">samp.h</a> +, <a class="el" href="sampDecl_8h.html#c0bf7cf7fea362c0c82ad7bc3f267c48">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#c0bf7cf7fea362c0c82ad7bc3f267c48">sampHandlers.c</a> +<li>samp_resourceLoad() +: <a class="el" href="sampDecl_8h.html#8013c549ef47e0507edf39c8ab1b62aa">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#8013c549ef47e0507edf39c8ab1b62aa">sampMTypes.c</a> +, <a class="el" href="samp_8h.html#a0bb33d232fcb52aaa470d1f1b1a89d7">samp.h</a> +<li>samp_resSiapHandler() +: <a class="el" href="samp_8h.html#8b2300222d7b11f144eb4385412e69a5">samp.h</a> +, <a class="el" href="sampDecl_8h.html#8b2300222d7b11f144eb4385412e69a5">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#8b2300222d7b11f144eb4385412e69a5">sampHandlers.c</a> +<li>samp_resSsapHandler() +: <a class="el" href="sampHandlers_8c.html#866578a01c3b762435823b1b11869c42">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#866578a01c3b762435823b1b11869c42">samp.h</a> +, <a class="el" href="sampDecl_8h.html#866578a01c3b762435823b1b11869c42">sampDecl.h</a> +<li>samp_resTapHandler() +: <a class="el" href="samp_8h.html#ad42ca17cbaf23012ad497559ea45e4c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#ad42ca17cbaf23012ad497559ea45e4c">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#ad42ca17cbaf23012ad497559ea45e4c">sampHandlers.c</a> +<li>samp_resVOSpaceHandler() +: <a class="el" href="sampDecl_8h.html#fa207ebdc587ba5eeab60fbf79b635d4">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#fa207ebdc587ba5eeab60fbf79b635d4">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#fa207ebdc587ba5eeab60fbf79b635d4">samp.h</a> +<li>samp_sendGeneric() +: <a class="el" href="samp_8h.html#5837826e5b4e86b2dda0892c48b96faf">samp.h</a> +, <a class="el" href="sampMTypes_8c.html#b2ff2e029c57b56ad57416c624341fe6">sampMTypes.c</a> +, <a class="el" href="sampDecl_8h.html#b2ff2e029c57b56ad57416c624341fe6">sampDecl.h</a> +<li>samp_sendMsg() +: <a class="el" href="sampDecl_8h.html#80ef1a82845b96091857c7d4a3c7972c">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#80ef1a82845b96091857c7d4a3c7972c">sampMTypes.c</a> +, <a class="el" href="samp_8h.html#4607721d55904450d4066c360d3dcddd">samp.h</a> +<li>samp_serverPort() +: <a class="el" href="sampDecl_8h.html#0af6dba3d1022e6b220a9b1076021353">sampDecl.h</a> +, <a class="el" href="samp_8h.html#6157dc4b47c65323a3015a434cd02e69">samp.h</a> +, <a class="el" href="sampUtil_8c.html#0fb77074a0a38a4eab5dcf4e397dfef3">sampUtil.c</a> +<li>samp_setAppVersion() +: <a class="el" href="samp_8c.html#0f50f8dbae701aa6b19912fc99f6475a">samp.c</a> +, <a class="el" href="sampDecl_8h.html#8fbfdc550ede5d52840300ab33639c49">sampDecl.h</a> +, <a class="el" href="samp_8h.html#8fbfdc550ede5d52840300ab33639c49">samp.h</a> +<li>samp_setASyncMode() +: <a class="el" href="samp_8c.html#9b2292b819e590b1f7c63bbdfaa09e31">samp.c</a> +, <a class="el" href="sampDecl_8h.html#a9aef12dd82bfd38a2382a4ac88c54af">sampDecl.h</a> +, <a class="el" href="samp_8h.html#a9aef12dd82bfd38a2382a4ac88c54af">samp.h</a> +<li>samp_setCallByRef() +: <a class="el" href="samp_8c.html#b6b49029386c3efd0520daa93a4ab3eb">samp.c</a> +, <a class="el" href="samp_8h.html#d4c1514e94c9ef511cfcd27004c38c4d">samp.h</a> +, <a class="el" href="sampDecl_8h.html#d4c1514e94c9ef511cfcd27004c38c4d">sampDecl.h</a> +<li>samp_setCallMode() +: <a class="el" href="samp_8c.html#3e01437224c73b91e49c6428cb69735d">samp.c</a> +, <a class="el" href="samp_8h.html#fc27715ec9a5cb60cf0b5415eb7f9a48">samp.h</a> +, <a class="el" href="sampDecl_8h.html#fc27715ec9a5cb60cf0b5415eb7f9a48">sampDecl.h</a> +<li>samp_setErr() +: <a class="el" href="sampDecl_8h.html#91aeabe77e920fc1924b1cdc4f088e64">sampDecl.h</a> +, <a class="el" href="sampClient_8c.html#91aeabe77e920fc1924b1cdc4f088e64">sampClient.c</a> +, <a class="el" href="samp_8h.html#3c026895e4d28567eb63c3b9cc16cd40">samp.h</a> +<li>samp_setFloatInList() +: <a class="el" href="samp_8h.html#041a551aff57ca03f3ff72a9803e2b58">samp.h</a> +, <a class="el" href="sampList_8c.html#18d586491620a63b3a4d6c3667ee2aa5">sampList.c</a> +, <a class="el" href="sampDecl_8h.html#041a551aff57ca03f3ff72a9803e2b58">sampDecl.h</a> +<li>samp_setFloatInMap() +: <a class="el" href="sampDecl_8h.html#0f07ae542f5b317311b3799bd96a88fd">sampDecl.h</a> +, <a class="el" href="samp_8h.html#0f07ae542f5b317311b3799bd96a88fd">samp.h</a> +, <a class="el" href="sampMap_8c.html#0f07ae542f5b317311b3799bd96a88fd">sampMap.c</a> +<li>samp_setHandlerReply() +: <a class="el" href="samp_8h.html#1cd88b9e964d61403d6aad89dddce591">samp.h</a> +, <a class="el" href="sampMethods_8c.html#82fec51207e326e6373e174bb6855634">sampMethods.c</a> +<li>samp_setIntInList() +: <a class="el" href="sampList_8c.html#a803bead8b452de6e1d08b8b3b9e8828">sampList.c</a> +, <a class="el" href="samp_8h.html#2d8a8a26d7284bb211a933895cddd29c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2d8a8a26d7284bb211a933895cddd29c">sampDecl.h</a> +<li>samp_setIntInMap() +: <a class="el" href="sampDecl_8h.html#c22ec42dbf9a01c9b4e00cf011e7eb9d">sampDecl.h</a> +, <a class="el" href="samp_8h.html#c22ec42dbf9a01c9b4e00cf011e7eb9d">samp.h</a> +, <a class="el" href="sampMap_8c.html#c22ec42dbf9a01c9b4e00cf011e7eb9d">sampMap.c</a> +<li>samp_setListInList() +: <a class="el" href="samp_8h.html#0ff97d44e62b7c88a046a29324552400">samp.h</a> +, <a class="el" href="sampList_8c.html#0ff97d44e62b7c88a046a29324552400">sampList.c</a> +, <a class="el" href="sampDecl_8h.html#0ff97d44e62b7c88a046a29324552400">sampDecl.h</a> +<li>samp_setListInMap() +: <a class="el" href="sampDecl_8h.html#362c2f670c98dd6a3ef69debd1871604">sampDecl.h</a> +, <a class="el" href="samp_8h.html#362c2f670c98dd6a3ef69debd1871604">samp.h</a> +, <a class="el" href="sampMap_8c.html#362c2f670c98dd6a3ef69debd1871604">sampMap.c</a> +<li>samp_setMapInList() +: <a class="el" href="samp_8h.html#ea188bb711f3b5549d11204b0ff2da08">samp.h</a> +, <a class="el" href="sampList_8c.html#ea188bb711f3b5549d11204b0ff2da08">sampList.c</a> +, <a class="el" href="sampDecl_8h.html#ea188bb711f3b5549d11204b0ff2da08">sampDecl.h</a> +<li>samp_setMapInMap() +: <a class="el" href="sampMap_8c.html#f102490efe1b92d99b67f244dc498c7b">sampMap.c</a> +, <a class="el" href="samp_8h.html#f102490efe1b92d99b67f244dc498c7b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#f102490efe1b92d99b67f244dc498c7b">sampDecl.h</a> +<li>samp_setMsgMode() +: <a class="el" href="samp_8c.html#01721eabf3e664bae3bea0c2b72268e2">samp.c</a> +, <a class="el" href="samp_8h.html#68b51d70127bbff10fd30396e40a482d">samp.h</a> +<li>samp_setNotifyMode() +: <a class="el" href="samp_8c.html#7bfbc2e767fe234f83c13b8316a09ecd">samp.c</a> +, <a class="el" href="sampDecl_8h.html#9056a8601300892f918835259c7fdb3b">sampDecl.h</a> +, <a class="el" href="samp_8h.html#9056a8601300892f918835259c7fdb3b">samp.h</a> +<li>samp_setReplyCallback() +: <a class="el" href="samp_8c.html#a3c0bdb4c512357dbc53b0ad7a7d5b01">samp.c</a> +, <a class="el" href="samp_8h.html#a3c0bdb4c512357dbc53b0ad7a7d5b01">samp.h</a> +, <a class="el" href="sampDecl_8h.html#a3c0bdb4c512357dbc53b0ad7a7d5b01">sampDecl.h</a> +<li>samp_setResponseCallback() +: <a class="el" href="samp_8c.html#3db66f28546459327665f8491ea97f4d">samp.c</a> +, <a class="el" href="sampDecl_8h.html#3db66f28546459327665f8491ea97f4d">sampDecl.h</a> +, <a class="el" href="samp_8h.html#3db66f28546459327665f8491ea97f4d">samp.h</a> +<li>samp_setSampHandler() +: <a class="el" href="sampDecl_8h.html#2e8ec01a0dd96314622ae313206583db">sampDecl.h</a> +, <a class="el" href="samp_8h.html#8b83cf8a75c16c45c547be68f0bf9f64">samp.h</a> +, <a class="el" href="sampHandlers_8c.html#2e8ec01a0dd96314622ae313206583db">sampHandlers.c</a> +<li>samp_setStringInList() +: <a class="el" href="sampList_8c.html#5b69180b036e58528c98b1cf5a42825a">sampList.c</a> +, <a class="el" href="samp_8h.html#5b69180b036e58528c98b1cf5a42825a">samp.h</a> +, <a class="el" href="sampDecl_8h.html#5b69180b036e58528c98b1cf5a42825a">sampDecl.h</a> +<li>samp_setStringInMap() +: <a class="el" href="sampDecl_8h.html#b9b2157de89369eb5cd95bfe804eb89a">sampDecl.h</a> +, <a class="el" href="sampMap_8c.html#b9b2157de89369eb5cd95bfe804eb89a">sampMap.c</a> +, <a class="el" href="samp_8h.html#b9b2157de89369eb5cd95bfe804eb89a">samp.h</a> +<li>samp_setSyncMode() +: <a class="el" href="sampDecl_8h.html#1d00dc78292cfbc01262ef65ab055063">sampDecl.h</a> +, <a class="el" href="samp_8c.html#d636ae12dd05df43a077f91882a197ec">samp.c</a> +, <a class="el" href="samp_8h.html#1d00dc78292cfbc01262ef65ab055063">samp.h</a> +<li>samp_setTimeout() +: <a class="el" href="samp_8h.html#e11a97c262ab5ab4438eca6c60c0d8cf">samp.h</a> +, <a class="el" href="samp_8c.html#c057d32437a96a527c63f938757099af">samp.c</a> +, <a class="el" href="sampDecl_8h.html#e11a97c262ab5ab4438eca6c60c0d8cf">sampDecl.h</a> +<li>samp_setUserHandler() +: <a class="el" href="samp_8h.html#b969017f97d850b092bde60a2d445a2b">samp.h</a> +, <a class="el" href="sampHandlers_8c.html#81222e1f3572585fa30f11a78aa08c3f">sampHandlers.c</a> +, <a class="el" href="sampDecl_8h.html#81222e1f3572585fa30f11a78aa08c3f">sampDecl.h</a> +<li>samp_specLoadHandler() +: <a class="el" href="sampHandlers_8c.html#bc319b97b3dbea29bd79c4f723db5438">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#bc319b97b3dbea29bd79c4f723db5438">samp.h</a> +, <a class="el" href="sampDecl_8h.html#bc319b97b3dbea29bd79c4f723db5438">sampDecl.h</a> +<li>samp_specLoadSSAGeneric() +: <a class="el" href="sampMTypes_8c.html#18b351385bd175581a6788a4f7342f07">sampMTypes.c</a> +, <a class="el" href="sampDecl_8h.html#18b351385bd175581a6788a4f7342f07">sampDecl.h</a> +, <a class="el" href="samp_8h.html#4869a1bb04a96514f153dc5bfbed8e6e">samp.h</a> +<li>samp_specSSAHandler() +: <a class="el" href="samp_8h.html#dd2bca8fa3bf3b4ebbf449edc6b65d85">samp.h</a> +, <a class="el" href="sampDecl_8h.html#dd2bca8fa3bf3b4ebbf449edc6b65d85">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#dd2bca8fa3bf3b4ebbf449edc6b65d85">sampHandlers.c</a> +<li>samp_StatusHandler() +: <a class="el" href="sampHandlers_8c.html#2e342b672e77e012cc98a6f5506a44be">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#2e342b672e77e012cc98a6f5506a44be">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2e342b672e77e012cc98a6f5506a44be">sampDecl.h</a> +<li>samp_Subscribe() +: <a class="el" href="samp_8c.html#ed050606c5076a4a34eb8f0f982a25d4">samp.c</a> +, <a class="el" href="sampDecl_8h.html#c6b76655d73825acdacfac8b5a1139ee">sampDecl.h</a> +, <a class="el" href="samp_8h.html#c6b76655d73825acdacfac8b5a1139ee">samp.h</a> +<li>samp_tableHighlightRow() +: <a class="el" href="sampMTypes_8c.html#e38ac987f1dfd87ad64f97d55396270e">sampMTypes.c</a> +, <a class="el" href="sampDecl_8h.html#e38ac987f1dfd87ad64f97d55396270e">sampDecl.h</a> +, <a class="el" href="samp_8h.html#0503d3ee247a6a962a2a8da672261ab7">samp.h</a> +<li>samp_tableLoadFITS() +: <a class="el" href="sampDecl_8h.html#74aeaaf742121348390ec854c30c1479">sampDecl.h</a> +, <a class="el" href="sampMTypes_8c.html#74aeaaf742121348390ec854c30c1479">sampMTypes.c</a> +, <a class="el" href="samp_8h.html#6b950e53c7fdf481a13c8a2ec353dca1">samp.h</a> +<li>samp_tableLoadVOTable() +: <a class="el" href="sampMTypes_8c.html#34e9d38073f36daaf41c418f8d680ee5">sampMTypes.c</a> +, <a class="el" href="sampDecl_8h.html#34e9d38073f36daaf41c418f8d680ee5">sampDecl.h</a> +, <a class="el" href="samp_8h.html#45c2023312cd2adfa40feb2eb8a3e143">samp.h</a> +<li>samp_tableSelectRowList() +: <a class="el" href="samp_8h.html#a410ef908863f7c5b2c99844ebb73d35">samp.h</a> +, <a class="el" href="sampMTypes_8c.html#f133efb67fe4bcfd2b9c8ab9d23b4c5e">sampMTypes.c</a> +, <a class="el" href="sampDecl_8h.html#f133efb67fe4bcfd2b9c8ab9d23b4c5e">sampDecl.h</a> +<li>samp_tbHighlightHandler() +: <a class="el" href="sampDecl_8h.html#d9184eb45a5bc93b5205fd5b1c6ef688">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#d9184eb45a5bc93b5205fd5b1c6ef688">sampHandlers.c</a> +, <a class="el" href="samp_8h.html#d9184eb45a5bc93b5205fd5b1c6ef688">samp.h</a> +<li>samp_tbLoadFITSHandler() +: <a class="el" href="samp_8h.html#750c0fee0c7a99e135299c08751f288c">samp.h</a> +, <a class="el" href="sampDecl_8h.html#750c0fee0c7a99e135299c08751f288c">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#750c0fee0c7a99e135299c08751f288c">sampHandlers.c</a> +<li>samp_tbLoadHandler() +: <a class="el" href="sampDecl_8h.html#26f96dc6cbf72283e2ee9cb8b4619ed3">sampDecl.h</a> +, <a class="el" href="samp_8h.html#26f96dc6cbf72283e2ee9cb8b4619ed3">samp.h</a> +, <a class="el" href="sampHandlers_8c.html#26f96dc6cbf72283e2ee9cb8b4619ed3">sampHandlers.c</a> +<li>samp_tbLoadVOTHandler() +: <a class="el" href="samp_8h.html#144ec2329355d91022d5ea38736c0093">samp.h</a> +, <a class="el" href="sampDecl_8h.html#144ec2329355d91022d5ea38736c0093">sampDecl.h</a> +, <a class="el" href="sampHandlers_8c.html#144ec2329355d91022d5ea38736c0093">sampHandlers.c</a> +<li>samp_tbSelectHandler() +: <a class="el" href="sampDecl_8h.html#98d68d7091c0b7790631bb53e0ace656">sampDecl.h</a> +, <a class="el" href="samp_8h.html#98d68d7091c0b7790631bb53e0ace656">samp.h</a> +, <a class="el" href="sampHandlers_8c.html#98d68d7091c0b7790631bb53e0ace656">sampHandlers.c</a> +<li>samp_UnRegister() +: <a class="el" href="samp_8h.html#5e3a44429f332694cc2cedc2e38856ce">samp.h</a> +, <a class="el" href="sampCommands_8c.html#106fc27544de7c25625ed60eb48e4edd">sampCommands.c</a> +, <a class="el" href="sampDecl_8h.html#106fc27544de7c25625ed60eb48e4edd">sampDecl.h</a> +<li>samp_Unsubscribe() +: <a class="el" href="samp_8h.html#b3fded97bbbf3751c4916543959f16a5">samp.h</a> +, <a class="el" href="sampDecl_8h.html#b3fded97bbbf3751c4916543959f16a5">sampDecl.h</a> +, <a class="el" href="samp_8c.html#dc0e418fbaee507e661260c4480ecfcd">samp.c</a> +<li>sampClose() +: <a class="el" href="sampDecl_8h.html#123413db26ad50a84bd41863af5deae5">sampDecl.h</a> +, <a class="el" href="samp_8h.html#123413db26ad50a84bd41863af5deae5">samp.h</a> +, <a class="el" href="samp_8c.html#f861f637942c5f971bab824708581f82">samp.c</a> +<li>sampDebug() +: <a class="el" href="samp_8h.html#124214f79e99619b377d98ed2fd93eb9">samp.h</a> +, <a class="el" href="samp_8c.html#6bfd947988e5dbc846af7f99bcd99ee7">samp.c</a> +<li>sampInit() +: <a class="el" href="samp_8h.html#30f39c72c3783055faa82ad3860f3d1d">samp.h</a> +, <a class="el" href="samp_8c.html#db03c60f2933ed9785bfb4457c359af2">samp.c</a> +, <a class="el" href="sampDecl_8h.html#30f39c72c3783055faa82ad3860f3d1d">sampDecl.h</a> +<li>sampLog() +: <a class="el" href="sampLog_8c.html#4919f892b6fccced4e6b9d777071b781">sampLog.c</a> +, <a class="el" href="sampDecl_8h.html#4919f892b6fccced4e6b9d777071b781">sampDecl.h</a> +, <a class="el" href="samp_8h.html#329a8a5f83162ed49baa28f008131d45">samp.h</a> +<li>sampShutdown() +: <a class="el" href="samp_8h.html#65908d088c8b917d10db38c147590ad9">samp.h</a> +, <a class="el" href="samp_8c.html#d634392fbb12cf4e1b2eb05da34759c5">samp.c</a> +, <a class="el" href="sampDecl_8h.html#65908d088c8b917d10db38c147590ad9">sampDecl.h</a> +<li>sampStartup() +: <a class="el" href="samp_8h.html#8e18ae12df031094ace47863f93b3634">samp.h</a> +, <a class="el" href="sampDecl_8h.html#8e18ae12df031094ace47863f93b3634">sampDecl.h</a> +, <a class="el" href="samp_8c.html#1f6d544576fec785be1acfeaf3f2cf63">samp.c</a> +<li>sampTrace() +: <a class="el" href="sampLog_8c.html#2b3dd1662e61c83e29109126689b08b9">sampLog.c</a> +, <a class="el" href="samp_8h.html#65e3987c9b510018dcdd91203b437e40">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2b3dd1662e61c83e29109126689b08b9">sampDecl.h</a> +<li>sampVerbose() +: <a class="el" href="samp_8h.html#c0c812e5d3f2c9ee6c54067e4c81b3dd">samp.h</a> +, <a class="el" href="samp_8c.html#e3a6e918b3fe22db2fe014da16f81aad">samp.c</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_type.html b/vendor/voclient/libsamp/doc/html/globals_type.html new file mode 100644 index 00000000..8f5f5751 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_type.html @@ -0,0 +1,57 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li><a href="globals_vars.html"><span>Variables</span></a></li> + <li class="current"><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<ul> +<li>List +: <a class="el" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">samp.h</a> +, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">sampDecl.h</a> +<li>Map +: <a class="el" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">samp.h</a> +, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">sampDecl.h</a> +<li>Msg +: <a class="el" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">samp.h</a> +, <a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">sampDecl.h</a> +<li>Param +: <a class="el" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">samp.h</a> +, <a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">sampDecl.h</a> +<li>String +: <a class="el" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">samp.h</a> +, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">sampDecl.h</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/globals_vars.html b/vendor/voclient/libsamp/doc/html/globals_vars.html new file mode 100644 index 00000000..7fab33c1 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/globals_vars.html @@ -0,0 +1,68 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Data Fields</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li class="current"><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="globals.html"><span>All</span></a></li> + <li><a href="globals_func.html"><span>Functions</span></a></li> + <li class="current"><a href="globals_vars.html"><span>Variables</span></a></li> + <li><a href="globals_type.html"><span>Typedefs</span></a></li> + <li><a href="globals_defs.html"><span>Defines</span></a></li> + </ul> + </div> +</div> +<div class="contents"> + +<p> +<ul> +<li>hub +: <a class="el" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">samp.c</a> +, <a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">sampHub.c</a> +<li>hubHandles +: <a class="el" href="samp_8c.html#dbf72aff0293f6556c1c6a2f4a62e2b9">samp.c</a> +, <a class="el" href="sampHub_8c.html#86b0db44d25bc3079d8d9d75e01a0ecd">sampHub.c</a> +<li>nullList +: <a class="el" href="samp_8c.html#a2106c7fe3a5747178c046238fbd5d55">samp.c</a> +, <a class="el" href="sampHandlers_8c.html#a2106c7fe3a5747178c046238fbd5d55">sampHandlers.c</a> +, <a class="el" href="sampMethods_8c.html#a2106c7fe3a5747178c046238fbd5d55">sampMethods.c</a> +<li>nullMap +: <a class="el" href="sampMethods_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">sampMethods.c</a> +, <a class="el" href="samp_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">samp.c</a> +, <a class="el" href="sampHandlers_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">sampHandlers.c</a> +, <a class="el" href="sampHub_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">sampHub.c</a> +<li>numHubs +: <a class="el" href="sampHub_8c.html#037f00cb1101b007b4bf45e8bee1bd3e">sampHub.c</a> +, <a class="el" href="samp_8c.html#037f00cb1101b007b4bf45e8bee1bd3e">samp.c</a> +<li>OK_Map +: <a class="el" href="samp_8c.html#a68efe925f0d8f29fa203c0f3747a6e2">samp.c</a> +<li>samp_mutex +: <a class="el" href="sampHub_8c.html#c49d9bc6850c63f257c18f2920915d9c">sampHub.c</a> +<li>sampH +: <a class="el" href="sampMethods_8c.html#b04b61ee02d86e15b02b861699ae7424">sampMethods.c</a> +, <a class="el" href="sampHandlers_8c.html#b04b61ee02d86e15b02b861699ae7424">sampHandlers.c</a> +, <a class="el" href="samp_8c.html#b04b61ee02d86e15b02b861699ae7424">samp.c</a> +</ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/index.html b/vendor/voclient/libsamp/doc/html/index.html new file mode 100644 index 00000000..baf13dea --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/index.html @@ -0,0 +1,25 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Main Page</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li class="current"><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>SAMP Client Library Documentation</h1> +<p> +<h3 align="center">v1.0 </h3></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampClient_8c.html b/vendor/voclient/libsamp/doc/html/sampClient_8c.html new file mode 100644 index 00000000..5627b620 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampClient_8c.html @@ -0,0 +1,497 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampClient.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampClient.c File Reference</h1><a class="el" href="structClient.html">Client</a> callable methods. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampClient_8c.html#c73788ae17493c4042948f6b861ddd74">samp_notify</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a notify() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#c73788ae17493c4042948f6b861ddd74"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampClient_8c.html#f48228224c20ddaf8b4b4ce39fa6ec16">samp_notifyAll</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a notifyAll() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#f48228224c20ddaf8b4b4ce39fa6ec16"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampClient_8c.html#68d7703657197a3d9256729cf2971033">samp_call</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a call() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#68d7703657197a3d9256729cf2971033"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampClient_8c.html#66d67a1ba0dff1f6dab68f74299f500a">samp_callAll</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a callAll() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#66d67a1ba0dff1f6dab68f74299f500a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampClient_8c.html#6780568b9e9dfae5b361c2b2e52c16ed">samp_callAndWait</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a callAndWait() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#6780568b9e9dfae5b361c2b2e52c16ed"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampClient_8c.html#ae0a6eaf06027e28ade8865196f1e2c6">samp_Reply</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> response)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reply to a message. <a href="#ae0a6eaf06027e28ade8865196f1e2c6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampClient_8c.html#0a996f4e24693c2eacba579ecbceedbb">samp_clientName</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structClient.html">Client</a> name from a pubic-id. <a href="#0a996f4e24693c2eacba579ecbceedbb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampClient_8c.html#91aeabe77e920fc1924b1cdc4f088e64">samp_setErr</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the error response string. <a href="#91aeabe77e920fc1924b1cdc4f088e64"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampClient_8c.html#4946a754670217dbdbc83cca92217022">samp_getErr</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the error response string. <a href="#4946a754670217dbdbc83cca92217022"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +<a class="el" href="structClient.html">Client</a> callable methods. +<p> +SAMPCLIENT.C -- <a class="el" href="structClient.html">Client</a> callable methods.<p> +samp_notify (handle, recipId, msg_map) list = samp_notifyAll (handle, msg_map) str = samp_call (handle, recipId, tag, msg_map) map = samp_callAll (handle, msg_tag, msg_map) map = samp_callAndWait (handle, recipId, msg_tag, msg_map) stat = samp_Reply (handle, msg_id, resp_map)<p> +str = samp_clientName (handle, pubId) stat = samp_setErr (handle, resp_map) str = samp_getErr (handle)<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/11 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="68d7703657197a3d9256729cf2971033"></a><!-- doxytag: member="sampClient.c::samp_call" ref="68d7703657197a3d9256729cf2971033" args="(handle_t handle, String recipId, String msg_tag, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> samp_call </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recipId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a call() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_CALL -- Make a call() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recipId</em> </td><td>recipient ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_tag</em> </td><td>message tag </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>message ID </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="66d67a1ba0dff1f6dab68f74299f500a"></a><!-- doxytag: member="sampClient.c::samp_callAll" ref="66d67a1ba0dff1f6dab68f74299f500a" args="(handle_t handle, String msg_tag, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_callAll </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a callAll() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_CALLALL -- Make a callAll() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_tag</em> </td><td>message tag </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampClient_8c_source.html#l00360">samp_setErr()</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6780568b9e9dfae5b361c2b2e52c16ed"></a><!-- doxytag: member="sampClient.c::samp_callAndWait" ref="6780568b9e9dfae5b361c2b2e52c16ed" args="(handle_t handle, String recipId, String msg_tag, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_callAndWait </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recipId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a callAndWait() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_CALLANDWAIT -- Make a callAndWait() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recipId</em> </td><td>recipient ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_tag</em> </td><td>message tag </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampClient_8c_source.html#l00360">samp_setErr()</a>, <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0a996f4e24693c2eacba579ecbceedbb"></a><!-- doxytag: member="sampClient.c::samp_clientName" ref="0a996f4e24693c2eacba579ecbceedbb" args="(handle_t handle, String pubId)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> samp_clientName </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>pubId</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the <a class="el" href="structClient.html">Client</a> name from a pubic-id. +<p> +SAMP_CLIENTNAME -- Get the <a class="el" href="structClient.html">Client</a> name from a pubic-id.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>pubId</em> </td><td>public ID </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>declared application name </dd></dl> + +</div> +</div><p> +<a class="anchor" name="4946a754670217dbdbc83cca92217022"></a><!-- doxytag: member="sampClient.c::samp_getErr" ref="4946a754670217dbdbc83cca92217022" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> samp_getErr </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the error response string. +<p> +SAMP_GETERR -- Get the error response string.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Error text string </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c73788ae17493c4042948f6b861ddd74"></a><!-- doxytag: member="sampClient.c::samp_notify" ref="c73788ae17493c4042948f6b861ddd74" args="(handle_t handle, String recipId, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_notify </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recipId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a notify() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_NOTIFY -- Make a notify() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recipId</em> </td><td>recipient ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, and <a class="el" href="sampHandlers_8c_source.html#l01582">samp_nullResponse()</a>.</p> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f48228224c20ddaf8b4b4ce39fa6ec16"></a><!-- doxytag: member="sampClient.c::samp_notifyAll" ref="f48228224c20ddaf8b4b4ce39fa6ec16" args="(handle_t handle, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_notifyAll </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a notifyAll() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_NOTIFYALL -- Make a notifyAll() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ae0a6eaf06027e28ade8865196f1e2c6"></a><!-- doxytag: member="sampClient.c::samp_Reply" ref="ae0a6eaf06027e28ade8865196f1e2c6" args="(handle_t handle, String msg_id, Map response)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_Reply </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>response</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reply to a message. +<p> +SAMP_REPLY -- Reply to a message. All we do here is send the reply message, we require that the response Map already be defined.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>response</em> </td><td>response map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, and <a class="el" href="sampHandlers_8c_source.html#l01582">samp_nullResponse()</a>.</p> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="91aeabe77e920fc1924b1cdc4f088e64"></a><!-- doxytag: member="sampClient.c::samp_setErr" ref="91aeabe77e920fc1924b1cdc4f088e64" args="(handle_t handle, Map resp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_setErr </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>resp</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the error response string. +<p> +SAMP_SETERR -- Set the error response string/code.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>resp</em> </td><td>Response map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>.</p> + +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampCommands_8c.html b/vendor/voclient/libsamp/doc/html/sampCommands_8c.html new file mode 100644 index 00000000..9e26df34 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampCommands_8c.html @@ -0,0 +1,362 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampCommands.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampCommands.c File Reference</h1>SAMP commands used by app to send administrative messages. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include <time.h></code><br> +<code>#include <ctype.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampCommands_8c.html#84ffd50bd4b8dc79e9cf32398c6b3d69">samp_Register</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Register with the <a class="el" href="structHub.html">Hub</a> using the currently stored metadata. <a href="#84ffd50bd4b8dc79e9cf32398c6b3d69"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampCommands_8c.html#106fc27544de7c25625ed60eb48e4edd">samp_UnRegister</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Un-Register from the hub. <a href="#106fc27544de7c25625ed60eb48e4edd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampCommands_8c.html#9c6024ae76103069355256c29ee22722">samp_DeclareMetadata</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(Re)Declare all of our metadata. <a href="#9c6024ae76103069355256c29ee22722"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampCommands_8c.html#2be0812dc8d34c68407c62762f727c51">samp_Ping</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Ping the hub/app to see if it is alive (returns >0). <a href="#2be0812dc8d34c68407c62762f727c51"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampCommands_8c.html#2ac4b5c50094c394a74f18d6ebe3cd91">samp_GetMetadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metadata for a specified app. <a href="#2ac4b5c50094c394a74f18d6ebe3cd91"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampCommands_8c.html#d2b0bdea58688142f55faeffcfc65525">samp_DeclareSubscriptions</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare the messages we're interested in. <a href="#d2b0bdea58688142f55faeffcfc65525"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4f65b6315c8bd7380176d2b97462354"></a><!-- doxytag: member="sampCommands.c::samp_GetSubscriptions" ref="c4f65b6315c8bd7380176d2b97462354" args="(handle_t handle, String pubId)" --> +<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><b>samp_GetSubscriptions</b> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampCommands_8c.html#954712a523e3f86826b4711abd35b165">samp_GetRegisteredClients</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get public-ids of the registered clients. <a href="#954712a523e3f86826b4711abd35b165"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampCommands_8c.html#367a24fc0aa7a81416e6a0d0dbfcd93f">samp_GetSubscribedClients</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get clients matching the mtype subscription. <a href="#367a24fc0aa7a81416e6a0d0dbfcd93f"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +SAMP commands used by app to send administrative messages. +<p> +SAMPCOMMANDS.C -- SAMP commands used by app to send administrative messages.<p> +stat = samp_Register (handle) stat = samp_UnRegister (handle) stat = samp_DeclareMetadata (handle) stat = samp_Ping (handle, appName) map = samp_GetMetadata (handle, pubId) samp_DeclareSubscriptions (handle) map = samp_GetSubscriptions (handle) list = samp_GetRegisteredClients (handle) list = samp_GetSubscribedClients (handle, mtype)<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/11 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="9c6024ae76103069355256c29ee22722"></a><!-- doxytag: member="sampCommands.c::samp_DeclareMetadata" ref="9c6024ae76103069355256c29ee22722" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_DeclareMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +(Re)Declare all of our metadata. +<p> +SAMP_DECLAREMETATA -- (Re)Declare all of our metadata.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, and <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d2b0bdea58688142f55faeffcfc65525"></a><!-- doxytag: member="sampCommands.c::samp_DeclareSubscriptions" ref="d2b0bdea58688142f55faeffcfc65525" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_DeclareSubscriptions </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declare the messages we're interested in. +<p> +SAMP_DECLARESUBSCRIPIONS -- Declare the messages we're interested in.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, and <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00507">samp_Unsubscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2ac4b5c50094c394a74f18d6ebe3cd91"></a><!-- doxytag: member="sampCommands.c::samp_GetMetadata" ref="2ac4b5c50094c394a74f18d6ebe3cd91" args="(handle_t handle, String pubId)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_GetMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>pubId</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the metadata for a specified app. +<p> +SAMP_GETMETADATA -- Get the metadata for a specified app.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>pubId</em> </td><td>App public-id </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Map to message response </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, and <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="954712a523e3f86826b4711abd35b165"></a><!-- doxytag: member="sampCommands.c::samp_GetRegisteredClients" ref="954712a523e3f86826b4711abd35b165" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_GetRegisteredClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get public-ids of the registered clients. +<p> +SAMP_GETREGISTEREDCLIENTS -- Get public-ids of the registered clients.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to list of registered clients </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, <a class="el" href="sampList_8c_source.html#l00047">samp_newList()</a>, and <a class="el" href="sampList_8c_source.html#l00101">samp_setStringInList()</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="367a24fc0aa7a81416e6a0d0dbfcd93f"></a><!-- doxytag: member="sampCommands.c::samp_GetSubscribedClients" ref="367a24fc0aa7a81416e6a0d0dbfcd93f" args="(handle_t handle, String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_GetSubscribedClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get clients matching the mtype subscription. +<p> +SAMP_GETSUBSCRIBEDCLIENTS -- Get clients matching the mtype subscription.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to list of clients having mtype subscription </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, <a class="el" href="sampList_8c_source.html#l00047">samp_newList()</a>, and <a class="el" href="sampList_8c_source.html#l00101">samp_setStringInList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2be0812dc8d34c68407c62762f727c51"></a><!-- doxytag: member="sampCommands.c::samp_Ping" ref="2be0812dc8d34c68407c62762f727c51" args="(handle_t handle, String appName)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_Ping </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>appName</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Ping the hub/app to see if it is alive (returns >0). +<p> +SAMP_PING -- Ping the hub/app to see if it is alive (returns >0).<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>appName</em> </td><td>application name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>OK or ERR if no response </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMap_8c_source.html#l00067">samp_freeMap()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampHub_8c_source.html#l00483">samp_hubPing()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampClient_8c_source.html#l00360">samp_setErr()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="84ffd50bd4b8dc79e9cf32398c6b3d69"></a><!-- doxytag: member="sampCommands.c::samp_Register" ref="84ffd50bd4b8dc79e9cf32398c6b3d69" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_Register </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Register with the <a class="el" href="structHub.html">Hub</a> using the currently stored metadata. +<p> +SAMP_REGISTER -- Register with the <a class="el" href="structHub.html">Hub</a> using the currently stored metadata.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00157">Hub::hubId</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="samp_8c_source.html#l00723">samp_replyStatus()</a>, <a class="el" href="samp_8h_source.html#l00149">Hub::secret</a>, and <a class="el" href="samp_8h_source.html#l00158">Hub::selfId</a>.</p> + +</div> +</div><p> +<a class="anchor" name="106fc27544de7c25625ed60eb48e4edd"></a><!-- doxytag: member="sampCommands.c::samp_UnRegister" ref="106fc27544de7c25625ed60eb48e4edd" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_UnRegister </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Un-Register from the hub. +<p> +SAMP_UNREGISTER -- Un-Register from the hub.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, and <a class="el" href="sampHub_8c_source.html#l00395">samp_hubUnRegister()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampDecl_8h.html b/vendor/voclient/libsamp/doc/html/sampDecl_8h.html new file mode 100644 index 00000000..f7993df2 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampDecl_8h.html @@ -0,0 +1,6737 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampDecl.h File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampDecl.h File Reference</h1>SAMP interface method declarations. +<a href="#_details">More...</a> +<p> + +<p> +<a href="sampDecl_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structappMD.html">appMD</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structSubs.html">Subs</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structClient.html">Client</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html">Hub</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html">Samp</a></td></tr> + +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a> 256</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="32108415ff44b6f7537b9516f4a84be7"></a><!-- doxytag: member="sampDecl.h::SZ_LINE" ref="32108415ff44b6f7537b9516f4a84be7" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_LINE</b> 256</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b6cc171ab550fcd6c34d92e010fcec3"></a><!-- doxytag: member="sampDecl.h::SZ_SECRET" ref="7b6cc171ab550fcd6c34d92e010fcec3" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_SECRET</b> 64</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e01a6ceff717c54fca995bb444611a8"></a><!-- doxytag: member="sampDecl.h::SZ_DESC" ref="3e01a6ceff717c54fca995bb444611a8" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_DESC</b> 8192</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="76e806c1a560659f0c849d427b64644a"></a><!-- doxytag: member="sampDecl.h::SZ_URL" ref="76e806c1a560659f0c849d427b64644a" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_URL</b> 1024</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08329a2ecb12005e4089db9f336bde2a"></a><!-- doxytag: member="sampDecl.h::SZ_CMD" ref="08329a2ecb12005e4089db9f336bde2a" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_CMD</b> 1024</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e5a1caf522da4cb934712482b0aed5b"></a><!-- doxytag: member="sampDecl.h::MAX_SAMPS" ref="6e5a1caf522da4cb934712482b0aed5b" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_SAMPS</b> 16</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aeadc2a66777c5ca1a67bca1bc4648c5"></a><!-- doxytag: member="sampDecl.h::MAX_HUBS" ref="aeadc2a66777c5ca1a67bca1bc4648c5" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_HUBS</b> 16</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0543164fb84dcec0c53c79671c473519"></a><!-- doxytag: member="sampDecl.h::MAX_MDATTRS" ref="0543164fb84dcec0c53c79671c473519" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_MDATTRS</b> 32</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cecb71b936e9c443f548540fb7a54ff"></a><!-- doxytag: member="sampDecl.h::MAX_SUBS" ref="4cecb71b936e9c443f548540fb7a54ff" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_SUBS</b> 256</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a8f91f93d75a07f0ae45077db45b3eb"></a><!-- doxytag: member="sampDecl.h::MAX_CLIENTS" ref="0a8f91f93d75a07f0ae45077db45b3eb" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_CLIENTS</b> 32</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b94af9dcb0358f28d175d80eed98330"></a><!-- doxytag: member="sampDecl.h::MAX_ROWS" ref="3b94af9dcb0358f28d175d80eed98330" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_ROWS</b> 256</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="400c6ad9a4514ac728ef6f26c41e26df"></a><!-- doxytag: member="sampDecl.h::MSG_SYNC" ref="400c6ad9a4514ac728ef6f26c41e26df" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MSG_SYNC</b> 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f38b71e9d650543379f59e8f7ade60c8"></a><!-- doxytag: member="sampDecl.h::MSG_ASYNC" ref="f38b71e9d650543379f59e8f7ade60c8" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MSG_ASYNC</b> 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee5730f808625a70be4589312bd6c9ab"></a><!-- doxytag: member="sampDecl.h::MSG_NOTIFY" ref="ee5730f808625a70be4589312bd6c9ab" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MSG_NOTIFY</b> 2</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ce6908d24bcc91b57bc9ac9923a3855"></a><!-- doxytag: member="sampDecl.h::DEF_CALLMODE" ref="5ce6908d24bcc91b57bc9ac9923a3855" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>DEF_CALLMODE</b> MSG_ASYNC</td></tr> + +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="578aa9310452ad28beded7f62bbb46b0"></a><!-- doxytag: member="sampDecl.h::handle_t" ref="578aa9310452ad28beded7f62bbb46b0" args="" --> +typedef XINT </td><td class="memItemRight" valign="bottom"><b>handle_t</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc13f9a2430a2e5b4d08f22a005c28ca"></a><!-- doxytag: member="sampDecl.h::appMDP" ref="cc13f9a2430a2e5b4d08f22a005c28ca" args="" --> +typedef struct <a class="el" href="structappMD.html">appMD</a> * </td><td class="memItemRight" valign="bottom"><b>appMDP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f6c3b3319ba8bd60a15bac1b8fe9a96"></a><!-- doxytag: member="sampDecl.h::SubsP" ref="5f6c3b3319ba8bd60a15bac1b8fe9a96" args="" --> +typedef struct <a class="el" href="structSubs.html">Subs</a> * </td><td class="memItemRight" valign="bottom"><b>SubsP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46ebb9354eb637730c6acd2818807321"></a><!-- doxytag: member="sampDecl.h::ClientP" ref="46ebb9354eb637730c6acd2818807321" args="" --> +typedef struct <a class="el" href="structClient.html">Client</a> * </td><td class="memItemRight" valign="bottom"><b>ClientP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf8156b03ce4e66cd90203b1038112a8"></a><!-- doxytag: member="sampDecl.h::HubP" ref="cf8156b03ce4e66cd90203b1038112a8" args="" --> +typedef struct <a class="el" href="structHub.html">Hub</a> * </td><td class="memItemRight" valign="bottom"><b>HubP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="159006987ca77a172c19bd254cb6f1c5"></a><!-- doxytag: member="sampDecl.h::SampP" ref="159006987ca77a172c19bd254cb6f1c5" args="" --> +typedef struct <a class="el" href="structSamp.html">Samp</a> * </td><td class="memItemRight" valign="bottom"><b>SampP</b></td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#30f39c72c3783055faa82ad3860f3d1d">sampInit</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> description)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the SAMP interface. <a href="#30f39c72c3783055faa82ad3860f3d1d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2e77115e730e95b31d897b8c50999b74">samp_Metadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> field, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a metadata field value for the application. <a href="#2e77115e730e95b31d897b8c50999b74"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#c6b76655d73825acdacfac8b5a1139ee">samp_Subscribe</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, void *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to a given mtype. <a href="#c6b76655d73825acdacfac8b5a1139ee"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#b3fded97bbbf3751c4916543959f16a5">samp_Unsubscribe</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe to a given mtype. <a href="#b3fded97bbbf3751c4916543959f16a5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#8e18ae12df031094ace47863f93b3634">sampStartup</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Startup the SAMP interface to send/receive messages. <a href="#8e18ae12df031094ace47863f93b3634"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#65908d088c8b917d10db38c147590ad9">sampShutdown</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Shut down the active SAMP interface. <a href="#65908d088c8b917d10db38c147590ad9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#123413db26ad50a84bd41863af5deae5">sampClose</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the SAMP interface and free resources. <a href="#123413db26ad50a84bd41863af5deae5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#1d00dc78292cfbc01262ef65ab055063">samp_setSyncMode</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the calling mode to use synchronous messaging. <a href="#1d00dc78292cfbc01262ef65ab055063"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#a9aef12dd82bfd38a2382a4ac88c54af">samp_setASyncMode</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the calling mode to use asynchronous messaging. <a href="#a9aef12dd82bfd38a2382a4ac88c54af"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#9056a8601300892f918835259c7fdb3b">samp_setNotifyMode</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the calling mode to use notification messaging. <a href="#9056a8601300892f918835259c7fdb3b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#d4c1514e94c9ef511cfcd27004c38c4d">samp_setCallByRef</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Have interface call user handlers by reference. <a href="#d4c1514e94c9ef511cfcd27004c38c4d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#fc27715ec9a5cb60cf0b5415eb7f9a48">samp_setCallMode</a> (handle_t handle, int mode)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the default calling mode (synch or asynch). <a href="#fc27715ec9a5cb60cf0b5415eb7f9a48"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#a3c0bdb4c512357dbc53b0ad7a7d5b01">samp_setReplyCallback</a> (handle_t handle, int *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func). <a href="#a3c0bdb4c512357dbc53b0ad7a7d5b01"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#3db66f28546459327665f8491ea97f4d">samp_setResponseCallback</a> (handle_t handle, int *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Response callback. samp_setResponseCallback (handle_t handle, int *func). <a href="#3db66f28546459327665f8491ea97f4d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#e11a97c262ab5ab4438eca6c60c0d8cf">samp_setTimeout</a> (handle_t handle, int timeout)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the message timeout value (in seconds). <a href="#e11a97c262ab5ab4438eca6c60c0d8cf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7731da5bec549e7554d1bdc11b13eaf6"></a><!-- doxytag: member="sampDecl.h::samp_setAppName" ref="7731da5bec549e7554d1bdc11b13eaf6" args="(handle_t handle, String name)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_setAppName</b> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#8fbfdc550ede5d52840300ab33639c49">samp_setAppVersion</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> version)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the application name string. <a href="#8fbfdc550ede5d52840300ab33639c49"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#96851f1c15e4baf67949d86d15f2568d">samp_defaultReplyHandler</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The interface's default Reply handler. <a href="#96851f1c15e4baf67949d86d15f2568d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd506ac12f25f64ada7c9859af3f857f"></a><!-- doxytag: member="sampDecl.h::samp_deaultfResponseHandler" ref="cd506ac12f25f64ada7c9859af3f857f" args="(handle_t handle)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_deaultfResponseHandler</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#d47754f3b9fceff4d3019821519432b4">samp_replyStatus</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reply with the status of the last message sent. <a href="#d47754f3b9fceff4d3019821519432b4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#ff4d125fc9594be25984989fad2fd3c8">samp_mapClients</a> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#1e494e73abe2ddfd946fb39e84da42a9">samp_listClients</a> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#8a2111bbe4c88cef635e3bf67e899563">samp_addClient</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> id)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#e30e492f306a40f853a454faf60ab479">samp_removeClient</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> id)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#cbf9b52550a9ab0b3515c32e692c46fb">samp_getOKMap</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#27baec44edb57136951b5f86ae893246">samp_getNullMap</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#84ffd50bd4b8dc79e9cf32398c6b3d69">samp_Register</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Register with the <a class="el" href="structHub.html">Hub</a> using the currently stored metadata. <a href="#84ffd50bd4b8dc79e9cf32398c6b3d69"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#106fc27544de7c25625ed60eb48e4edd">samp_UnRegister</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Un-Register from the hub. <a href="#106fc27544de7c25625ed60eb48e4edd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#9c6024ae76103069355256c29ee22722">samp_DeclareMetadata</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(Re)Declare all of our metadata. <a href="#9c6024ae76103069355256c29ee22722"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2be0812dc8d34c68407c62762f727c51">samp_Ping</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Ping the hub/app to see if it is alive (returns >0). <a href="#2be0812dc8d34c68407c62762f727c51"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2ac4b5c50094c394a74f18d6ebe3cd91">samp_GetMetadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metadata for a specified app. <a href="#2ac4b5c50094c394a74f18d6ebe3cd91"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#d2b0bdea58688142f55faeffcfc65525">samp_DeclareSubscriptions</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare the messages we're interested in. <a href="#d2b0bdea58688142f55faeffcfc65525"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4f65b6315c8bd7380176d2b97462354"></a><!-- doxytag: member="sampDecl.h::samp_GetSubscriptions" ref="c4f65b6315c8bd7380176d2b97462354" args="(handle_t handle, String pubId)" --> +<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><b>samp_GetSubscriptions</b> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#954712a523e3f86826b4711abd35b165">samp_GetRegisteredClients</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get public-ids of the registered clients. <a href="#954712a523e3f86826b4711abd35b165"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#367a24fc0aa7a81416e6a0d0dbfcd93f">samp_GetSubscribedClients</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get clients matching the mtype subscription. <a href="#367a24fc0aa7a81416e6a0d0dbfcd93f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#34e9d38073f36daaf41c418f8d680ee5">samp_tableLoadVOTable</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to load a VOTable. <a href="#34e9d38073f36daaf41c418f8d680ee5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#74aeaaf742121348390ec854c30c1479">samp_tableLoadFITS</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to load a FITS table. <a href="#74aeaaf742121348390ec854c30c1479"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#4812b571ed87f7842ca20b7024770df3">samp_imageLoadFITS</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> imageId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to load a FITS image. <a href="#4812b571ed87f7842ca20b7024770df3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#e38ac987f1dfd87ad64f97d55396270e">samp_tableHighlightRow</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, int row)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to highlight a table row. <a href="#e38ac987f1dfd87ad64f97d55396270e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#f133efb67fe4bcfd2b9c8ab9d23b4c5e">samp_tableSelectRowList</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, int rows[], int nrows)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to select a list of table rows. <a href="#f133efb67fe4bcfd2b9c8ab9d23b4c5e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#e1e86e79d9a1768e5f265cbb44279172">samp_coordPointAtSky</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, float ra, float dec)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to point at an RA/Dec coordinate. <a href="#e1e86e79d9a1768e5f265cbb44279172"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#18b351385bd175581a6788a4f7342f07">samp_specLoadSSAGeneric</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> meta, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> spectrumId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a generic spectrum from an SSA service. <a href="#18b351385bd175581a6788a4f7342f07"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#5900317c1609ddd5b6da70dc0eb2040c">samp_cmdExec</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> cmd)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a command in a remote application. <a href="#5900317c1609ddd5b6da70dc0eb2040c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#9c64fef9c158d7fd4ff7f72691ccd319">samp_envGet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an environment variable in a remote application. <a href="#9c64fef9c158d7fd4ff7f72691ccd319"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#ded4b8bdac87c5b6faa7f13d8abb22a1">samp_envSet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an environment variable in a remote application. <a href="#ded4b8bdac87c5b6faa7f13d8abb22a1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#19b75403d63714c4fccc8a8d4fa4c8cf">samp_paramGet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a parameter variable in a remote application. <a href="#19b75403d63714c4fccc8a8d4fa4c8cf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#535cb6760c733a75746d2f104b1a01be">samp_paramSet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an parameter variable in a remote application. <a href="#535cb6760c733a75746d2f104b1a01be"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#ae7f51c1f6169b918568a1202d0fa031">samp_bibLoad</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> bibcode)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Exchange a bibcode. <a href="#ae7f51c1f6169b918568a1202d0fa031"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#8013c549ef47e0507edf39c8ab1b62aa">samp_resourceLoad</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> type, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resMap)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Exchange a resource list. <a href="#8013c549ef47e0507edf39c8ab1b62aa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#b2ff2e029c57b56ad57416c624341fe6">samp_sendGeneric</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> args[])</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a geenric message. <a href="#b2ff2e029c57b56ad57416c624341fe6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#80ef1a82845b96091857c7d4a3c7972c">samp_sendMsg</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the specified message. <a href="#80ef1a82845b96091857c7d4a3c7972c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#c73788ae17493c4042948f6b861ddd74">samp_notify</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a notify() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#c73788ae17493c4042948f6b861ddd74"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#f48228224c20ddaf8b4b4ce39fa6ec16">samp_notifyAll</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a notifyAll() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#f48228224c20ddaf8b4b4ce39fa6ec16"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#77f32922cfe662f4b423b678ba09513c">samp_call</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tag, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a call() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#77f32922cfe662f4b423b678ba09513c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#66d67a1ba0dff1f6dab68f74299f500a">samp_callAll</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a callAll() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#66d67a1ba0dff1f6dab68f74299f500a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#6780568b9e9dfae5b361c2b2e52c16ed">samp_callAndWait</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a callAndWait() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#6780568b9e9dfae5b361c2b2e52c16ed"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#9c6ff3d76997c3d7301a977309a117e0">samp_Reply</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reply to a message. <a href="#9c6ff3d76997c3d7301a977309a117e0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#0a996f4e24693c2eacba579ecbceedbb">samp_clientName</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structClient.html">Client</a> name from a pubic-id. <a href="#0a996f4e24693c2eacba579ecbceedbb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#91aeabe77e920fc1924b1cdc4f088e64">samp_setErr</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the error response string. <a href="#91aeabe77e920fc1924b1cdc4f088e64"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#4946a754670217dbdbc83cca92217022">samp_getErr</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the error response string. <a href="#4946a754670217dbdbc83cca92217022"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#59f85e0fce4c9ae7121c98e137d3f743">samp_receiveCall</a> (void *data)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">test.echo method <a href="#59f85e0fce4c9ae7121c98e137d3f743"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#03be7cc9e154a6ccdd499286df640936">samp_receiveNotification</a> (void *data)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">receiveNotification () client method. <a href="#03be7cc9e154a6ccdd499286df640936"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#754b50ad59145c7fd1e4c8f4277f11e4">samp_receiveResponse</a> (void *data)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">receiveResponse () client method. <a href="#754b50ad59145c7fd1e4c8f4277f11e4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#81222e1f3572585fa30f11a78aa08c3f">samp_setUserHandler</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, void *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the user-interface handler for the mtype. <a href="#81222e1f3572585fa30f11a78aa08c3f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2e8ec01a0dd96314622ae313206583db">samp_setSampHandler</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, void *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the SAMP interface handler for the mtype. <a href="#2e8ec01a0dd96314622ae313206583db"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#6bb258d378627da1aa0254fccdb6bd2c">samp_getUserHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the User handler for the named mtype. <a href="#6bb258d378627da1aa0254fccdb6bd2c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#6ef18dbc5870f58d2161c9ba03a81d26">samp_getSampHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Samphandler for the named mtype. <a href="#6ef18dbc5870f58d2161c9ba03a81d26"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#979664bde900a1e1bf7bc499dc92898e">samp_execUserHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the user-defined handler for the mtype. <a href="#979664bde900a1e1bf7bc499dc92898e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b7812ba89eebe15ad24f36a3d439a0a"></a><!-- doxytag: member="sampDecl.h::samp_genericMsgHandler" ref="1b7812ba89eebe15ad24f36a3d439a0a" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_genericMsgHandler</b> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#16d8b8822d169107b8702ae753797923">samp_PingHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Is app alive and responding to messages? <a href="#16d8b8822d169107b8702ae753797923"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2e342b672e77e012cc98a6f5506a44be">samp_StatusHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return status of the task. <a href="#2e342b672e77e012cc98a6f5506a44be"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#9bd8036dd65dc4f874f39568b691a123">samp_imLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle an image.load.fits message. <a href="#9bd8036dd65dc4f874f39568b691a123"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#26f96dc6cbf72283e2ee9cb8b4619ed3">samp_tbLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a generic table.load.* message. <a href="#26f96dc6cbf72283e2ee9cb8b4619ed3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#750c0fee0c7a99e135299c08751f288c">samp_tbLoadFITSHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a generic table.load.fits message. <a href="#750c0fee0c7a99e135299c08751f288c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#144ec2329355d91022d5ea38736c0093">samp_tbLoadVOTHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a generic table.load.votable message. <a href="#144ec2329355d91022d5ea38736c0093"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#bc319b97b3dbea29bd79c4f723db5438">samp_specLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a spectrum.load.* message. <a href="#bc319b97b3dbea29bd79c4f723db5438"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#dd2bca8fa3bf3b4ebbf449edc6b65d85">samp_specSSAHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a spectrum.load.ssa-generic message. <a href="#dd2bca8fa3bf3b4ebbf449edc6b65d85"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#d9184eb45a5bc93b5205fd5b1c6ef688">samp_tbHighlightHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a table.highlight.row message. <a href="#d9184eb45a5bc93b5205fd5b1c6ef688"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#98d68d7091c0b7790631bb53e0ace656">samp_tbSelectHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a table.select.rowList message. <a href="#98d68d7091c0b7790631bb53e0ace656"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#3f5632858a2b09759ffe98cd2e183cfb">samp_pointAtHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a coord.pointAt.sky message. <a href="#3f5632858a2b09759ffe98cd2e183cfb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#262bf09278c61b60b5189fef7f26d26b">samp_bibcodeHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a bibcode.load message. <a href="#262bf09278c61b60b5189fef7f26d26b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b">samp_cmdExecHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.cmd.exec message. <a href="#c57d19afc6fa0b4bc9c7a0fd50d0f54b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#e25a92f57babd71d43653d7fcb81025c">samp_envGetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.env.set message. <a href="#e25a92f57babd71d43653d7fcb81025c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#0910e6b9d11cdd3111c1f18450de394a">samp_envSetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.env.set message. <a href="#0910e6b9d11cdd3111c1f18450de394a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#659c272ce881662c1826a04728dc06f6">samp_paramGetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.param.set message. <a href="#659c272ce881662c1826a04728dc06f6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#071aa9e32f2e94d5b667e87cf65d2bdf">samp_paramSetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.param.set message. <a href="#071aa9e32f2e94d5b667e87cf65d2bdf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#c0bf7cf7fea362c0c82ad7bc3f267c48">samp_resLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#c0bf7cf7fea362c0c82ad7bc3f267c48"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#287569451dc1bf59d1f9f6d13b56716d">samp_resConeHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#287569451dc1bf59d1f9f6d13b56716d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#8b2300222d7b11f144eb4385412e69a5">samp_resSiapHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#8b2300222d7b11f144eb4385412e69a5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#866578a01c3b762435823b1b11869c42">samp_resSsapHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#866578a01c3b762435823b1b11869c42"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#ad42ca17cbaf23012ad497559ea45e4c">samp_resTapHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#ad42ca17cbaf23012ad497559ea45e4c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#fa207ebdc587ba5eeab60fbf79b635d4">samp_resVOSpaceHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#fa207ebdc587ba5eeab60fbf79b635d4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e743048f5b1f903496b2a8a2e9666367"></a><!-- doxytag: member="sampDecl.h::samp_printMessage" ref="e743048f5b1f903496b2a8a2e9666367" args="(String mtype, String sender, String msg_id, Map params)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_printMessage</b> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#a8a947c24f2c9333adf4e5d7fa11d134">samp_printMap</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#5361571754505eaefdf5739cd3e9519e">samp_nullResponse</a> (void *data)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc687f745f400b41c9af4f6419bf9bf8"></a><!-- doxytag: member="sampDecl.h::samp_testEcho" ref="cc687f745f400b41c9af4f6419bf9bf8" args="(void *data)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_testEcho</b> (void *data)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2b208c34c0e6017f071b9ce654d0f3d6">samp_hubOpen</a> (<a class="el" href="structSamp.html">Samp</a> *samp)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Discover and open a connection to the SAMP <a class="el" href="structHub.html">Hub</a>. <a href="#2b208c34c0e6017f071b9ce654d0f3d6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#52f471568663ac6f0116d57a9ce00f00">samp_hubClose</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close a connection to the <a class="el" href="structHub.html">Hub</a>. <a href="#52f471568663ac6f0116d57a9ce00f00"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#e792eedc70daa9b2d010ca6cd8e57fe8">samp_getAvailableHubs</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of available Hubs. <a href="#e792eedc70daa9b2d010ca6cd8e57fe8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b4292d136520c3d276d655e2093dd30"></a><!-- doxytag: member="sampDecl.h::samp_getActiveHubName" ref="4b4292d136520c3d276d655e2093dd30" args="(handle_t handle)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getActiveHubName</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf266e81b16f556e2f42cad5a2eb9157"></a><!-- doxytag: member="sampDecl.h::samp_getActiveHub" ref="bf266e81b16f556e2f42cad5a2eb9157" args="(handle_t handle)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_getActiveHub</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12c4307b544d66d57d54cbc4c031dd35"></a><!-- doxytag: member="sampDecl.h::samp_hubInit" ref="12c4307b544d66d57d54cbc4c031dd35" args="(handle_t samp, char *appName, char *descr)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_hubInit</b> (handle_t samp, char *appName, char *descr)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2933b26ac05c440196368edad0167bdf">samp_processHubEvent</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. <a href="#2933b26ac05c440196368edad0167bdf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#19f64b527fcc431541206e41f8e36132">samp_hubEvent</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. <a href="#19f64b527fcc431541206e41f8e36132"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#13ad32079ae1db571e3114b7bd8ba356">samp_hubRegister</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a Register message to the <a class="el" href="structHub.html">Hub</a>. <a href="#13ad32079ae1db571e3114b7bd8ba356"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#6d4e32ed0eb19f02cc8a75f75a98deec">samp_hubUnRegister</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a UnRegister message to the <a class="el" href="structHub.html">Hub</a>. <a href="#6d4e32ed0eb19f02cc8a75f75a98deec"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#a704d2a0d290f2fdfb3ebfffc39adcb3">samp_hubSendShutdown</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a samp.app.event.shutdown message to the <a class="el" href="structHub.html">Hub</a>. <a href="#a704d2a0d290f2fdfb3ebfffc39adcb3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2fcb0032e5ae98fff93becdb06da49f9">samp_hubSetXmlrpcCallback</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the client callback and send to <a class="el" href="structHub.html">Hub</a>. <a href="#2fcb0032e5ae98fff93becdb06da49f9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#47b1a9a4627fde97f95b40b372153cf6">samp_hubPing</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Ping the <a class="el" href="structHub.html">Hub</a> to see if it is alive. <a href="#47b1a9a4627fde97f95b40b372153cf6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#088f1e762175d0dbc315853d06e50149">samp_hubDeclareMetadata</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare "standard" metadata to the <a class="el" href="structHub.html">Hub</a>. <a href="#088f1e762175d0dbc315853d06e50149"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#7be493427eac28b2a064eedd8a7d63ff">samp_hubDeclareSubscriptions</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare mtype subscriptions to the <a class="el" href="structHub.html">Hub</a>. <a href="#7be493427eac28b2a064eedd8a7d63ff"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#b5375a6478dccefe7df2b48416604b29">samp_newList</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new List object. <a href="#b5375a6478dccefe7df2b48416604b29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#b162ae9b9f98da80f6bb5c34b5cbcbf6">samp_freeList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given List object. <a href="#b162ae9b9f98da80f6bb5c34b5cbcbf6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#c260afb0cbf19b427e3eba96a2341e52">samp_listLen</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of elements in a List. <a href="#c260afb0cbf19b427e3eba96a2341e52"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#5b69180b036e58528c98b1cf5a42825a">samp_setStringInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a List (append). <a href="#5b69180b036e58528c98b1cf5a42825a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#ea188bb711f3b5549d11204b0ff2da08">samp_setMapInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Map in a List (append). <a href="#ea188bb711f3b5549d11204b0ff2da08"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#0ff97d44e62b7c88a046a29324552400">samp_setListInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list1, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list2)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a List in another List (append). <a href="#0ff97d44e62b7c88a046a29324552400"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2d8a8a26d7284bb211a933895cddd29c">samp_setIntInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an Int in a List (append). <a href="#2d8a8a26d7284bb211a933895cddd29c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#041a551aff57ca03f3ff72a9803e2b58">samp_setFloatInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, float value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Float in a List (append). <a href="#041a551aff57ca03f3ff72a9803e2b58"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2d1cd41c4583ac300aaa2d50ad3f76ed">samp_getStringFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string from the List. <a href="#2d1cd41c4583ac300aaa2d50ad3f76ed"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#33ca96ee3a8e7d26356c7b66f469da74">samp_getMapFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Map from the List. <a href="#33ca96ee3a8e7d26356c7b66f469da74"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#1ec1ddadb4e889792b6fa7df6f6c3125">samp_getListFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a List from the List. <a href="#1ec1ddadb4e889792b6fa7df6f6c3125"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1174e001b2d16ed0aa1b317cfc883af1"></a><!-- doxytag: member="sampDecl.h::samp_getIntFromList" ref="1174e001b2d16ed0aa1b317cfc883af1" args="(List list, int index)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_getIntFromList</b> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#4e8339b2b3f5ff1a58cebb74eddca9e6">samp_getFloatFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Float from the List. <a href="#4e8339b2b3f5ff1a58cebb74eddca9e6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#55c96c3dfe79d00b8445a60769785dae">samp_newMap</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Map object. <a href="#55c96c3dfe79d00b8445a60769785dae"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#fe80438de542c6657d623993360b37d1">samp_freeMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given Map object. <a href="#fe80438de542c6657d623993360b37d1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c99f7146ad3acd3e381a02d5df1234f"></a><!-- doxytag: member="sampDecl.h::samp_getMapSize" ref="1c99f7146ad3acd3e381a02d5df1234f" args="(Map map)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_getMapSize</b> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c8a1b402743b52f2837e97cf41e9e34"></a><!-- doxytag: member="sampDecl.h::samp_getMapKey" ref="4c8a1b402743b52f2837e97cf41e9e34" args="(Map map, int index)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getMapKey</b> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, int index)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7dcdf07dd7f3252f3bf2dd5002c62251"></a><!-- doxytag: member="sampDecl.h::samp_getMapVal" ref="7dcdf07dd7f3252f3bf2dd5002c62251" args="(Map map, int index)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getMapVal</b> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, int index)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#b9b2157de89369eb5cd95bfe804eb89a">samp_setStringInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a Map (append). <a href="#b9b2157de89369eb5cd95bfe804eb89a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#f102490efe1b92d99b67f244dc498c7b">samp_setMapInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map1, char *key, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map2)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Map in a Map (append). <a href="#f102490efe1b92d99b67f244dc498c7b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#362c2f670c98dd6a3ef69debd1871604">samp_setListInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a List in a Map (append). <a href="#362c2f670c98dd6a3ef69debd1871604"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#c22ec42dbf9a01c9b4e00cf011e7eb9d">samp_setIntInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Int in a Map (append). <a href="#c22ec42dbf9a01c9b4e00cf011e7eb9d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#0f07ae542f5b317311b3799bd96a88fd">samp_setFloatInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, float value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a Map (append). <a href="#0f07ae542f5b317311b3799bd96a88fd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#96ca606e0e7da659c3dc0a30846bcd66">samp_getStringFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string from the Map. <a href="#96ca606e0e7da659c3dc0a30846bcd66"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#525e8ffdfa32867f392f2c1340215453">samp_getMapFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Map from the Map. <a href="#525e8ffdfa32867f392f2c1340215453"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#31ddb90cf2184ae0151b9e7ec8c1a51f">samp_getListFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a LIST from the Map. <a href="#31ddb90cf2184ae0151b9e7ec8c1a51f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#210fc0eba30abddf1bdc2e780d58072c">samp_getIntFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a integer from the Map. <a href="#210fc0eba30abddf1bdc2e780d58072c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#b0d3768990294554a298c4057b3b315d">samp_getFloatFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a float from the Map. <a href="#b0d3768990294554a298c4057b3b315d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#1a66c53bb9e023fb0219ab9baeded3d6">samp_newMsg</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Msg object. <a href="#1a66c53bb9e023fb0219ab9baeded3d6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#adf2979a5fad0c9a855740330b7fd9ce">samp_freeMsg</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given Msg object. <a href="#adf2979a5fad0c9a855740330b7fd9ce"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34c9e29fa57216f19a70764df8e5826b"></a><!-- doxytag: member="sampDecl.h::samp_msgMType" ref="34c9e29fa57216f19a70764df8e5826b" args="(Msg msg, String mtype)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_msgMType</b> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#281c8f7f8b21a74704dd200d5aaed481">samp_msgParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to the Msg. <a href="#281c8f7f8b21a74704dd200d5aaed481"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb9eff6a0f442a1c9fde13c1e9fc097d"></a><!-- doxytag: member="sampDecl.h::samp_msgTag" ref="cb9eff6a0f442a1c9fde13c1e9fc097d" args="(void)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_msgTag</b> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#c58f0b105566a61785fb9f2ed9b42830">samp_newParam</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Param object. <a href="#c58f0b105566a61785fb9f2ed9b42830"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#5a6fbf3ac37164268afae80c35666c5e">samp_freeParam</a> (<a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given Msg object. <a href="#5a6fbf3ac37164268afae80c35666c5e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#d8c5669be313874fef1c484643683f49">samp_paramInit</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of Params. <a href="#d8c5669be313874fef1c484643683f49"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62c2d0b887252730fd6f7bdaa7211403"></a><!-- doxytag: member="sampDecl.h::samp_addStringParam" ref="62c2d0b887252730fd6f7bdaa7211403" args="(Msg msg, char *keyw, String val)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_addStringParam</b> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> val)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#e3e90c84dd6b1a08d8af18ca9e168b37">samp_addMapParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to the Param. <a href="#e3e90c84dd6b1a08d8af18ca9e168b37"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#24f72c4ed033ed2f219b420e491b3c0f">samp_addListParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to the Param. <a href="#24f72c4ed033ed2f219b420e491b3c0f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#6897da75444209fc1819042bde906aa6">samp_addIntParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, int val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <SAMP int>=""> parameter to the Param. <a href="#6897da75444209fc1819042bde906aa6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#d297770f4ab1338697d69b2705d6c1d9">samp_addFloatParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, float val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <SAMP float>=""> parameter to the Param. <a href="#d297770f4ab1338697d69b2705d6c1d9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#7680995e5d4f26ea3d91bf72c9c72e51">samp_paramLen</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of Params. <a href="#7680995e5d4f26ea3d91bf72c9c72e51"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#4919f892b6fccced4e6b9d777071b781">sampLog</a> (handle_t handle, char *format,...)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">SAMP message logger. <a href="#4919f892b6fccced4e6b9d777071b781"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#2b3dd1662e61c83e29109126689b08b9">sampTrace</a> (handle_t handle, char *format,...)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">SAMP tracer. <a href="#2b3dd1662e61c83e29109126689b08b9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="711aa545f55e9307f662062deefd5903"></a><!-- doxytag: member="sampDecl.h::samp_newHandle" ref="711aa545f55e9307f662062deefd5903" args="(void *ptr)" --> +handle_t </td><td class="memItemRight" valign="bottom"><b>samp_newHandle</b> (void *ptr)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f02a7c646a9ed56e545d8bf33434c207"></a><!-- doxytag: member="sampDecl.h::samp_freeHandle" ref="f02a7c646a9ed56e545d8bf33434c207" args="(handle_t handle)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_freeHandle</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d0aef2f09b9cce38d4ea8024831c6e5"></a><!-- doxytag: member="sampDecl.h::samp_P2H" ref="4d0aef2f09b9cce38d4ea8024831c6e5" args="(void *ptr)" --> +handle_t </td><td class="memItemRight" valign="bottom"><b>samp_P2H</b> (void *ptr)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="909310a995650c224515c9ca0a3ef582"></a><!-- doxytag: member="sampDecl.h::samp_H2P" ref="909310a995650c224515c9ca0a3ef582" args="(handle_t handle)" --> +void * </td><td class="memItemRight" valign="bottom"><b>samp_H2P</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#aed9017996a8361f8abf5b5c6a954414">samp_app2id</a> (handle_t handle, char *appName)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an application name to a public-ID. <a href="#aed9017996a8361f8abf5b5c6a954414"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#a75368198ec8cd2fff6ad304806862b8">samp_id2app</a> (handle_t handle, char *pubId)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a public-ID to the application name. <a href="#a75368198ec8cd2fff6ad304806862b8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#0af6dba3d1022e6b220a9b1076021353">samp_serverPort</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a unique port number for the server. <a href="#0af6dba3d1022e6b220a9b1076021353"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#ace22fd6ada035930ef93e5a54c375b1">samp_printMetadata</a> (handle_t handle, char *name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the metadata for the application. <a href="#ace22fd6ada035930ef93e5a54c375b1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampDecl_8h.html#f9622190e1976c42efebd30f0c51cfe4">samp_getMetadata</a> (handle_t handle, char *name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metadata item for the application. <a href="#f9622190e1976c42efebd30f0c51cfe4"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +SAMP interface method declarations. +<p> +SAMPDECL.H -- SAMP interface method declarations.<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike FItzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>8/10/11 </dd></dl> +<hr><h2>Define Documentation</h2> +<a class="anchor" name="6fc88d7dbc85d8d10379f58c910ce847"></a><!-- doxytag: member="sampDecl.h::SZ_NAME" ref="6fc88d7dbc85d8d10379f58c910ce847" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define SZ_NAME 256 </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP String datatype +<p>Referenced by <a class="el" href="samp_8c_source.html#l00834">samp_addClient()</a>, <a class="el" href="sampHandlers_8c_source.html#l01118">samp_bibcodeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00994">samp_envSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampHub_8c_source.html#l00167">samp_hubRunning()</a>, <a class="el" href="sampHandlers_8c_source.html#l00547">samp_imLoadHandler()</a>, <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01082">samp_paramSetHandler()</a>, <a class="el" href="samp_8c_source.html#l00908">samp_removeClient()</a>, <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00705">samp_tbHighlightHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00621">samp_tbLoadFITSHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00663">samp_tbLoadVOTHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<hr><h2>Typedef Documentation</h2> +<a class="anchor" name="39f9d235896a8fd920f319105eb82791"></a><!-- doxytag: member="sampDecl.h::List" ref="39f9d235896a8fd920f319105eb82791" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP Map datatype +</div> +</div><p> +<a class="anchor" name="39a90bc041db57e1a6ba736ba91eee30"></a><!-- doxytag: member="sampDecl.h::Map" ref="39a90bc041db57e1a6ba736ba91eee30" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +generic object handle +</div> +</div><p> +<a class="anchor" name="eb3d03dd240212c044285bdd522e3b2b"></a><!-- doxytag: member="sampDecl.h::Msg" ref="eb3d03dd240212c044285bdd522e3b2b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP List datatype +</div> +</div><p> +<a class="anchor" name="4c5a7aff173725461e76e5f0183d7ed8"></a><!-- doxytag: member="sampDecl.h::Param" ref="4c5a7aff173725461e76e5f0183d7ed8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP Msg datatype +</div> +</div><p> +<a class="anchor" name="2efe6d463d80744789f228f5dc4baa39"></a><!-- doxytag: member="sampDecl.h::String" ref="2efe6d463d80744789f228f5dc4baa39" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef char* <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP Param datatype +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="8a2111bbe4c88cef635e3bf67e899563"></a><!-- doxytag: member="sampDecl.h::samp_addClient" ref="8a2111bbe4c88cef635e3bf67e899563" args="(handle_t handle, String name, String id)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_addClient </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>id</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_ADDCLIENT -- Add a newly registered client to the list of known apps so we can do the public-private name translation. +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d297770f4ab1338697d69b2705d6c1d9"></a><!-- doxytag: member="sampDecl.h::samp_addFloatParam" ref="d297770f4ab1338697d69b2705d6c1d9" args="(Msg msg, char *keyw, float val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addFloatParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a <SAMP float>=""> parameter to the Param. +<p> +SAMP_ADDFLOATPARAM -- Add a <SAMP float>=""> parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>floating point value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="sampParam_8c_source.html#l00073">samp_paramInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6897da75444209fc1819042bde906aa6"></a><!-- doxytag: member="sampDecl.h::samp_addIntParam" ref="6897da75444209fc1819042bde906aa6" args="(Msg msg, char *keyw, int val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addIntParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a <SAMP int>=""> parameter to the Param. +<p> +SAMP_ADDINTPARAM -- Add a <SAMP int>=""> parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>integer value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="sampParam_8c_source.html#l00073">samp_paramInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="24f72c4ed033ed2f219b420e491b3c0f"></a><!-- doxytag: member="sampDecl.h::samp_addListParam" ref="24f72c4ed033ed2f219b420e491b3c0f" args="(Msg msg, char *keyw, List val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addListParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a parameter to the Param. +<p> +SAMP_ADDLISTPARAM -- Add a List parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>value list </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="sampParam_8c_source.html#l00073">samp_paramInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e3e90c84dd6b1a08d8af18ca9e168b37"></a><!-- doxytag: member="sampDecl.h::samp_addMapParam" ref="e3e90c84dd6b1a08d8af18ca9e168b37" args="(Msg msg, char *keyw, Map val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addMapParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a parameter to the Param. +<p> +SAMP_ADDMAPPARAM -- Add a Map parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>value map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="sampParam_8c_source.html#l00073">samp_paramInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="aed9017996a8361f8abf5b5c6a954414"></a><!-- doxytag: member="sampDecl.h::samp_app2id" ref="aed9017996a8361f8abf5b5c6a954414" args="(handle_t handle, char *appName)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_app2id </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>appName</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Convert an application name to a public-ID. +<p> +SAMP_APP2ID -- Convert an application name to a public-ID.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>appName</em> </td><td>name of registered application </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>public ID of application </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, and <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>.</p> + +</div> +</div><p> +<a class="anchor" name="262bf09278c61b60b5189fef7f26d26b"></a><!-- doxytag: member="sampDecl.h::samp_bibcodeHandler" ref="262bf09278c61b60b5189fef7f26d26b" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_bibcodeHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a bibcode.load message. +<p> +SAMP_BIBCODEHANDLER -- Handle a bibcode.load message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ae7f51c1f6169b918568a1202d0fa031"></a><!-- doxytag: member="sampDecl.h::samp_bibLoad" ref="ae7f51c1f6169b918568a1202d0fa031" args="(handle_t handle, String recip, String bibcode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_bibLoad </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>bibcode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Exchange a bibcode. +<p> +SAMP_BIBLOAD -- Exchange a bibcode.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bibcode</em> </td><td>Bibcode string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="77f32922cfe662f4b423b678ba09513c"></a><!-- doxytag: member="sampDecl.h::samp_call" ref="77f32922cfe662f4b423b678ba09513c" args="(handle_t handle, String recipId, String tag, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> samp_call </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recipId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a call() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_CALL -- Make a call() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recipId</em> </td><td>recipient ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_tag</em> </td><td>message tag </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>message ID </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="66d67a1ba0dff1f6dab68f74299f500a"></a><!-- doxytag: member="sampDecl.h::samp_callAll" ref="66d67a1ba0dff1f6dab68f74299f500a" args="(handle_t handle, String msg_tag, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_callAll </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a callAll() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_CALLALL -- Make a callAll() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_tag</em> </td><td>message tag </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampClient_8c_source.html#l00360">samp_setErr()</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6780568b9e9dfae5b361c2b2e52c16ed"></a><!-- doxytag: member="sampDecl.h::samp_callAndWait" ref="6780568b9e9dfae5b361c2b2e52c16ed" args="(handle_t handle, String recipId, String msg_tag, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_callAndWait </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recipId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a callAndWait() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_CALLANDWAIT -- Make a callAndWait() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recipId</em> </td><td>recipient ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_tag</em> </td><td>message tag </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampClient_8c_source.html#l00360">samp_setErr()</a>, <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0a996f4e24693c2eacba579ecbceedbb"></a><!-- doxytag: member="sampDecl.h::samp_clientName" ref="0a996f4e24693c2eacba579ecbceedbb" args="(handle_t handle, String pubId)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> samp_clientName </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>pubId</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the <a class="el" href="structClient.html">Client</a> name from a pubic-id. +<p> +SAMP_CLIENTNAME -- Get the <a class="el" href="structClient.html">Client</a> name from a pubic-id.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>pubId</em> </td><td>public ID </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>declared application name </dd></dl> + +</div> +</div><p> +<a class="anchor" name="5900317c1609ddd5b6da70dc0eb2040c"></a><!-- doxytag: member="sampDecl.h::samp_cmdExec" ref="5900317c1609ddd5b6da70dc0eb2040c" args="(handle_t handle, String recip, String cmd)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_cmdExec </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>cmd</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Execute a command in a remote application. +<p> +SAMP_CMDEXEC -- Execute a command in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>cmd</em> </td><td>Command string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c57d19afc6fa0b4bc9c7a0fd50d0f54b"></a><!-- doxytag: member="sampDecl.h::samp_cmdExecHandler" ref="c57d19afc6fa0b4bc9c7a0fd50d0f54b" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_cmdExecHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.cmd.exec message. +<p> +SAMP_CMDEXECHANDLER -- Handle a client.cmd.exec message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e1e86e79d9a1768e5f265cbb44279172"></a><!-- doxytag: member="sampDecl.h::samp_coordPointAtSky" ref="e1e86e79d9a1768e5f265cbb44279172" args="(handle_t handle, String recip, float ra, float dec)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_coordPointAtSky </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>ra</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>dec</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to point at an RA/Dec coordinate. +<p> +SAMP_COORDPOINTATSKY -- Tell an app to point at an RA/Dec coordinate.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>ra</em> </td><td>RA of coord in degrees </td></tr> + <tr><td valign="top"></td><td valign="top"><em>dec</em> </td><td>Dec of coord in degrees </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00181">samp_addFloatParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="9c6024ae76103069355256c29ee22722"></a><!-- doxytag: member="sampDecl.h::samp_DeclareMetadata" ref="9c6024ae76103069355256c29ee22722" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_DeclareMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +(Re)Declare all of our metadata. +<p> +SAMP_DECLAREMETATA -- (Re)Declare all of our metadata.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, and <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d2b0bdea58688142f55faeffcfc65525"></a><!-- doxytag: member="sampDecl.h::samp_DeclareSubscriptions" ref="d2b0bdea58688142f55faeffcfc65525" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_DeclareSubscriptions </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declare the messages we're interested in. +<p> +SAMP_DECLARESUBSCRIPIONS -- Declare the messages we're interested in.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, and <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="96851f1c15e4baf67949d86d15f2568d"></a><!-- doxytag: member="sampDecl.h::samp_defaultReplyHandler" ref="96851f1c15e4baf67949d86d15f2568d" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_defaultReplyHandler </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The interface's default Reply handler. +<p> +SAMP_DEFAULTREPLYHANDLER -- The interface's default Reply handler.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9c64fef9c158d7fd4ff7f72691ccd319"></a><!-- doxytag: member="sampDecl.h::samp_envGet" ref="9c64fef9c158d7fd4ff7f72691ccd319" args="(handle_t handle, String recip, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_envGet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get an environment variable in a remote application. +<p> +SAMP_ENVGET -- Get an environment variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL, Value of variable, or list of values </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e25a92f57babd71d43653d7fcb81025c"></a><!-- doxytag: member="sampDecl.h::samp_envGetHandler" ref="e25a92f57babd71d43653d7fcb81025c" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_envGetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.env.set message. +<p> +SAMP_ENVGETHANDLER -- Handle a client.env.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00067">samp_freeMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>, <a class="el" href="sampMethods_8c_source.html#l00237">samp_setHandlerReply()</a>, <a class="el" href="sampMap_8c_source.html#l00153">samp_setMapInMap()</a>, <a class="el" href="sampMap_8c_source.html#l00135">samp_setStringInMap()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ded4b8bdac87c5b6faa7f13d8abb22a1"></a><!-- doxytag: member="sampDecl.h::samp_envSet" ref="ded4b8bdac87c5b6faa7f13d8abb22a1" args="(handle_t handle, String recip, String name, String value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_envSet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an environment variable in a remote application. +<p> +SAMP_ENVSET -- Set an environment variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value of variable or NULL </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0910e6b9d11cdd3111c1f18450de394a"></a><!-- doxytag: member="sampDecl.h::samp_envSetHandler" ref="0910e6b9d11cdd3111c1f18450de394a" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_envSetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.env.set message. +<p> +SAMP_ENVSETHANDLER -- Handle a client.env.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="979664bde900a1e1bf7bc499dc92898e"></a><!-- doxytag: member="sampDecl.h::samp_execUserHandler" ref="979664bde900a1e1bf7bc499dc92898e" args="(String mtype, String sender, String msg_id, Map params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_execUserHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>params</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Execute the user-defined handler for the mtype. +<p> +SAMP_EXECUSERHANDLER -- Execute the user-defined handler for the mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message-id string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>Mtype parameter Map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00308">samp_getFloatFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00288">samp_getIntFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00268">samp_getListFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b162ae9b9f98da80f6bb5c34b5cbcbf6"></a><!-- doxytag: member="sampDecl.h::samp_freeList" ref="b162ae9b9f98da80f6bb5c34b5cbcbf6" args="(List list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given List object. +<p> +SAMP_FREELIST -- Free the given List object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fe80438de542c6657d623993360b37d1"></a><!-- doxytag: member="sampDecl.h::samp_freeMap" ref="fe80438de542c6657d623993360b37d1" args="(Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given Map object. +<p> +SAMP_FREEMAP -- Free the given Map object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>Map object to free </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="adf2979a5fad0c9a855740330b7fd9ce"></a><!-- doxytag: member="sampDecl.h::samp_freeMsg" ref="adf2979a5fad0c9a855740330b7fd9ce" args="(Msg msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeMsg </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given Msg object. +<p> +SAMP_FREEMSG -- Free the given Msg object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Msg object to free </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="5a6fbf3ac37164268afae80c35666c5e"></a><!-- doxytag: member="sampDecl.h::samp_freeParam" ref="5a6fbf3ac37164268afae80c35666c5e" args="(Param param)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td> + <td class="paramname"> <em>param</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given Msg object. +<p> +SAMP_FREEPARAM -- Free the given Param object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>Param object to free </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e792eedc70daa9b2d010ca6cd8e57fe8"></a><!-- doxytag: member="sampDecl.h::samp_getAvailableHubs" ref="e792eedc70daa9b2d010ca6cd8e57fe8" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_getAvailableHubs </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a list of available Hubs. +<p> +SAMP_GETAVAILABLEHUBS -- Get a list of available Hubs<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>hub handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>List of hub handles </dd></dl> + +</div> +</div><p> +<a class="anchor" name="4946a754670217dbdbc83cca92217022"></a><!-- doxytag: member="sampDecl.h::samp_getErr" ref="4946a754670217dbdbc83cca92217022" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> samp_getErr </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the error response string. +<p> +SAMP_GETERR -- Get the error response string.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Error text string </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4e8339b2b3f5ff1a58cebb74eddca9e6"></a><!-- doxytag: member="sampDecl.h::samp_getFloatFromList" ref="4e8339b2b3f5ff1a58cebb74eddca9e6" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float samp_getFloatFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a Float from the List. +<p> +SAMP_GETFLOATFROMLIST -- Get a Float from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the desired value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>int value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b0d3768990294554a298c4057b3b315d"></a><!-- doxytag: member="sampDecl.h::samp_getFloatFromMap" ref="b0d3768990294554a298c4057b3b315d" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float samp_getFloatFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a float from the Map. +<p> +SAMP_GETFLOATFROMMAP -- Get a float from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>floating point value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="210fc0eba30abddf1bdc2e780d58072c"></a><!-- doxytag: member="sampDecl.h::samp_getIntFromMap" ref="210fc0eba30abddf1bdc2e780d58072c" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_getIntFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a integer from the Map. +<p> +SAMP_GETINTFROMMAP -- Get a integer from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>integer value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1ec1ddadb4e889792b6fa7df6f6c3125"></a><!-- doxytag: member="sampDecl.h::samp_getListFromList" ref="1ec1ddadb4e889792b6fa7df6f6c3125" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_getListFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a List from the List. +<p> +Get an Int from the List.<p> +SAMP_GETLISTFROMLIST -- Get a List from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the List </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>List handle</dd></dl> +SAMP_GETINTFROMLIST -- Get an Int from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the desired value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>int value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="31ddb90cf2184ae0151b9e7ec8c1a51f"></a><!-- doxytag: member="sampDecl.h::samp_getListFromMap" ref="31ddb90cf2184ae0151b9e7ec8c1a51f" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_getListFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a LIST from the Map. +<p> +SAMP_GETLISTFROMMAP -- Get a LIST from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to List value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="33ca96ee3a8e7d26356c7b66f469da74"></a><!-- doxytag: member="sampDecl.h::samp_getMapFromList" ref="33ca96ee3a8e7d26356c7b66f469da74" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getMapFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a Map from the List. +<p> +SAMP_GETMAPFROMLIST -- Get a Map from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the Map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Map handle </dd></dl> + +</div> +</div><p> +<a class="anchor" name="525e8ffdfa32867f392f2c1340215453"></a><!-- doxytag: member="sampDecl.h::samp_getMapFromMap" ref="525e8ffdfa32867f392f2c1340215453" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getMapFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a Map from the Map. +<p> +SAMP_GETMAPFROMMAP -- Get a Map from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to Map value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f9622190e1976c42efebd30f0c51cfe4"></a><!-- doxytag: member="sampDecl.h::samp_getMetadata" ref="f9622190e1976c42efebd30f0c51cfe4" args="(handle_t handle, char *name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_getMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the metadata item for the application. +<p> +SAMP_GETMETADATA -- Get the metadata item for the application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00173">Samp::description</a>, <a class="el" href="samp_8h_source.html#l00106">appMD::docURL</a>, <a class="el" href="samp_8h_source.html#l00105">appMD::iconURL</a>, <a class="el" href="samp_8h_source.html#l00177">Samp::meta</a>, and <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2ac4b5c50094c394a74f18d6ebe3cd91"></a><!-- doxytag: member="sampDecl.h::samp_GetMetadata" ref="2ac4b5c50094c394a74f18d6ebe3cd91" args="(handle_t handle, String pubId)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_GetMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>pubId</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the metadata for a specified app. +<p> +SAMP_GETMETADATA -- Get the metadata for a specified app.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>pubId</em> </td><td>App public-id </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Map to message response </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, and <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>.</p> + +</div> +</div><p> +<a class="anchor" name="27baec44edb57136951b5f86ae893246"></a><!-- doxytag: member="sampDecl.h::samp_getNullMap" ref="27baec44edb57136951b5f86ae893246" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getNullMap </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_GETNULLMAP -- Generate a 'Null' map we can return to the <a class="el" href="structHub.html">Hub</a>. +<p>References <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="cbf9b52550a9ab0b3515c32e692c46fb"></a><!-- doxytag: member="sampDecl.h::samp_getOKMap" ref="cbf9b52550a9ab0b3515c32e692c46fb" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getOKMap </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_GETOKMAP -- Generate an 'OK' map we can return to the <a class="el" href="structHub.html">Hub</a>. +<p>References <a class="el" href="samp_8c_source.html#l00053">nullMap</a>, <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>, <a class="el" href="sampMap_8c_source.html#l00153">samp_setMapInMap()</a>, and <a class="el" href="sampMap_8c_source.html#l00135">samp_setStringInMap()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="954712a523e3f86826b4711abd35b165"></a><!-- doxytag: member="sampDecl.h::samp_GetRegisteredClients" ref="954712a523e3f86826b4711abd35b165" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_GetRegisteredClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get public-ids of the registered clients. +<p> +SAMP_GETREGISTEREDCLIENTS -- Get public-ids of the registered clients.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to list of registered clients </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, <a class="el" href="sampList_8c_source.html#l00047">samp_newList()</a>, and <a class="el" href="sampList_8c_source.html#l00101">samp_setStringInList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6ef18dbc5870f58d2161c9ba03a81d26"></a><!-- doxytag: member="sampDecl.h::samp_getSampHandler" ref="6ef18dbc5870f58d2161c9ba03a81d26" args="(String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* samp_getSampHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the Samphandler for the named mtype. +<p> +SAMP_GETSAMPHANDLER -- Get the Samphandler for the named mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, and <a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">Subs::sampFunc</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2d1cd41c4583ac300aaa2d50ad3f76ed"></a><!-- doxytag: member="sampDecl.h::samp_getStringFromList" ref="2d1cd41c4583ac300aaa2d50ad3f76ed" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_getStringFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a string from the List. +<p> +SAMP_GETSTRINGFROMLIST -- Get a string from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>character string </dd></dl> + +</div> +</div><p> +<a class="anchor" name="96ca606e0e7da659c3dc0a30846bcd66"></a><!-- doxytag: member="sampDecl.h::samp_getStringFromMap" ref="96ca606e0e7da659c3dc0a30846bcd66" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_getStringFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a string from the Map. +<p> +SAMP_GETSTRINGFROMMAP -- Get a string from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>string value from Map </dd></dl> + +</div> +</div><p> +<a class="anchor" name="367a24fc0aa7a81416e6a0d0dbfcd93f"></a><!-- doxytag: member="sampDecl.h::samp_GetSubscribedClients" ref="367a24fc0aa7a81416e6a0d0dbfcd93f" args="(handle_t handle, String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_GetSubscribedClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get clients matching the mtype subscription. +<p> +SAMP_GETSUBSCRIBEDCLIENTS -- Get clients matching the mtype subscription.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to list of clients having mtype subscription </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, <a class="el" href="sampList_8c_source.html#l00047">samp_newList()</a>, and <a class="el" href="sampList_8c_source.html#l00101">samp_setStringInList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6bb258d378627da1aa0254fccdb6bd2c"></a><!-- doxytag: member="sampDecl.h::samp_getUserHandler" ref="6bb258d378627da1aa0254fccdb6bd2c" args="(String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* samp_getUserHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the User handler for the named mtype. +<p> +SAMP_GETUSERHANDLER -- Get the User handler for the named mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, and <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs::userFunc</a>.</p> + +</div> +</div><p> +<a class="anchor" name="52f471568663ac6f0116d57a9ce00f00"></a><!-- doxytag: member="sampDecl.h::samp_hubClose" ref="52f471568663ac6f0116d57a9ce00f00" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubClose </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Close a connection to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBCLOSE -- Close a connection to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>hub handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>unregister status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00147">Hub::meta</a>, <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>, <a class="el" href="sampUtil_8c_source.html#l00072">samp_freeHandle()</a>, and <a class="el" href="sampHub_8c_source.html#l00395">samp_hubUnRegister()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="088f1e762175d0dbc315853d06e50149"></a><!-- doxytag: member="sampDecl.h::samp_hubDeclareMetadata" ref="088f1e762175d0dbc315853d06e50149" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubDeclareMetadata </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declare "standard" metadata to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_DECLAREMETADATA -- Declare "standard" metadata to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00145">Hub::description</a>, <a class="el" href="samp_8h_source.html#l00106">appMD::docURL</a>, <a class="el" href="samp_8h_source.html#l00105">appMD::iconURL</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00147">Hub::meta</a>, <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>, and <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>.</p> + +</div> +</div><p> +<a class="anchor" name="7be493427eac28b2a064eedd8a7d63ff"></a><!-- doxytag: member="sampDecl.h::samp_hubDeclareSubscriptions" ref="7be493427eac28b2a064eedd8a7d63ff" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubDeclareSubscriptions </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declare mtype subscriptions to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBDECLARESUBSCRIPTIONS -- Declare mtype subscriptions to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, <a class="el" href="samp_8c_source.html#l00053">nullMap</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="samp_8h_source.html#l00161">Hub::samp</a>, <a class="el" href="sampMap_8c_source.html#l00067">samp_freeMap()</a>, and <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs::userFunc</a>.</p> + +</div> +</div><p> +<a class="anchor" name="19f64b527fcc431541206e41f8e36132"></a><!-- doxytag: member="sampDecl.h::samp_hubEvent" ref="19f64b527fcc431541206e41f8e36132" args="(String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubEvent </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. +<p> +SAMP_HUBEVENT -- Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="structHub.html">Hub</a> event code or -1 if not found </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00070">HUB_SHUTDOWN</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2b208c34c0e6017f071b9ce654d0f3d6"></a><!-- doxytag: member="sampDecl.h::samp_hubOpen" ref="2b208c34c0e6017f071b9ce654d0f3d6" args="(Samp *samp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t samp_hubOpen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structSamp.html">Samp</a> * </td> + <td class="paramname"> <em>sampP</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Discover and open a connection to the SAMP <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBOPEN -- Discover and open a connection to the SAMP <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>samp</em> </td><td>Same structure </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>hub handle </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00155">Hub::appId</a>, <a class="el" href="samp_8h_source.html#l00172">Samp::appVer</a>, <a class="el" href="samp_8h_source.html#l00144">Hub::appVer</a>, <a class="el" href="samp_8h_source.html#l00104">appMD::desc</a>, <a class="el" href="samp_8h_source.html#l00145">Hub::description</a>, <a class="el" href="samp_8h_source.html#l00173">Samp::description</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00147">Hub::meta</a>, <a class="el" href="samp_8h_source.html#l00161">Hub::samp</a>, <a class="el" href="sampHub_8c_source.html#l00354">samp_hubRegister()</a>, <a class="el" href="sampHub_8c_source.html#l00448">samp_hubSetXmlrpcCallback()</a>, <a class="el" href="sampUtil_8c_source.html#l00049">samp_newHandle()</a>, <a class="el" href="sampUtil_8c_source.html#l00108">samp_P2H()</a>, <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>, and <a class="el" href="samp_8h_source.html#l00150">Hub::url</a>.</p> + +</div> +</div><p> +<a class="anchor" name="47b1a9a4627fde97f95b40b372153cf6"></a><!-- doxytag: member="sampDecl.h::samp_hubPing" ref="47b1a9a4627fde97f95b40b372153cf6" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubPing </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Ping the <a class="el" href="structHub.html">Hub</a> to see if it is alive. +<p> +SAMP_HUBPING -- Ping the <a class="el" href="structHub.html">Hub</a> to see if it is alive.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, and <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>.</p> + +</div> +</div><p> +<a class="anchor" name="13ad32079ae1db571e3114b7bd8ba356"></a><!-- doxytag: member="sampDecl.h::samp_hubRegister" ref="13ad32079ae1db571e3114b7bd8ba356" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubRegister </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a Register message to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUB_REGISTER -- Send a Register message to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00157">Hub::hubId</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="samp_8h_source.html#l00149">Hub::secret</a>, and <a class="el" href="samp_8h_source.html#l00158">Hub::selfId</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a704d2a0d290f2fdfb3ebfffc39adcb3"></a><!-- doxytag: member="sampDecl.h::samp_hubSendShutdown" ref="a704d2a0d290f2fdfb3ebfffc39adcb3" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubSendShutdown </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a samp.app.event.shutdown message to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBSENDSHUTDOWN -- Send a samp.app.event.shutdown message to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, and <a class="el" href="sampHandlers_8c_source.html#l01582">samp_nullResponse()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2fcb0032e5ae98fff93becdb06da49f9"></a><!-- doxytag: member="sampDecl.h::samp_hubSetXmlrpcCallback" ref="2fcb0032e5ae98fff93becdb06da49f9" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubSetXmlrpcCallback </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the client callback and send to <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBSETXMLRPCCALLBACK -- Set the client callback and send to <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, and <a class="el" href="sampUtil_8c_source.html#l00194">samp_serverPort()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6d4e32ed0eb19f02cc8a75f75a98deec"></a><!-- doxytag: member="sampDecl.h::samp_hubUnRegister" ref="6d4e32ed0eb19f02cc8a75f75a98deec" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubUnRegister </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a UnRegister message to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBUNREGISTER -- Send a UnRegister message to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, and <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a75368198ec8cd2fff6ad304806862b8"></a><!-- doxytag: member="sampDecl.h::samp_id2app" ref="a75368198ec8cd2fff6ad304806862b8" args="(handle_t handle, char *pubId)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_id2app </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>pubId</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Convert a public-ID to the application name. +<p> +SAMP_ID2APP -- Convert a public-ID to the application name.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>pubId</em> </td><td>public ID of application </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>name of registered application </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, and <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4812b571ed87f7842ca20b7024770df3"></a><!-- doxytag: member="sampDecl.h::samp_imageLoadFITS" ref="4812b571ed87f7842ca20b7024770df3" args="(handle_t handle, String recip, String url, String imageId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_imageLoadFITS </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>imageId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to load a FITS image. +<p> +SAMP_IMAGELOADFITS -- Tell an app to load a FITS image.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>imageId</em> </td><td>ID assigned to image (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name assigned to image (optional) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="9bd8036dd65dc4f874f39568b691a123"></a><!-- doxytag: member="sampDecl.h::samp_imLoadHandler" ref="9bd8036dd65dc4f874f39568b691a123" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_imLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle an image.load.fits message. +<p> +SAMP_IMLOADHANDLER -- Handle an image.load.fits message.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1e494e73abe2ddfd946fb39e84da42a9"></a><!-- doxytag: member="sampDecl.h::samp_listClients" ref="1e494e73abe2ddfd946fb39e84da42a9" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_listClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_LISTCLIENTS -- List the available clients to stdout. +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, and <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c260afb0cbf19b427e3eba96a2341e52"></a><!-- doxytag: member="sampDecl.h::samp_listLen" ref="c260afb0cbf19b427e3eba96a2341e52" args="(List list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_listLen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get number of elements in a List. +<p> +SAMP_LISTLEN -- Get number of elements in a List.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ff4d125fc9594be25984989fad2fd3c8"></a><!-- doxytag: member="sampDecl.h::samp_mapClients" ref="ff4d125fc9594be25984989fad2fd3c8" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_mapClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_MAPCLIENTS -- Map the public-ids of registered clients to the appName. +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="sampList_8c_source.html#l00063">samp_freeList()</a>, <a class="el" href="sampCommands_8c_source.html#l00188">samp_GetMetadata()</a>, <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, <a class="el" href="sampList_8c_source.html#l00192">samp_getStringFromList()</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2e77115e730e95b31d897b8c50999b74"></a><!-- doxytag: member="sampDecl.h::samp_Metadata" ref="2e77115e730e95b31d897b8c50999b74" args="(handle_t handle, String field, String value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_Metadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a metadata field value for the application. +<p> +SAMP_METADATA -- Set a metadata field for the application. This will be sent to the <a class="el" href="structHub.html">Hub</a> later in a declareMetadata() call.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>field</em> </td><td>metadata field to set (name, author, etc) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>samp</em> </td><td>value of field </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00172">Samp::appVer</a>, <a class="el" href="samp_8h_source.html#l00144">Hub::appVer</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00104">appMD::desc</a>, <a class="el" href="samp_8h_source.html#l00145">Hub::description</a>, <a class="el" href="samp_8h_source.html#l00173">Samp::description</a>, <a class="el" href="samp_8h_source.html#l00106">appMD::docURL</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00105">appMD::iconURL</a>, <a class="el" href="samp_8h_source.html#l00147">Hub::meta</a>, <a class="el" href="samp_8h_source.html#l00177">Samp::meta</a>, <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>, and <a class="el" href="sampLog_8c_source.html#l00091">sampTrace()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="281c8f7f8b21a74704dd200d5aaed481"></a><!-- doxytag: member="sampDecl.h::samp_msgParam" ref="281c8f7f8b21a74704dd200d5aaed481" args="(Msg msg, Param param)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_msgParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td> + <td class="paramname"> <em>param</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a parameter to the Msg. +<p> +SAMP_MSGPARAM -- Add a parameter to the Msg.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>parameter map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b5375a6478dccefe7df2b48416604b29"></a><!-- doxytag: member="sampDecl.h::samp_newList" ref="b5375a6478dccefe7df2b48416604b29" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t samp_newList </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new List object. +<p> +SAMP_NEWLIST -- Create a new List object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to List object </dd></dl> + +</div> +</div><p> +<a class="anchor" name="55c96c3dfe79d00b8445a60769785dae"></a><!-- doxytag: member="sampDecl.h::samp_newMap" ref="55c96c3dfe79d00b8445a60769785dae" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t samp_newMap </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new Map object. +<p> +SAMP_NEWMAP -- Create a new Map object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Map </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1a66c53bb9e023fb0219ab9baeded3d6"></a><!-- doxytag: member="sampDecl.h::samp_newMsg" ref="1a66c53bb9e023fb0219ab9baeded3d6" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> samp_newMsg </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new Msg object. +<p> +SAMP_NEWMSG -- Create a new Msg object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Msg </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c58f0b105566a61785fb9f2ed9b42830"></a><!-- doxytag: member="sampDecl.h::samp_newParam" ref="c58f0b105566a61785fb9f2ed9b42830" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> samp_newParam </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new Param object. +<p> +SAMP_NEWPARAM -- Create a new Param object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Param </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c73788ae17493c4042948f6b861ddd74"></a><!-- doxytag: member="sampDecl.h::samp_notify" ref="c73788ae17493c4042948f6b861ddd74" args="(handle_t handle, String recipId, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_notify </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recipId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a notify() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_NOTIFY -- Make a notify() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recipId</em> </td><td>recipient ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, and <a class="el" href="sampHandlers_8c_source.html#l01582">samp_nullResponse()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f48228224c20ddaf8b4b4ce39fa6ec16"></a><!-- doxytag: member="sampDecl.h::samp_notifyAll" ref="f48228224c20ddaf8b4b4ce39fa6ec16" args="(handle_t handle, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_notifyAll </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a notifyAll() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_NOTIFYALL -- Make a notifyAll() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5361571754505eaefdf5739cd3e9519e"></a><!-- doxytag: member="sampDecl.h::samp_nullResponse" ref="5361571754505eaefdf5739cd3e9519e" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_nullResponse </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_NULLRESPONSE -- Handler to ignore async replies. +</div> +</div><p> +<a class="anchor" name="19b75403d63714c4fccc8a8d4fa4c8cf"></a><!-- doxytag: member="sampDecl.h::samp_paramGet" ref="19b75403d63714c4fccc8a8d4fa4c8cf" args="(handle_t handle, String recip, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_paramGet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a parameter variable in a remote application. +<p> +SAMP_PARAMGET -- Get a parameter variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL, Value of variable, or list of values </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>.</p> + +</div> +</div><p> +<a class="anchor" name="659c272ce881662c1826a04728dc06f6"></a><!-- doxytag: member="sampDecl.h::samp_paramGetHandler" ref="659c272ce881662c1826a04728dc06f6" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramGetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.param.set message. +<p> +SAMP_PARAMGETHANDLER -- Handle a client.param.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00067">samp_freeMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>, <a class="el" href="sampMethods_8c_source.html#l00237">samp_setHandlerReply()</a>, <a class="el" href="sampMap_8c_source.html#l00153">samp_setMapInMap()</a>, <a class="el" href="sampMap_8c_source.html#l00135">samp_setStringInMap()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d8c5669be313874fef1c484643683f49"></a><!-- doxytag: member="sampDecl.h::samp_paramInit" ref="d8c5669be313874fef1c484643683f49" args="(Msg msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> samp_paramInit </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get number of Params. +<p> +SAMP_PARAMINIT -- Get number of Params.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7680995e5d4f26ea3d91bf72c9c72e51"></a><!-- doxytag: member="sampDecl.h::samp_paramLen" ref="7680995e5d4f26ea3d91bf72c9c72e51" args="(Msg msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramLen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get number of Params. +<p> +SAMP_PARAMLEN -- Get number of Params.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="535cb6760c733a75746d2f104b1a01be"></a><!-- doxytag: member="sampDecl.h::samp_paramSet" ref="535cb6760c733a75746d2f104b1a01be" args="(handle_t handle, String recip, String name, String value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramSet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an parameter variable in a remote application. +<p> +SAMP_PARAMSET -- Set an parameter variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value of variable or NULL </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="071aa9e32f2e94d5b667e87cf65d2bdf"></a><!-- doxytag: member="sampDecl.h::samp_paramSetHandler" ref="071aa9e32f2e94d5b667e87cf65d2bdf" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramSetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.param.set message. +<p> +SAMP_PARAMSETHANDLER -- Handle a client.param.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2be0812dc8d34c68407c62762f727c51"></a><!-- doxytag: member="sampDecl.h::samp_Ping" ref="2be0812dc8d34c68407c62762f727c51" args="(handle_t handle, String appName)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_Ping </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>appName</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Ping the hub/app to see if it is alive (returns >0). +<p> +SAMP_PING -- Ping the hub/app to see if it is alive (returns >0).<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>appName</em> </td><td>application name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>OK or ERR if no response </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMap_8c_source.html#l00067">samp_freeMap()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampHub_8c_source.html#l00483">samp_hubPing()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampClient_8c_source.html#l00360">samp_setErr()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="16d8b8822d169107b8702ae753797923"></a><!-- doxytag: member="sampDecl.h::samp_PingHandler" ref="16d8b8822d169107b8702ae753797923" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_PingHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Is app alive and responding to messages? +<p> +SAMP_PINGHANDLER -- Simple aliveness test function.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, and <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3f5632858a2b09759ffe98cd2e183cfb"></a><!-- doxytag: member="sampDecl.h::samp_pointAtHandler" ref="3f5632858a2b09759ffe98cd2e183cfb" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_pointAtHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a coord.pointAt.sky message. +<p> +SAMP_POINTATHANDLER -- Handle a coord.pointAt.sky message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00308">samp_getFloatFromMap()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a8a947c24f2c9333adf4e5d7fa11d134"></a><!-- doxytag: member="sampDecl.h::samp_printMap" ref="a8a947c24f2c9333adf4e5d7fa11d134" args="(String name, Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_printMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_PRINTMAP -- Print the contents of a Map structure. +</div> +</div><p> +<a class="anchor" name="ace22fd6ada035930ef93e5a54c375b1"></a><!-- doxytag: member="sampDecl.h::samp_printMetadata" ref="ace22fd6ada035930ef93e5a54c375b1" args="(handle_t handle, char *name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_printMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Print the metadata for the application. +<p> +SAMP_PRINTMETADATA -- Print the metadata for the application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00173">Samp::description</a>, <a class="el" href="samp_8h_source.html#l00106">appMD::docURL</a>, <a class="el" href="samp_8h_source.html#l00105">appMD::iconURL</a>, <a class="el" href="samp_8h_source.html#l00177">Samp::meta</a>, and <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2933b26ac05c440196368edad0167bdf"></a><!-- doxytag: member="sampDecl.h::samp_processHubEvent" ref="2933b26ac05c440196368edad0167bdf" args="(String mtype, Map params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_processHubEvent </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>params</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. +<p> +SAMP_HUBEVENT -- Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>message parameter Map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>non-zero value if a <a class="el" href="structHub.html">Hub</a> event was processed </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00070">HUB_SHUTDOWN</a>, <a class="el" href="samp_8c_source.html#l00834">samp_addClient()</a>, <a class="el" href="sampHub_8c_source.html#l00320">samp_hubEvent()</a>, <a class="el" href="sampHub_8c_source.html#l00031">samp_mutex</a>, <a class="el" href="sampUtil_8c_source.html#l00108">samp_P2H()</a>, <a class="el" href="samp_8c_source.html#l00908">samp_removeClient()</a>, <a class="el" href="samp_8c_source.html#l00051">sampH</a>, and <a class="el" href="samp_8c_source.html#l00323">sampShutdown()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="59f85e0fce4c9ae7121c98e137d3f743"></a><!-- doxytag: member="sampDecl.h::samp_receiveCall" ref="59f85e0fce4c9ae7121c98e137d3f743" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_receiveCall </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +test.echo method +<p> +receiveCall () client method.<p> +SAMP_TESTECHO -- test.echo method<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno</dd></dl> +SAMP_RECEIVECALL -- receiveCall() client method.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampMethods_8c_source.html#l00252">samp_getHandlerReply()</a>, <a class="el" href="sampHandlers_8c_source.html#l00159">samp_getSampHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampClient_8c_source.html#l00278">samp_Reply()</a>, <a class="el" href="samp_8c_source.html#l00051">sampH</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="03be7cc9e154a6ccdd499286df640936"></a><!-- doxytag: member="sampDecl.h::samp_receiveNotification" ref="03be7cc9e154a6ccdd499286df640936" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_receiveNotification </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +receiveNotification () client method. +<p> +SAMP_RECEIVENOTIFICATION -- receiveNotification() client method.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampMethods_8c_source.html#l00252">samp_getHandlerReply()</a>, <a class="el" href="sampHandlers_8c_source.html#l00159">samp_getSampHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="754b50ad59145c7fd1e4c8f4277f11e4"></a><!-- doxytag: member="sampDecl.h::samp_receiveResponse" ref="754b50ad59145c7fd1e4c8f4277f11e4" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_receiveResponse </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +receiveResponse () client method. +<p> +SAMP_RECEIVERESPONSE -- receiveResponse() client method.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="84ffd50bd4b8dc79e9cf32398c6b3d69"></a><!-- doxytag: member="sampDecl.h::samp_Register" ref="84ffd50bd4b8dc79e9cf32398c6b3d69" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_Register </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Register with the <a class="el" href="structHub.html">Hub</a> using the currently stored metadata. +<p> +SAMP_REGISTER -- Register with the <a class="el" href="structHub.html">Hub</a> using the currently stored metadata.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00157">Hub::hubId</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="samp_8c_source.html#l00723">samp_replyStatus()</a>, <a class="el" href="samp_8h_source.html#l00149">Hub::secret</a>, and <a class="el" href="samp_8h_source.html#l00158">Hub::selfId</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e30e492f306a40f853a454faf60ab479"></a><!-- doxytag: member="sampDecl.h::samp_removeClient" ref="e30e492f306a40f853a454faf60ab479" args="(handle_t handle, String id)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_removeClient </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>id</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_REMOVECLIENT -- Remove a registered client from the list of known apps that do the public-private name translation. +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="9c6ff3d76997c3d7301a977309a117e0"></a><!-- doxytag: member="sampDecl.h::samp_Reply" ref="9c6ff3d76997c3d7301a977309a117e0" args="(handle_t handle, String msg_id, Map resp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_Reply </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>response</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reply to a message. +<p> +SAMP_REPLY -- Reply to a message. All we do here is send the reply message, we require that the response Map already be defined.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>response</em> </td><td>response map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, and <a class="el" href="sampHandlers_8c_source.html#l01582">samp_nullResponse()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d47754f3b9fceff4d3019821519432b4"></a><!-- doxytag: member="sampDecl.h::samp_replyStatus" ref="d47754f3b9fceff4d3019821519432b4" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_replyStatus </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reply with the status of the last message sent. +<p> +SAMP_REPLYSTATUS -- Reply with the status of the last message sent.<p> +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<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>samp</em> </td><td>samp struct ptr </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>message status </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="287569451dc1bf59d1f9f6d13b56716d"></a><!-- doxytag: member="sampDecl.h::samp_resConeHandler" ref="287569451dc1bf59d1f9f6d13b56716d" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resConeHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESCONEHANDLER -- Handle a voresource.loadlist.cone message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c0bf7cf7fea362c0c82ad7bc3f267c48"></a><!-- doxytag: member="sampDecl.h::samp_resLoadHandler" ref="c0bf7cf7fea362c0c82ad7bc3f267c48" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESLOADHANDLER -- handle a voresource.loadlist.* message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8013c549ef47e0507edf39c8ab1b62aa"></a><!-- doxytag: member="sampDecl.h::samp_resourceLoad" ref="8013c549ef47e0507edf39c8ab1b62aa" args="(handle_t handle, String recip, String type, String name, Map resMap)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resourceLoad </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>resMap</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Exchange a resource list. +<p> +SAMP_RESOURCELOAD -- Exchange a resource list.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Resource type (or NULL) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Descriptive name (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>resMap</em> </td><td>Resource map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00116">samp_addMapParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8b2300222d7b11f144eb4385412e69a5"></a><!-- doxytag: member="sampDecl.h::samp_resSiapHandler" ref="8b2300222d7b11f144eb4385412e69a5" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resSiapHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESSIAPHANDLER -- Handle a voresource.loadlist.siap message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="866578a01c3b762435823b1b11869c42"></a><!-- doxytag: member="sampDecl.h::samp_resSsapHandler" ref="866578a01c3b762435823b1b11869c42" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resSsapHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESSSAPHANDLER -- Handle a voresource.loadlist.ssap message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ad42ca17cbaf23012ad497559ea45e4c"></a><!-- doxytag: member="sampDecl.h::samp_resTapHandler" ref="ad42ca17cbaf23012ad497559ea45e4c" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resTapHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESTAPHANDLER -- Handle a voresource.loadlist.tap message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="fa207ebdc587ba5eeab60fbf79b635d4"></a><!-- doxytag: member="sampDecl.h::samp_resVOSpaceHandler" ref="fa207ebdc587ba5eeab60fbf79b635d4" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resVOSpaceHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESVOSPACEHANDLER -- Handle a voresource.loadlist.vospace message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b2ff2e029c57b56ad57416c624341fe6"></a><!-- doxytag: member="sampDecl.h::samp_sendGeneric" ref="b2ff2e029c57b56ad57416c624341fe6" args="(handle_t handle, String recip, String mtype, String args[])" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_sendGeneric </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>args</em>[]</td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a geenric message. +<p> +SAMP_SENDGENERIC -- Send a generic message.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>Message type </td></tr> + <tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>Argument list </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR</dd></dl> +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. +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00181">samp_addFloatParam()</a>, <a class="el" href="sampParam_8c_source.html#l00154">samp_addIntParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="80ef1a82845b96091857c7d4a3c7972c"></a><!-- doxytag: member="sampDecl.h::samp_sendMsg" ref="80ef1a82845b96091857c7d4a3c7972c" args="(handle_t handle, String recip, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_sendMsg </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send the specified message. +<p> +SAMP_SENDMSG -- Send the specified message.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, and <a class="el" href="sampClient_8c_source.html#l00360">samp_setErr()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0af6dba3d1022e6b220a9b1076021353"></a><!-- doxytag: member="sampDecl.h::samp_serverPort" ref="0af6dba3d1022e6b220a9b1076021353" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_serverPort </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return a unique port number for the server. +<p> +SAMP_SERVERPORT -- Return a unique port number for the server.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>port number </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8fbfdc550ede5d52840300ab33639c49"></a><!-- doxytag: member="sampDecl.h::samp_setAppVersion" ref="8fbfdc550ede5d52840300ab33639c49" args="(handle_t handle, String version)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setAppVersion </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>version</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the application name string. +<p> +Set the application version string.<p> +SAMP_SETAPPNAME -- Set the application name string.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>application name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing</dd></dl> +SAMP_SETAPPVERSION -- Set the application version string.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>application version </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00144">Hub::appVer</a>, <a class="el" href="samp_8h_source.html#l00172">Samp::appVer</a>, and <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a9aef12dd82bfd38a2382a4ac88c54af"></a><!-- doxytag: member="sampDecl.h::samp_setASyncMode" ref="a9aef12dd82bfd38a2382a4ac88c54af" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setASyncMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the calling mode to use asynchronous messaging. +<p> +SAMP_SETASYNCMODE -- Set the calling mode to use asynchronous messaging.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d4c1514e94c9ef511cfcd27004c38c4d"></a><!-- doxytag: member="sampDecl.h::samp_setCallByRef" ref="d4c1514e94c9ef511cfcd27004c38c4d" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setCallByRef </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Have interface call user handlers by reference. +<p> +SAMP_SETCALLBYREF -- Have interface call user handlers by reference.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="fc27715ec9a5cb60cf0b5415eb7f9a48"></a><!-- doxytag: member="sampDecl.h::samp_setCallMode" ref="fc27715ec9a5cb60cf0b5415eb7f9a48" args="(handle_t handle, int mode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setCallMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>mode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the default calling mode (synch or asynch). +<p> +SAMP_SETCALLMODE -- Set the default calling mode (synch or asynch)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>call mode (synch or asynch) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="91aeabe77e920fc1924b1cdc4f088e64"></a><!-- doxytag: member="sampDecl.h::samp_setErr" ref="91aeabe77e920fc1924b1cdc4f088e64" args="(handle_t handle, Map resp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_setErr </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>resp</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the error response string. +<p> +SAMP_SETERR -- Set the error response string/code.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>resp</em> </td><td>Response map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>.</p> + +</div> +</div><p> +<a class="anchor" name="041a551aff57ca03f3ff72a9803e2b58"></a><!-- doxytag: member="sampDecl.h::samp_setFloatInList" ref="041a551aff57ca03f3ff72a9803e2b58" args="(List list, float value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setFloatInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>rval</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Float in a List (append). +<p> +SAMP_SETFLOATINLIST -- Set a Float in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list1</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>rval</em> </td><td>Float value to be appended </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0f07ae542f5b317311b3799bd96a88fd"></a><!-- doxytag: member="sampDecl.h::samp_setFloatInMap" ref="0f07ae542f5b317311b3799bd96a88fd" args="(Map map, char *key, float value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setFloatInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a string in a Map (append). +<p> +SAMP_SETFLOATINMAP -- Set a Float in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2d8a8a26d7284bb211a933895cddd29c"></a><!-- doxytag: member="sampDecl.h::samp_setIntInList" ref="2d8a8a26d7284bb211a933895cddd29c" args="(List list, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setIntInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>ival</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an Int in a List (append). +<p> +SAMP_SETINTINLIST -- Set an Int in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list1</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>ival</em> </td><td>Integer value to be appended </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c22ec42dbf9a01c9b4e00cf011e7eb9d"></a><!-- doxytag: member="sampDecl.h::samp_setIntInMap" ref="c22ec42dbf9a01c9b4e00cf011e7eb9d" args="(Map map, char *key, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setIntInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Int in a Map (append). +<p> +SAMP_SETINTINMAP -- Set a Int in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0ff97d44e62b7c88a046a29324552400"></a><!-- doxytag: member="sampDecl.h::samp_setListInList" ref="0ff97d44e62b7c88a046a29324552400" args="(List list1, List list2)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setListInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list2</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a List in another List (append). +<p> +SAMP_SETLISTINLIST -- Set a List in another List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list1</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>list2</em> </td><td>List to be appended </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="362c2f670c98dd6a3ef69debd1871604"></a><!-- doxytag: member="sampDecl.h::samp_setListInMap" ref="362c2f670c98dd6a3ef69debd1871604" args="(Map map, char *key, List list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setListInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a List in a Map (append). +<p> +SAMP_SETLISTINMAP -- Set a List in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>handle to List object to set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ea188bb711f3b5549d11204b0ff2da08"></a><!-- doxytag: member="sampDecl.h::samp_setMapInList" ref="ea188bb711f3b5549d11204b0ff2da08" args="(List list, Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setMapInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Map in a List (append). +<p> +SAMP_SETMAPINLIST -- Set a Map in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>Map object to be set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f102490efe1b92d99b67f244dc498c7b"></a><!-- doxytag: member="sampDecl.h::samp_setMapInMap" ref="f102490efe1b92d99b67f244dc498c7b" args="(Map map1, char *key, Map map2)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setMapInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map2</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Map in a Map (append). +<p> +SAMP_SETMAPINMAP -- Set a Map in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map1</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>map2</em> </td><td>handle to Map object to set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9056a8601300892f918835259c7fdb3b"></a><!-- doxytag: member="sampDecl.h::samp_setNotifyMode" ref="9056a8601300892f918835259c7fdb3b" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setNotifyMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the calling mode to use notification messaging. +<p> +SAMP_SETNOTIFYMODE -- Set the calling mode to use notification messaging.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a3c0bdb4c512357dbc53b0ad7a7d5b01"></a><!-- doxytag: member="sampDecl.h::samp_setReplyCallback" ref="a3c0bdb4c512357dbc53b0ad7a7d5b01" args="(handle_t handle, int *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setReplyCallback </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func). +<p> +SAMP_SETREPLYCALLBACK -- Set the Reply callback.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback for Reply message </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3db66f28546459327665f8491ea97f4d"></a><!-- doxytag: member="sampDecl.h::samp_setResponseCallback" ref="3db66f28546459327665f8491ea97f4d" args="(handle_t handle, int *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setResponseCallback </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the Response callback. samp_setResponseCallback (handle_t handle, int *func). +<p> +SAMP_SETRESPONSECALLBACK -- Set the Response callback.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback for message response </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2e8ec01a0dd96314622ae313206583db"></a><!-- doxytag: member="sampDecl.h::samp_setSampHandler" ref="2e8ec01a0dd96314622ae313206583db" args="(handle_t handle, String mtype, void *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setSampHandler </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the SAMP interface handler for the mtype. +<p> +SAMP_SETSAMPHANDLER -- Set the SAMP interface handler for the mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, and <a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">Subs::sampFunc</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5b69180b036e58528c98b1cf5a42825a"></a><!-- doxytag: member="sampDecl.h::samp_setStringInList" ref="5b69180b036e58528c98b1cf5a42825a" args="(List list, char *value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setStringInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a string in a List (append). +<p> +SAMP_SETSTRINGINLIST -- Set a string in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>string value to set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b9b2157de89369eb5cd95bfe804eb89a"></a><!-- doxytag: member="sampDecl.h::samp_setStringInMap" ref="b9b2157de89369eb5cd95bfe804eb89a" args="(Map map, char *key, char *value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setStringInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a string in a Map (append). +<p> +SAMP_SETSTRINGINMAP -- Set a string in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Map value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1d00dc78292cfbc01262ef65ab055063"></a><!-- doxytag: member="sampDecl.h::samp_setSyncMode" ref="1d00dc78292cfbc01262ef65ab055063" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setSyncMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the calling mode to use synchronous messaging. +<p> +SAMP_SETSYNCMODE -- Set the calling mode to use synchronous messaging.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e11a97c262ab5ab4438eca6c60c0d8cf"></a><!-- doxytag: member="sampDecl.h::samp_setTimeout" ref="e11a97c262ab5ab4438eca6c60c0d8cf" args="(handle_t handle, int timeout)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setTimeout </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>timeout</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the message timeout value (in seconds). +<p> +SAMP_SETTIMEOUT -- Set the message timeout value (in seconds).<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>application name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, and <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>.</p> + +</div> +</div><p> +<a class="anchor" name="81222e1f3572585fa30f11a78aa08c3f"></a><!-- doxytag: member="sampDecl.h::samp_setUserHandler" ref="81222e1f3572585fa30f11a78aa08c3f" args="(handle_t handle, String mtype, void *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setUserHandler </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the user-interface handler for the mtype. +<p> +SAMP_SETUSERHANDLER -- Set the user-interface handler for the mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, and <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs::userFunc</a>.</p> + +</div> +</div><p> +<a class="anchor" name="bc319b97b3dbea29bd79c4f723db5438"></a><!-- doxytag: member="sampDecl.h::samp_specLoadHandler" ref="bc319b97b3dbea29bd79c4f723db5438" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_specLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a spectrum.load.* message. +<p> +SAMP_SPECLOADHANDLER -- Handle a spectrum.load.* message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="18b351385bd175581a6788a4f7342f07"></a><!-- doxytag: member="sampDecl.h::samp_specLoadSSAGeneric" ref="18b351385bd175581a6788a4f7342f07" args="(handle_t handle, String recip, String url, Map meta, String spectrumId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_specLoadSSAGeneric </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>meta</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>spectrumId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Load a generic spectrum from an SSA service. +<p> +SAMP_SPECLOADSSAGENERIC -- Load a generic spectrum from an SSA service.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL of spectrum to load </td></tr> + <tr><td valign="top"></td><td valign="top"><em>meta</em> </td><td>Metadata map describing data found at the URL </td></tr> + <tr><td valign="top"></td><td valign="top"><em>spectrumId</em> </td><td>Identifier for spectrum (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name used to label spectrum (optional); </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00116">samp_addMapParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="dd2bca8fa3bf3b4ebbf449edc6b65d85"></a><!-- doxytag: member="sampDecl.h::samp_specSSAHandler" ref="dd2bca8fa3bf3b4ebbf449edc6b65d85" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_specSSAHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a spectrum.load.ssa-generic message. +<p> +SAMP_SPECSSAHANDLER -- Handle a spectrum.load.ssa-generic message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2e342b672e77e012cc98a6f5506a44be"></a><!-- doxytag: member="sampDecl.h::samp_StatusHandler" ref="2e342b672e77e012cc98a6f5506a44be" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_StatusHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return status of the task. +<p> +SAMP_STATUSHANDLER -- Return status of the task.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, and <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c6b76655d73825acdacfac8b5a1139ee"></a><!-- doxytag: member="sampDecl.h::samp_Subscribe" ref="c6b76655d73825acdacfac8b5a1139ee" args="(handle_t handle, String mtype, void *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_Subscribe </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>userFunc</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Subscribe to a given mtype. +<p> +SAMP_SUBSCRIBE -- Subscribe to a given mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, <a class="el" href="sampHandlers_8c_source.html#l00159">samp_getSampHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00090">samp_setSampHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00046">samp_setUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e38ac987f1dfd87ad64f97d55396270e"></a><!-- doxytag: member="sampDecl.h::samp_tableHighlightRow" ref="e38ac987f1dfd87ad64f97d55396270e" args="(handle_t handle, String recip, String tableId, String url, int row)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tableHighlightRow </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>row</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to highlight a table row. +<p> +SAMP_TABLEHIGHLIGHTROW -- Tell an app to highlight a table row.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID associated with a previously loaded table </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>rows</em> </td><td>List of (zero-based) row indices </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00154">samp_addIntParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="74aeaaf742121348390ec854c30c1479"></a><!-- doxytag: member="sampDecl.h::samp_tableLoadFITS" ref="74aeaaf742121348390ec854c30c1479" args="(handle_t handle, String recip, String url, String tableId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tableLoadFITS </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to load a FITS table. +<p> +SAMP_TABLELOADFITS -- Tell an app to load a FITS table.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID assigned to table (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name assigned to table (optional) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="34e9d38073f36daaf41c418f8d680ee5"></a><!-- doxytag: member="sampDecl.h::samp_tableLoadVOTable" ref="34e9d38073f36daaf41c418f8d680ee5" args="(handle_t handle, String recip, String url, String tableId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tableLoadVOTable </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to load a VOTable. +<p> +SAMP_TABLELOADVOTABLE -- Tell an app to load a VOTable.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID assigned to table (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name assigned to table (optional) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f133efb67fe4bcfd2b9c8ab9d23b4c5e"></a><!-- doxytag: member="sampDecl.h::samp_tableSelectRowList" ref="f133efb67fe4bcfd2b9c8ab9d23b4c5e" args="(handle_t handle, String recip, String tableId, String url, int rows[], int nrows)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tableSelectRowList </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>rows</em>[], </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>nrows</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to select a list of table rows. +<p> +SAMP_TABLESELECTROWLIST -- Tell an app to select a list of table rows.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID associated with a previously loaded table </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>rows</em> </td><td>Array of (zero-based) row indices </td></tr> + <tr><td valign="top"></td><td valign="top"><em>nrows</em> </td><td>Number of rows </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00135">samp_addListParam()</a>, <a class="el" href="sampList_8c_source.html#l00063">samp_freeList()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampList_8c_source.html#l00047">samp_newList()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>, and <a class="el" href="sampList_8c_source.html#l00152">samp_setIntInList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d9184eb45a5bc93b5205fd5b1c6ef688"></a><!-- doxytag: member="sampDecl.h::samp_tbHighlightHandler" ref="d9184eb45a5bc93b5205fd5b1c6ef688" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbHighlightHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a table.highlight.row message. +<p> +SAMP_TBHIGHLIGHTHANDLER -- Handle a table.highlight.row message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00288">samp_getIntFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="750c0fee0c7a99e135299c08751f288c"></a><!-- doxytag: member="sampDecl.h::samp_tbLoadFITSHandler" ref="750c0fee0c7a99e135299c08751f288c" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbLoadFITSHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a generic table.load.fits message. +<p> +SAMP_TBLOADFITSHANDLER -- Handle a generic table.load.fits message *<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="26f96dc6cbf72283e2ee9cb8b4619ed3"></a><!-- doxytag: member="sampDecl.h::samp_tbLoadHandler" ref="26f96dc6cbf72283e2ee9cb8b4619ed3" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a generic table.load.* message. +<p> +SAMP_TBLOADHANDLER -- Handle a generic table.load.* message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="144ec2329355d91022d5ea38736c0093"></a><!-- doxytag: member="sampDecl.h::samp_tbLoadVOTHandler" ref="144ec2329355d91022d5ea38736c0093" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbLoadVOTHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a generic table.load.votable message. +<p> +SAMP_TBLOADVOTHANDLER -- Handle a generic table.load.votable message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="98d68d7091c0b7790631bb53e0ace656"></a><!-- doxytag: member="sampDecl.h::samp_tbSelectHandler" ref="98d68d7091c0b7790631bb53e0ace656" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbSelectHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a table.select.rowList message. +<p> +SAMP_TBSELECTHANDLER -- Handle a table.select.rowList message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00268">samp_getListFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="106fc27544de7c25625ed60eb48e4edd"></a><!-- doxytag: member="sampDecl.h::samp_UnRegister" ref="106fc27544de7c25625ed60eb48e4edd" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_UnRegister </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Un-Register from the hub. +<p> +SAMP_UNREGISTER -- Un-Register from the hub.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, and <a class="el" href="sampHub_8c_source.html#l00395">samp_hubUnRegister()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b3fded97bbbf3751c4916543959f16a5"></a><!-- doxytag: member="sampDecl.h::samp_Unsubscribe" ref="b3fded97bbbf3751c4916543959f16a5" args="(handle_t handle, String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_Unsubscribe </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Unsubscribe to a given mtype. +<p> +SAMP_UNSUBSCRIBE -- Unsubscribe to a given mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, <a class="el" href="sampCommands_8c_source.html#l00227">samp_DeclareSubscriptions()</a>, <a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">Subs::sampFunc</a>, and <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs::userFunc</a>.</p> + +</div> +</div><p> +<a class="anchor" name="123413db26ad50a84bd41863af5deae5"></a><!-- doxytag: member="sampDecl.h::sampClose" ref="123413db26ad50a84bd41863af5deae5" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void sampClose </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Close the SAMP interface and free resources. +<p> +SAMP_CLOSE -- Close the SAMP interface.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00194">Samp::hubHandle</a>, <a class="el" href="sampUtil_8c_source.html#l00072">samp_freeHandle()</a>, <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, <a class="el" href="sampLog_8c_source.html#l00091">sampTrace()</a>, and <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +</div> +</div><p> +<a class="anchor" name="30f39c72c3783055faa82ad3860f3d1d"></a><!-- doxytag: member="sampDecl.h::sampInit" ref="30f39c72c3783055faa82ad3860f3d1d" args="(String appName, String description)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t sampInit </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>appName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>description</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Initialize the SAMP interface. +<p> +Prototype declarations.<p> +SAMP_INIT -- Initialize the SAMP interface.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>appName</em> </td><td>application name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>description</em> </td><td>description of application </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>samp handle </dd></dl> + +<p>References <a class="el" href="samp_8c_source.html#l00055">nullList</a>, <a class="el" href="samp_8c_source.html#l00053">nullMap</a>, <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>, <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, <a class="el" href="sampUtil_8c_source.html#l00049">samp_newHandle()</a>, <a class="el" href="sampList_8c_source.html#l00047">samp_newList()</a>, <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>, <a class="el" href="sampUtil_8c_source.html#l00194">samp_serverPort()</a>, <a class="el" href="sampMap_8c_source.html#l00153">samp_setMapInMap()</a>, <a class="el" href="sampMap_8c_source.html#l00135">samp_setStringInMap()</a>, <a class="el" href="samp_8c_source.html#l00051">sampH</a>, and <a class="el" href="sampLog_8c_source.html#l00091">sampTrace()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4919f892b6fccced4e6b9d777071b781"></a><!-- doxytag: member="sampDecl.h::sampLog" ref="4919f892b6fccced4e6b9d777071b781" args="(handle_t handle, char *format,...)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void sampLog </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>format</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"> <em>...</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP message logger. +<p> +SAMPLOG -- SAMP message logger.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>SAMP handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>message format string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, and <a class="el" href="samp_8h_source.html#l00202">Samp::logfd</a>.</p> + +</div> +</div><p> +<a class="anchor" name="65908d088c8b917d10db38c147590ad9"></a><!-- doxytag: member="sampDecl.h::sampShutdown" ref="65908d088c8b917d10db38c147590ad9" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int sampShutdown </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Shut down the active SAMP interface. +<p> +SAMP_SHUTDOWN -- Shut down the active SAMP interface.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00197">Samp::active</a>, <a class="el" href="samp_8h_source.html#l00194">Samp::hubHandle</a>, <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, <a class="el" href="samp_8h_source.html#l00179">Samp::svrThread</a>, and <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8e18ae12df031094ace47863f93b3634"></a><!-- doxytag: member="sampDecl.h::sampStartup" ref="8e18ae12df031094ace47863f93b3634" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int sampStartup </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Startup the SAMP interface to send/receive messages. +<p> +SAMP_STARTUP -- Startup the SAMP interface to send/receive messages.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00197">Samp::active</a>, <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00194">Samp::hubHandle</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00198">Samp::mapClients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>, and <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2b3dd1662e61c83e29109126689b08b9"></a><!-- doxytag: member="sampDecl.h::sampTrace" ref="2b3dd1662e61c83e29109126689b08b9" args="(handle_t handle, char *format,...)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void sampTrace </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>format</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"> <em>...</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP tracer. +<p> +SAMPTRACE -- SAMP tracer.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>SAMP handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>message format string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampDecl_8h_source.html b/vendor/voclient/libsamp/doc/html/sampDecl_8h_source.html new file mode 100644 index 00000000..0683eed8 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampDecl_8h_source.html @@ -0,0 +1,410 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampDecl.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +<h1>sampDecl.h</h1><a href="sampDecl_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 +<a name="l00013"></a>00013 <span class="keyword">typedef</span> XINT handle_t; +<a name="l00014"></a><a class="code" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">00014</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a>; +<a name="l00015"></a><a class="code" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">00015</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a>; +<a name="l00016"></a><a class="code" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">00016</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a>; +<a name="l00017"></a><a class="code" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">00017</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a>; +<a name="l00018"></a><a class="code" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">00018</a> <span class="keyword">typedef</span> <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a>; +<a name="l00020"></a><a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">00020</a> <span class="preprocessor">#define SZ_NAME 256 </span> +<a name="l00021"></a>00021 <span class="preprocessor">#define SZ_LINE 256 </span> +<a name="l00022"></a>00022 <span class="preprocessor">#define SZ_SECRET 64 </span> +<a name="l00023"></a>00023 <span class="preprocessor">#define SZ_DESC 8192 </span> +<a name="l00024"></a>00024 <span class="preprocessor">#define SZ_URL 1024 </span> +<a name="l00025"></a>00025 <span class="preprocessor">#define SZ_CMD 1024 </span> +<a name="l00027"></a>00027 <span class="preprocessor">#define MAX_SAMPS 16 </span> +<a name="l00028"></a>00028 <span class="preprocessor">#define MAX_HUBS 16 </span> +<a name="l00029"></a>00029 <span class="preprocessor">#define MAX_MDATTRS 32 </span> +<a name="l00030"></a>00030 <span class="preprocessor">#define MAX_SUBS 256 </span> +<a name="l00031"></a>00031 <span class="preprocessor">#define MAX_CLIENTS 32 </span> +<a name="l00032"></a>00032 <span class="preprocessor">#define MAX_ROWS 256 </span> +<a name="l00038"></a>00038 <span class="preprocessor">typedef struct {</span> +<a name="l00039"></a>00039 <span class="preprocessor"></span> <span class="keywordtype">char</span> name[SZ_LINE]; +<a name="l00040"></a>00040 <span class="keywordtype">char</span> desc[SZ_DESC]; +<a name="l00041"></a>00041 <span class="keywordtype">char</span> iconURL[SZ_URL]; +<a name="l00042"></a>00042 <span class="keywordtype">char</span> docURL[SZ_URL]; +<a name="l00044"></a>00044 <span class="keywordtype">char</span> *descHTML; +<a name="l00046"></a>00046 <span class="keywordtype">int</span> nkeys; +<a name="l00047"></a>00047 <span class="keywordtype">char</span> *aKey[MAX_MDATTRS]; +<a name="l00048"></a>00048 <span class="keywordtype">char</span> *aVal[MAX_MDATTRS]; +<a name="l00049"></a>00049 } <a class="code" href="structappMD.html">appMD</a>, *<a class="code" href="structappMD.html">appMDP</a>; +<a name="l00050"></a>00050 +<a name="l00051"></a>00051 +<a name="l00055"></a>00055 <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00056"></a>00056 <span class="keywordtype">char</span> mtype[SZ_LINE]; +<a name="l00057"></a>00057 int (*userFunc)(<span class="keywordtype">void</span> *p); +<a name="l00059"></a>00059 int (*sampFunc)(<span class="keywordtype">char</span> *sid, <span class="keywordtype">char</span> *sender, <span class="keywordtype">char</span> *msgid, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00060"></a>00060 } <a class="code" href="structSubs.html">Subs</a>, *<a class="code" href="structSubs.html">SubsP</a>; +<a name="l00061"></a>00061 +<a name="l00062"></a>00062 +<a name="l00066"></a>00066 <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00067"></a>00067 <span class="keywordtype">char</span> pubId[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00068"></a>00068 <span class="keywordtype">char</span> name[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00069"></a>00069 } <a class="code" href="structClient.html">Client</a>, *<a class="code" href="structClient.html">ClientP</a>; +<a name="l00070"></a>00070 +<a name="l00071"></a>00071 +<a name="l00076"></a>00076 <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00077"></a>00077 <span class="keywordtype">char</span> appName[SZ_LINE]; +<a name="l00078"></a>00078 <span class="keywordtype">char</span> appVer[SZ_LINE]; +<a name="l00079"></a>00079 <span class="keywordtype">char</span> description[SZ_LINE]; +<a name="l00081"></a>00081 <a class="code" href="structappMD.html">appMD</a> meta; +<a name="l00083"></a>00083 <span class="keywordtype">char</span> secret[SZ_SECRET]; +<a name="l00084"></a>00084 <span class="keywordtype">char</span> url[SZ_URL]; +<a name="l00085"></a>00085 <span class="keywordtype">char</span> version[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00087"></a>00087 <span class="keywordtype">int</span> id; +<a name="l00089"></a>00089 <span class="keywordtype">char</span> appId[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00090"></a>00090 <span class="keywordtype">char</span> privateKey[SZ_LINE]; +<a name="l00091"></a>00091 <span class="keywordtype">char</span> hubId[SZ_LINE]; +<a name="l00092"></a>00092 <span class="keywordtype">char</span> selfId[SZ_LINE]; +<a name="l00093"></a>00093 <span class="keywordtype">char</span> timeout[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00095"></a>00095 <span class="keywordtype">void</span> *samp; +<a name="l00096"></a>00096 } <a class="code" href="structHub.html">Hub</a>, *<a class="code" href="structHub.html">HubP</a>; +<a name="l00097"></a>00097 +<a name="l00098"></a>00098 +<a name="l00104"></a>00104 <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00105"></a>00105 <span class="keywordtype">char</span> appName[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00106"></a>00106 <span class="keywordtype">char</span> appVer[SZ_LINE]; +<a name="l00107"></a>00107 <span class="keywordtype">char</span> description[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00109"></a>00109 <span class="keywordtype">char</span> errortxt[SZ_LINE]; +<a name="l00111"></a>00111 <a class="code" href="structappMD.html">appMD</a> meta; +<a name="l00113"></a>00113 pthread_t svrThread; +<a name="l00116"></a>00116 int (*defaultUserFunc)(<span class="keywordtype">char</span> *sender, <span class="keywordtype">char</span> *msgid, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00117"></a>00117 +<a name="l00118"></a>00118 <a class="code" href="structSubs.html">Subs</a> subs[MAX_SUBS]; +<a name="l00119"></a>00119 <span class="keywordtype">int</span> nsubs; +<a name="l00121"></a>00121 <a class="code" href="structClient.html">Client</a> clients[MAX_CLIENTS]; +<a name="l00122"></a>00122 <span class="keywordtype">int</span> nclients; +<a name="l00124"></a>00124 <span class="keywordtype">int</span> serverTid; +<a name="l00125"></a>00125 <span class="keywordtype">int</span> serverPort; +<a name="l00127"></a>00127 <a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>; +<a name="l00128"></a>00128 handle_t hubHandle; +<a name="l00129"></a>00129 <span class="keywordtype">int</span> hubThreadID; +<a name="l00131"></a>00131 <span class="keywordtype">int</span> active; +<a name="l00132"></a>00132 <span class="keywordtype">int</span> msgMode; +<a name="l00133"></a>00133 <span class="keywordtype">int</span> handlerMode; +<a name="l00135"></a>00135 FILE *logfd; +<a name="l00136"></a>00136 <span class="keywordtype">int</span> debug; +<a name="l00137"></a>00137 <span class="keywordtype">int</span> trace; +<a name="l00138"></a>00138 } <a class="code" href="structSamp.html">Samp</a>, *<a class="code" href="structSamp.html">SampP</a>; +<a name="l00139"></a>00139 +<a name="l00140"></a>00140 +<a name="l00141"></a>00141 <span class="preprocessor">#define MSG_SYNC 0</span> +<a name="l00142"></a>00142 <span class="preprocessor"></span><span class="preprocessor">#define MSG_ASYNC 1</span> +<a name="l00143"></a>00143 <span class="preprocessor"></span><span class="preprocessor">#define MSG_NOTIFY 2</span> +<a name="l00144"></a>00144 <span class="preprocessor"></span><span class="preprocessor">#define DEF_CALLMODE MSG_ASYNC</span> +<a name="l00145"></a>00145 <span class="preprocessor"></span> +<a name="l00146"></a>00146 +<a name="l00147"></a>00147 +<a name="l00152"></a>00152 <span class="comment">/******************************************************************************</span> +<a name="l00153"></a>00153 <span class="comment"> ** Public Interface Methods</span> +<a name="l00154"></a>00154 <span class="comment"> *****************************************************************************/</span> +<a name="l00155"></a>00155 +<a name="l00156"></a>00156 <span class="comment">/* samp.c -- Methods called by user apps to initialize the interface.</span> +<a name="l00157"></a>00157 <span class="comment"> */</span> +<a name="l00158"></a>00158 handle_t <a class="code" href="samp_8c.html#db03c60f2933ed9785bfb4457c359af2" title="Initialize the SAMP interface.">sampInit</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> description); +<a name="l00159"></a>00159 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#1428f653b9502c6e6d540f873de2b24f" title="Set a metadata field value for the application.">samp_Metadata</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> field, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value); +<a name="l00160"></a>00160 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#ed050606c5076a4a34eb8f0f982a25d4" title="Subscribe to a given mtype.">samp_Subscribe</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <span class="keywordtype">void</span> *func); +<a name="l00161"></a>00161 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#dc0e418fbaee507e661260c4480ecfcd" title="Unsubscribe to a given mtype.">samp_Unsubscribe</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00162"></a>00162 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#1f6d544576fec785be1acfeaf3f2cf63" title="Startup the SAMP interface to send/receive messages.">sampStartup</a> (handle_t handle); +<a name="l00163"></a>00163 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#d634392fbb12cf4e1b2eb05da34759c5" title="Shut down the active SAMP interface.">sampShutdown</a> (handle_t handle); +<a name="l00164"></a>00164 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#f861f637942c5f971bab824708581f82" title="Close the SAMP interface and free resources.">sampClose</a> (handle_t handle); +<a name="l00165"></a>00165 +<a name="l00166"></a>00166 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#d636ae12dd05df43a077f91882a197ec" title="Set the calling mode to use synchronous messaging.">samp_setSyncMode</a> (handle_t handle); +<a name="l00167"></a>00167 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#9b2292b819e590b1f7c63bbdfaa09e31" title="Set the calling mode to use asynchronous messaging.">samp_setASyncMode</a> (handle_t handle); +<a name="l00168"></a>00168 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#7bfbc2e767fe234f83c13b8316a09ecd" title="Set the calling mode to use notification messaging.">samp_setNotifyMode</a> (handle_t handle); +<a name="l00169"></a>00169 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#b6b49029386c3efd0520daa93a4ab3eb" title="Have interface call user handlers by reference.">samp_setCallByRef</a> (handle_t handle); +<a name="l00170"></a>00170 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#3e01437224c73b91e49c6428cb69735d" title="Set the default calling mode (synch or asynch).">samp_setCallMode</a> (handle_t handle, <span class="keywordtype">int</span> mode); +<a name="l00171"></a>00171 +<a name="l00172"></a>00172 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#a3c0bdb4c512357dbc53b0ad7a7d5b01" title="Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func).">samp_setReplyCallback</a> (handle_t handle, <span class="keywordtype">int</span> *func); +<a name="l00173"></a>00173 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#3db66f28546459327665f8491ea97f4d" title="Set the Response callback. samp_setResponseCallback (handle_t handle, int *func)...">samp_setResponseCallback</a> (handle_t handle, <span class="keywordtype">int</span> *func); +<a name="l00174"></a>00174 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#c057d32437a96a527c63f938757099af" title="Set the message timeout value (in seconds).">samp_setTimeout</a> (handle_t handle, <span class="keywordtype">int</span> timeout); +<a name="l00175"></a>00175 <span class="keywordtype">void</span> samp_setAppName (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00176"></a>00176 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#0f50f8dbae701aa6b19912fc99f6475a" title="Set the application name string.">samp_setAppVersion</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> version); +<a name="l00177"></a>00177 +<a name="l00178"></a>00178 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#114bf9fb0d3e6eabd8bb93f3c87f5233" title="The interface&#39;s default Reply handler.">samp_defaultReplyHandler</a> (handle_t handle); +<a name="l00179"></a>00179 <span class="keywordtype">void</span> samp_deaultfResponseHandler (handle_t handle); +<a name="l00180"></a>00180 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#985afa0baeb135c9ee72d09394314ff1" title="Reply with the status of the last message sent.">samp_replyStatus</a> (handle_t handle); +<a name="l00181"></a>00181 +<a name="l00182"></a>00182 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#ff4d125fc9594be25984989fad2fd3c8">samp_mapClients</a> (handle_t handle); +<a name="l00183"></a>00183 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#1e494e73abe2ddfd946fb39e84da42a9">samp_listClients</a> (handle_t handle); +<a name="l00184"></a>00184 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#8a2111bbe4c88cef635e3bf67e899563">samp_addClient</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <span class="keywordtype">id</span>); +<a name="l00185"></a>00185 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#e30e492f306a40f853a454faf60ab479">samp_removeClient</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <span class="keywordtype">id</span>); +<a name="l00186"></a>00186 +<a name="l00187"></a>00187 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8c.html#f299ea13607279f60f16b8639a00658f">samp_getOKMap</a> (<span class="keywordtype">void</span>); +<a name="l00188"></a>00188 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8c.html#6bb8b1f5c6268ad8c7f165733d4af86d">samp_getNullMap</a> (<span class="keywordtype">void</span>); +<a name="l00189"></a>00189 +<a name="l00190"></a>00190 +<a name="l00191"></a>00191 <span class="comment">/* sampCommands.c -- Methods called to send messages to the Hub.</span> +<a name="l00192"></a>00192 <span class="comment"> */</span> +<a name="l00193"></a>00193 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#aef9c2f86c7e4f49fe3df343ef06f3ba" title="Register with the Hub using the currently stored metadata.">samp_Register</a> (handle_t handle); +<a name="l00194"></a>00194 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#5e3a44429f332694cc2cedc2e38856ce" title="Un-Register from the hub.">samp_UnRegister</a> (handle_t handle); +<a name="l00195"></a>00195 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#94cdccbcfa524fa515de77544b6c6eaa" title="(Re)Declare all of our metadata.">samp_DeclareMetadata</a> (handle_t handle); +<a name="l00196"></a>00196 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#7688cbf8ef852483c077be96151763a6" title="Ping the hub/app to see if it is alive (returns &gt;0).">samp_Ping</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName); +<a name="l00197"></a>00197 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8h.html#636e11796b78ae9881e7c61df8516d2a" title="Get the metadata for a specified app.">samp_GetMetadata</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId); +<a name="l00198"></a>00198 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#ef695801c121c6191d3af4574569ab8c" title="Declare the messages we&#39;re interested in.">samp_DeclareSubscriptions</a> (handle_t handle); +<a name="l00199"></a>00199 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_GetSubscriptions (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId); +<a name="l00200"></a>00200 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#2c532e076dd6446f079691ed02197a57" title="Get public-ids of the registered clients.">samp_GetRegisteredClients</a> (handle_t handle); +<a name="l00201"></a>00201 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#d28a9085ab8cacbe978e300ac99f6ae5" title="Get clients matching the mtype subscription.">samp_GetSubscribedClients</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00202"></a>00202 +<a name="l00203"></a>00203 +<a name="l00204"></a>00204 <span class="comment">/* sampMType.c -- Methods called to send messages to other apps.</span> +<a name="l00205"></a>00205 <span class="comment"> */</span> +<a name="l00206"></a>00206 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#45c2023312cd2adfa40feb2eb8a3e143" title="Tell an app to load a VOTable.">samp_tableLoadVOTable</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, +<a name="l00207"></a>00207 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00208"></a>00208 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#6b950e53c7fdf481a13c8a2ec353dca1" title="Tell an app to load a FITS table.">samp_tableLoadFITS</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, +<a name="l00209"></a>00209 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00210"></a>00210 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#2ec386ef5bd7dee20ffa1fead0b0210a" title="Tell an app to load a FITS image.">samp_imageLoadFITS</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, +<a name="l00211"></a>00211 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> imageId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00212"></a>00212 +<a name="l00213"></a>00213 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#0503d3ee247a6a962a2a8da672261ab7" title="Tell an app to highlight a table row.">samp_tableHighlightRow</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, +<a name="l00214"></a>00214 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <span class="keywordtype">int</span> row); +<a name="l00215"></a>00215 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#a410ef908863f7c5b2c99844ebb73d35" title="Tell an app to select a list of table rows.">samp_tableSelectRowList</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, +<a name="l00216"></a>00216 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <span class="keywordtype">int</span> rows[], <span class="keywordtype">int</span> nrows); +<a name="l00217"></a>00217 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#0651eec8ddc8707bb8fbc4dfdcfff5e2" title="Tell an app to point at an RA/Dec coordinate.">samp_coordPointAtSky</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, +<a name="l00218"></a>00218 <span class="keywordtype">float</span> ra, <span class="keywordtype">float</span> dec); +<a name="l00219"></a>00219 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#4869a1bb04a96514f153dc5bfbed8e6e" title="Load a generic spectrum from an SSA service.">samp_specLoadSSAGeneric</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, +<a name="l00220"></a>00220 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> meta, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> spectrumId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00221"></a>00221 +<a name="l00222"></a>00222 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#be012673358bfd254e2c6ad9f6e92240" title="Execute a command in a remote application.">samp_cmdExec</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> cmd); +<a name="l00223"></a>00223 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#ba313c7608a7658c673065c83113ec5b" title="Get an environment variable in a remote application.">samp_envGet</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00224"></a>00224 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#e842347910a3cfd746def74b0fd564aa" title="Set an environment variable in a remote application.">samp_envSet</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value); +<a name="l00225"></a>00225 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#4c75de6ddcffde6e3dde7beea68de81c" title="Get a parameter variable in a remote application.">samp_paramGet</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00226"></a>00226 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#7a5c9f092b57dfb3206c8decc8558fd3" title="Set an parameter variable in a remote application.">samp_paramSet</a>(handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value); +<a name="l00227"></a>00227 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#abeaa1ac9d09a666a9fa34a7d274483d" title="Exchange a bibcode.">samp_bibLoad</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> bibcode); +<a name="l00228"></a>00228 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#a0bb33d232fcb52aaa470d1f1b1a89d7" title="Exchange a resource list.">samp_resourceLoad</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> type, +<a name="l00229"></a>00229 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resMap); +<a name="l00230"></a>00230 +<a name="l00231"></a>00231 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#5837826e5b4e86b2dda0892c48b96faf" title="Send a geenric message.">samp_sendGeneric</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, +<a name="l00232"></a>00232 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> args[]); +<a name="l00233"></a>00233 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#4607721d55904450d4066c360d3dcddd" title="Send the specified message.">samp_sendMsg</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00234"></a>00234 +<a name="l00235"></a>00235 +<a name="l00236"></a>00236 +<a name="l00237"></a>00237 <span class="comment">/* sampClient.c -- Low-level methods to send messages.</span> +<a name="l00238"></a>00238 <span class="comment"> */</span> +<a name="l00239"></a>00239 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#c73788ae17493c4042948f6b861ddd74" title="Make a notify() call to the Hub.">samp_notify</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00240"></a>00240 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#a046d61f43fce831a71621f98b6d9741" title="Make a notifyAll() call to the Hub.">samp_notifyAll</a> (handle_t handle, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00241"></a>00241 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <a class="code" href="samp_8h.html#919cca4cfc557e0c05914b805401fbd3" title="Make a call() call to the Hub.">samp_call</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tag, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00242"></a>00242 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#2cbf26c662884a4ae9587f7b9f4113a6" title="Make a callAll() call to the Hub.">samp_callAll</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00243"></a>00243 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#c69c39e8ee091c006289b486dee10711" title="Make a callAndWait() call to the Hub.">samp_callAndWait</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, +<a name="l00244"></a>00244 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00245"></a>00245 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#89fc488147fe2e08b4f3c044c7079962" title="Reply to a message.">samp_Reply</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp); +<a name="l00246"></a>00246 +<a name="l00247"></a>00247 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <a class="code" href="samp_8h.html#0a61726448d9b1a026b20ff6beead44e" title="Get the Client name from a pubic-id.">samp_clientName</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId); +<a name="l00248"></a>00248 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#3c026895e4d28567eb63c3b9cc16cd40" title="Set the error response string.">samp_setErr</a> (handle_t handle, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp); +<a name="l00249"></a>00249 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <a class="code" href="samp_8h.html#fd8a4da020cd2fedaf70ae8af0b6a1c8" title="Get the error response string.">samp_getErr</a> (handle_t handle); +<a name="l00250"></a>00250 +<a name="l00251"></a>00251 +<a name="l00252"></a>00252 <span class="comment">/* sampMethods.c -- SAMP methods implemented by a callable client.</span> +<a name="l00253"></a>00253 <span class="comment"> */</span> +<a name="l00254"></a>00254 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#59f85e0fce4c9ae7121c98e137d3f743" title="test.echo method">samp_receiveCall</a> (<span class="keywordtype">void</span> *data); +<a name="l00255"></a>00255 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#03be7cc9e154a6ccdd499286df640936" title="receiveNotification () client method.">samp_receiveNotification</a> (<span class="keywordtype">void</span> *data); +<a name="l00256"></a>00256 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#754b50ad59145c7fd1e4c8f4277f11e4" title="receiveResponse () client method.">samp_receiveResponse</a> (<span class="keywordtype">void</span> *data); +<a name="l00257"></a>00257 +<a name="l00258"></a>00258 +<a name="l00259"></a>00259 <span class="comment">/* sampHandlers.c -- Handlers to responses from the message.</span> +<a name="l00260"></a>00260 <span class="comment"> */</span> +<a name="l00261"></a>00261 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#b969017f97d850b092bde60a2d445a2b" title="Set the user-interface handler for the mtype.">samp_setUserHandler</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <span class="keywordtype">void</span> *func); +<a name="l00262"></a>00262 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#8b83cf8a75c16c45c547be68f0bf9f64" title="Set the SAMP interface handler for the mtype.">samp_setSampHandler</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <span class="keywordtype">void</span> *func); +<a name="l00263"></a>00263 <span class="keywordtype">void</span> *<a class="code" href="samp_8h.html#ce2ea31b9bd82db4c5040ffd0511bd8b" title="Get the User handler for the named mtype.">samp_getUserHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00264"></a>00264 <span class="keywordtype">void</span> *<a class="code" href="samp_8h.html#f295f9e7746644f834ac54b1deb95b4c" title="Get the Samphandler for the named mtype.">samp_getSampHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00265"></a>00265 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#e09217f0e615e01dfcffbdebda2516e8" title="Execute the user-defined handler for the mtype.">samp_execUserHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, +<a name="l00266"></a>00266 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params); +<a name="l00267"></a>00267 +<a name="l00268"></a>00268 <span class="keywordtype">int</span> samp_genericMsgHandler (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00269"></a>00269 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00270"></a>00270 +<a name="l00271"></a>00271 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#16d8b8822d169107b8702ae753797923" title="Is app alive and responding to messages?">samp_PingHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00272"></a>00272 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00273"></a>00273 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#2e342b672e77e012cc98a6f5506a44be" title="Return status of the task.">samp_StatusHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00274"></a>00274 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00275"></a>00275 +<a name="l00276"></a>00276 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#9bd8036dd65dc4f874f39568b691a123" title="Handle an image.load.fits message.">samp_imLoadHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00277"></a>00277 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00278"></a>00278 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#26f96dc6cbf72283e2ee9cb8b4619ed3" title="Handle a generic table.load.* message.">samp_tbLoadHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00279"></a>00279 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00280"></a>00280 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#750c0fee0c7a99e135299c08751f288c" title="Handle a generic table.load.fits message.">samp_tbLoadFITSHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00281"></a>00281 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00282"></a>00282 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#144ec2329355d91022d5ea38736c0093" title="Handle a generic table.load.votable message.">samp_tbLoadVOTHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00283"></a>00283 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00284"></a>00284 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#bc319b97b3dbea29bd79c4f723db5438" title="Handle a spectrum.load.* message.">samp_specLoadHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00285"></a>00285 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00286"></a>00286 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#dd2bca8fa3bf3b4ebbf449edc6b65d85" title="Handle a spectrum.load.ssa-generic message.">samp_specSSAHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00287"></a>00287 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00288"></a>00288 +<a name="l00289"></a>00289 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#d9184eb45a5bc93b5205fd5b1c6ef688" title="Handle a table.highlight.row message.">samp_tbHighlightHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00290"></a>00290 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00291"></a>00291 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#98d68d7091c0b7790631bb53e0ace656" title="Handle a table.select.rowList message.">samp_tbSelectHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00292"></a>00292 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00293"></a>00293 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#3f5632858a2b09759ffe98cd2e183cfb" title="Handle a coord.pointAt.sky message.">samp_pointAtHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00294"></a>00294 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00295"></a>00295 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#262bf09278c61b60b5189fef7f26d26b" title="Handle a bibcode.load message.">samp_bibcodeHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00296"></a>00296 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00297"></a>00297 +<a name="l00298"></a>00298 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b" title="Handle a client.cmd.exec message.">samp_cmdExecHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00299"></a>00299 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00300"></a>00300 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#e25a92f57babd71d43653d7fcb81025c" title="Handle a client.env.set message.">samp_envGetHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00301"></a>00301 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00302"></a>00302 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#0910e6b9d11cdd3111c1f18450de394a" title="Handle a client.env.set message.">samp_envSetHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00303"></a>00303 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00304"></a>00304 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#659c272ce881662c1826a04728dc06f6" title="Handle a client.param.set message.">samp_paramGetHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00305"></a>00305 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00306"></a>00306 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#071aa9e32f2e94d5b667e87cf65d2bdf" title="Handle a client.param.set message.">samp_paramSetHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00307"></a>00307 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00308"></a>00308 +<a name="l00309"></a>00309 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#c0bf7cf7fea362c0c82ad7bc3f267c48" title="handle a voresource.loadlist message">samp_resLoadHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00310"></a>00310 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00311"></a>00311 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#287569451dc1bf59d1f9f6d13b56716d" title="handle a voresource.loadlist message">samp_resConeHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00312"></a>00312 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00313"></a>00313 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#8b2300222d7b11f144eb4385412e69a5" title="handle a voresource.loadlist message">samp_resSiapHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00314"></a>00314 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00315"></a>00315 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#866578a01c3b762435823b1b11869c42" title="handle a voresource.loadlist message">samp_resSsapHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00316"></a>00316 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00317"></a>00317 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#ad42ca17cbaf23012ad497559ea45e4c" title="handle a voresource.loadlist message">samp_resTapHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00318"></a>00318 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00319"></a>00319 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#fa207ebdc587ba5eeab60fbf79b635d4" title="handle a voresource.loadlist message">samp_resVOSpaceHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00320"></a>00320 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00321"></a>00321 +<a name="l00322"></a>00322 <span class="keywordtype">void</span> samp_printMessage (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00323"></a>00323 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params); +<a name="l00324"></a>00324 +<a name="l00325"></a>00325 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#a8a947c24f2c9333adf4e5d7fa11d134">samp_printMap</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00326"></a>00326 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#5361571754505eaefdf5739cd3e9519e">samp_nullResponse</a> (<span class="keywordtype">void</span> *data); +<a name="l00327"></a>00327 <span class="keywordtype">int</span> samp_testEcho (<span class="keywordtype">void</span> *data); +<a name="l00328"></a>00328 +<a name="l00329"></a>00329 +<a name="l00330"></a>00330 +<a name="l00331"></a>00331 <span class="comment">/******************************************************************************</span> +<a name="l00332"></a>00332 <span class="comment"> ** Internal Interface Methods</span> +<a name="l00333"></a>00333 <span class="comment"> *****************************************************************************/</span> +<a name="l00334"></a>00334 +<a name="l00335"></a>00335 <span class="comment">/* sampHub.c</span> +<a name="l00336"></a>00336 <span class="comment"> */</span> +<a name="l00337"></a>00337 handle_t <a class="code" href="samp_8h.html#ef92557afa5ed6731ac0a0a1ba6dfd7c" title="Discover and open a connection to the SAMP Hub.">samp_hubOpen</a> (<a class="code" href="structSamp.html">Samp</a> *samp); +<a name="l00338"></a>00338 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#39a580ced499e50d39d327f7709834e7" title="Close a connection to the Hub.">samp_hubClose</a> (handle_t handle); +<a name="l00339"></a>00339 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#d0343ad884d5a958d7d91928ad06a369" title="Get a list of available Hubs.">samp_getAvailableHubs</a> (handle_t handle); +<a name="l00340"></a>00340 <span class="keywordtype">char</span> *samp_getActiveHubName (handle_t handle); +<a name="l00341"></a>00341 <span class="keywordtype">int</span> samp_getActiveHub (handle_t handle); +<a name="l00342"></a>00342 <span class="keywordtype">int</span> samp_hubInit (handle_t samp, <span class="keywordtype">char</span> *appName, <span class="keywordtype">char</span> *descr); +<a name="l00343"></a>00343 +<a name="l00344"></a>00344 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#265b5d07cce485a6979fe5f4a2217624" title="Determine the type of Hub event mtype.">samp_processHubEvent</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params); +<a name="l00345"></a>00345 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#a48b9a99f22537127df46a94dfa9ae4a" title="Determine the type of Hub event mtype.">samp_hubEvent</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00346"></a>00346 +<a name="l00347"></a>00347 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#77a14721e2373c805b58f69a018ea69c" title="Send a Register message to the Hub.">samp_hubRegister</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00348"></a>00348 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#b0c37311ca30e1fdadfdd1fd16ff3ab4" title="Send a UnRegister message to the Hub.">samp_hubUnRegister</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00349"></a>00349 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#6c7b8a8ff1f3c2435d153bc08da87dce" title="Send a samp.app.event.shutdown message to the Hub.">samp_hubSendShutdown</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00350"></a>00350 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#fc0bfbd699ab2cbce2f755a0506ca6dc" title="Set the client callback and send to Hub.">samp_hubSetXmlrpcCallback</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00351"></a>00351 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#155739318fa72883a3e32fccf8a6d5c9" title="Ping the Hub to see if it is alive.">samp_hubPing</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00352"></a>00352 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#bf1ae8a1c9c8cf520a22e6ea4d815712" title="Declare &quot;standard&quot; metadata to the Hub.">samp_hubDeclareMetadata</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00353"></a>00353 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#a6c0f67a76bd1f27898a66fe26b53fdd" title="Declare mtype subscriptions to the Hub.">samp_hubDeclareSubscriptions</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00354"></a>00354 +<a name="l00355"></a>00355 +<a name="l00356"></a>00356 <span class="comment">/* sampList.c</span> +<a name="l00357"></a>00357 <span class="comment">*/</span> +<a name="l00358"></a>00358 handle_t <a class="code" href="samp_8h.html#cdc925da798ee7a1ce30427d47812bd2" title="Create a new List object.">samp_newList</a> (); +<a name="l00359"></a>00359 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#b162ae9b9f98da80f6bb5c34b5cbcbf6" title="Free the given List object.">samp_freeList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list); +<a name="l00360"></a>00360 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#c260afb0cbf19b427e3eba96a2341e52" title="Get number of elements in a List.">samp_listLen</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list); +<a name="l00361"></a>00361 +<a name="l00362"></a>00362 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#5b69180b036e58528c98b1cf5a42825a" title="Set a string in a List (append).">samp_setStringInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">char</span> *value); +<a name="l00363"></a>00363 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#ea188bb711f3b5549d11204b0ff2da08" title="Set a Map in a List (append).">samp_setMapInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00364"></a>00364 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#0ff97d44e62b7c88a046a29324552400" title="Set a List in another List (append).">samp_setListInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list1, <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list2); +<a name="l00365"></a>00365 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#2d8a8a26d7284bb211a933895cddd29c" title="Set an Int in a List (append).">samp_setIntInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> value); +<a name="l00366"></a>00366 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#041a551aff57ca03f3ff72a9803e2b58" title="Set a Float in a List (append).">samp_setFloatInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">float</span> value); +<a name="l00367"></a>00367 +<a name="l00368"></a>00368 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#b101c5b1175490474e41ac9060bdaabf" title="Get a string from the List.">samp_getStringFromList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00369"></a>00369 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8h.html#33ca96ee3a8e7d26356c7b66f469da74" title="Get a Map from the List.">samp_getMapFromList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00370"></a>00370 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#b74e90fdfe79b1c4f7668fdb28d041a1" title="Get a List from the List.">samp_getListFromList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00371"></a>00371 <span class="keywordtype">int</span> samp_getIntFromList (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00372"></a>00372 <span class="keywordtype">float</span> <a class="code" href="samp_8h.html#cf9b570dd76203d2299ed7bdba048bb9" title="Get a Float from the List.">samp_getFloatFromList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00373"></a>00373 +<a name="l00374"></a>00374 +<a name="l00375"></a>00375 <span class="comment">/* sampMap.c</span> +<a name="l00376"></a>00376 <span class="comment">*/</span> +<a name="l00377"></a>00377 handle_t <a class="code" href="samp_8h.html#d88b5d5e9014deba8071f7defd220dbb" title="Create a new Map object.">samp_newMap</a> (<span class="keywordtype">void</span>); +<a name="l00378"></a>00378 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#fe80438de542c6657d623993360b37d1" title="Free the given Map object.">samp_freeMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00379"></a>00379 +<a name="l00380"></a>00380 <span class="keywordtype">int</span> samp_getMapSize (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00381"></a>00381 <span class="keywordtype">char</span> *samp_getMapKey (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">int</span> index); +<a name="l00382"></a>00382 <span class="keywordtype">char</span> *samp_getMapVal (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">int</span> index); +<a name="l00383"></a>00383 +<a name="l00384"></a>00384 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#b9b2157de89369eb5cd95bfe804eb89a" title="Set a string in a Map (append).">samp_setStringInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key, <span class="keywordtype">char</span> *value); +<a name="l00385"></a>00385 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#f102490efe1b92d99b67f244dc498c7b" title="Set a Map in a Map (append).">samp_setMapInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map1, <span class="keywordtype">char</span> *key, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map2); +<a name="l00386"></a>00386 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#362c2f670c98dd6a3ef69debd1871604" title="Set a List in a Map (append).">samp_setListInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key, <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list); +<a name="l00387"></a>00387 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#c22ec42dbf9a01c9b4e00cf011e7eb9d" title="Set a Int in a Map (append).">samp_setIntInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key, <span class="keywordtype">int</span> value); +<a name="l00388"></a>00388 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#0f07ae542f5b317311b3799bd96a88fd" title="Set a string in a Map (append).">samp_setFloatInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key, <span class="keywordtype">float</span> value); +<a name="l00389"></a>00389 +<a name="l00390"></a>00390 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#e615ad9482fa88705b2488a37c987c2a" title="Get a string from the Map.">samp_getStringFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00391"></a>00391 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8h.html#525e8ffdfa32867f392f2c1340215453" title="Get a Map from the Map.">samp_getMapFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00392"></a>00392 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#31ddb90cf2184ae0151b9e7ec8c1a51f" title="Get a LIST from the Map.">samp_getListFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00393"></a>00393 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#594a51772e9b0693a3c77006eb88c96a" title="Get a integer from the Map.">samp_getIntFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00394"></a>00394 <span class="keywordtype">float</span> <a class="code" href="samp_8h.html#89c38f762afd50c85f6ff659bdf0a923" title="Get a float from the Map.">samp_getFloatFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00395"></a>00395 +<a name="l00396"></a>00396 +<a name="l00397"></a>00397 <span class="comment">/* sampMsg.c</span> +<a name="l00398"></a>00398 <span class="comment"> */</span> +<a name="l00399"></a>00399 <a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> <a class="code" href="samp_8h.html#d343c08e241ff4e17a0eb8fa3d9f4781" title="Create a new Msg object.">samp_newMsg</a> (<span class="keywordtype">void</span>); +<a name="l00400"></a>00400 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#adf2979a5fad0c9a855740330b7fd9ce" title="Free the given Msg object.">samp_freeMsg</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg); +<a name="l00401"></a>00401 <span class="keywordtype">void</span> samp_msgMType (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00402"></a>00402 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#281c8f7f8b21a74704dd200d5aaed481" title="Add a parameter to the Msg.">samp_msgParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param); +<a name="l00403"></a>00403 <span class="keywordtype">char</span> *samp_msgTag (<span class="keywordtype">void</span>); +<a name="l00404"></a>00404 +<a name="l00405"></a>00405 +<a name="l00406"></a>00406 <span class="comment">/* sampParam.c</span> +<a name="l00407"></a>00407 <span class="comment"> */</span> +<a name="l00408"></a>00408 <a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> <a class="code" href="samp_8h.html#3e2fe98bee9ac2b0c882de78e9b5085f" title="Create a new Param object.">samp_newParam</a> (<span class="keywordtype">void</span>); +<a name="l00409"></a>00409 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#5a6fbf3ac37164268afae80c35666c5e" title="Free the given Msg object.">samp_freeParam</a> (<a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param); +<a name="l00410"></a>00410 <a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> <a class="code" href="samp_8h.html#f2953eb691b695482ffbbea71948374f" title="Get number of Params.">samp_paramInit</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg); +<a name="l00411"></a>00411 <span class="keywordtype">void</span> samp_addStringParam (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> val); +<a name="l00412"></a>00412 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#e3e90c84dd6b1a08d8af18ca9e168b37" title="Add a parameter to the Param.">samp_addMapParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> val); +<a name="l00413"></a>00413 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#24f72c4ed033ed2f219b420e491b3c0f" title="Add a parameter to the Param.">samp_addListParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> val); +<a name="l00414"></a>00414 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#6897da75444209fc1819042bde906aa6" title="Add a &lt;SAMP int&gt;=&quot;&quot;&gt; parameter to the Param.">samp_addIntParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <span class="keywordtype">int</span> val); +<a name="l00415"></a>00415 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#d297770f4ab1338697d69b2705d6c1d9" title="Add a &lt;SAMP float&gt;=&quot;&quot;&gt; parameter to the Param.">samp_addFloatParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <span class="keywordtype">float</span> val); +<a name="l00416"></a>00416 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#5a44618b7681acff67b3883341494d2d" title="Get number of Params.">samp_paramLen</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg); +<a name="l00417"></a>00417 +<a name="l00418"></a>00418 +<a name="l00419"></a>00419 <span class="comment">/* sampLog.c</span> +<a name="l00420"></a>00420 <span class="comment">*/</span> +<a name="l00421"></a>00421 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#329a8a5f83162ed49baa28f008131d45" title="SAMP message logger.">sampLog</a> (handle_t handle, <span class="keywordtype">char</span> *format, ...); +<a name="l00422"></a>00422 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#65e3987c9b510018dcdd91203b437e40" title="SAMP tracer.">sampTrace</a> (handle_t handle, <span class="keywordtype">char</span> *format, ...); +<a name="l00423"></a>00423 +<a name="l00424"></a>00424 +<a name="l00425"></a>00425 <span class="comment">/* sampUtil.c</span> +<a name="l00426"></a>00426 <span class="comment"> */</span> +<a name="l00427"></a>00427 handle_t <a class="code" href="samp_8h.html#711aa545f55e9307f662062deefd5903" title="Get an unused object handle.">samp_newHandle</a> (<span class="keywordtype">void</span> *ptr); +<a name="l00428"></a>00428 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#f02a7c646a9ed56e545d8bf33434c207" title="Free the handle for later re-use.">samp_freeHandle</a> (handle_t handle); +<a name="l00429"></a>00429 +<a name="l00430"></a>00430 handle_t <a class="code" href="samp_8h.html#4d0aef2f09b9cce38d4ea8024831c6e5" title="Convert a pointer to a handle.">samp_P2H</a> (<span class="keywordtype">void</span> *ptr); +<a name="l00431"></a>00431 <span class="keywordtype">void</span> *samp_H2P (handle_t handle); +<a name="l00432"></a>00432 +<a name="l00433"></a>00433 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#5e555288172e59ccf28c901c6bc10793" title="Convert an application name to a public-ID.">samp_app2id</a> (handle_t handle, <span class="keywordtype">char</span> *appName); +<a name="l00434"></a>00434 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#343e25bf33431d973d9f81bc25eddcf7" title="Convert a public-ID to the application name.">samp_id2app</a> (handle_t handle, <span class="keywordtype">char</span> *pubId); +<a name="l00435"></a>00435 +<a name="l00436"></a>00436 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#6157dc4b47c65323a3015a434cd02e69" title="Return a unique port number for the server.">samp_serverPort</a> (<span class="keywordtype">void</span>); +<a name="l00437"></a>00437 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#5b2ef060b3adb18aea7a5a6099c4d0d0" title="Print the metadata for the application.">samp_printMetadata</a> (handle_t handle, <span class="keywordtype">char</span> *name); +<a name="l00438"></a>00438 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#def0598aa30c5c1a2276cdddf705de69" title="Get the metadata item for the application.">samp_getMetadata</a> (handle_t handle, <span class="keywordtype">char</span> *name); +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampHandlers_8c.html b/vendor/voclient/libsamp/doc/html/sampHandlers_8c.html new file mode 100644 index 00000000..eaf68895 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampHandlers_8c.html @@ -0,0 +1,1819 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampHandlers.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampHandlers.c File Reference</h1>Message handlers for the interface. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include <time.h></code><br> +<code>#include <ctype.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee07de873e18503ecd72f89d07e4c628"></a><!-- doxytag: member="sampHandlers.c::METH_DBG" ref="ee07de873e18503ecd72f89d07e4c628" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>METH_DBG</b> (getenv("METH_DBG")!=NULL||access("/tmp/METH_DBG",F_OK)==0)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae51f9fc173a9cba2485f91d93fe8428"></a><!-- doxytag: member="sampHandlers.c::OK_Map" ref="ae51f9fc173a9cba2485f91d93fe8428" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>OK_Map</b> samp_getOKMap()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a7803909f0c4188761ec0a533eab82e"></a><!-- doxytag: member="sampHandlers.c::MATCH" ref="0a7803909f0c4188761ec0a533eab82e" args="(s)" --> +#define </td><td class="memItemRight" valign="bottom"><b>MATCH</b>(s) (func&&strncasecmp(mtype,s,min(len,16))==0)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f6e89a3c178ea921d5340ce296c817cf"></a><!-- doxytag: member="sampHandlers.c::PMATCH" ref="f6e89a3c178ea921d5340ce296c817cf" args="(s)" --> +#define </td><td class="memItemRight" valign="bottom"><b>PMATCH</b>(s) (strcasecmp(mtype,s)==0)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d98187ef66ebe7e9334652739715250d"></a><!-- doxytag: member="sampHandlers.c::POPT" ref="d98187ef66ebe7e9334652739715250d" args="(s)" --> +#define </td><td class="memItemRight" valign="bottom"><b>POPT</b>(s) (s[0]?s:"INDEF")</td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#81222e1f3572585fa30f11a78aa08c3f">samp_setUserHandler</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, void *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the user-interface handler for the mtype. <a href="#81222e1f3572585fa30f11a78aa08c3f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#2e8ec01a0dd96314622ae313206583db">samp_setSampHandler</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, void *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the SAMP interface handler for the mtype. <a href="#2e8ec01a0dd96314622ae313206583db"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#6bb258d378627da1aa0254fccdb6bd2c">samp_getUserHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the User handler for the named mtype. <a href="#6bb258d378627da1aa0254fccdb6bd2c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#6ef18dbc5870f58d2161c9ba03a81d26">samp_getSampHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Samphandler for the named mtype. <a href="#6ef18dbc5870f58d2161c9ba03a81d26"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#23644999b70eebfe75f52c465d1ed97f">samp_execUserHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the user-defined handler for the mtype. <a href="#23644999b70eebfe75f52c465d1ed97f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#bea5fa0cd958545710afcf3c5da9dc15">samp_hubHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle <a class="el" href="structHub.html">Hub</a> event messages. <a href="#bea5fa0cd958545710afcf3c5da9dc15"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#16d8b8822d169107b8702ae753797923">samp_PingHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Is app alive and responding to messages? <a href="#16d8b8822d169107b8702ae753797923"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#2e342b672e77e012cc98a6f5506a44be">samp_StatusHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return status of the task. <a href="#2e342b672e77e012cc98a6f5506a44be"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b7812ba89eebe15ad24f36a3d439a0a"></a><!-- doxytag: member="sampHandlers.c::samp_genericMsgHandler" ref="1b7812ba89eebe15ad24f36a3d439a0a" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_genericMsgHandler</b> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#9bd8036dd65dc4f874f39568b691a123">samp_imLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle an image.load.fits message. <a href="#9bd8036dd65dc4f874f39568b691a123"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#26f96dc6cbf72283e2ee9cb8b4619ed3">samp_tbLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a generic table.load.* message. <a href="#26f96dc6cbf72283e2ee9cb8b4619ed3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#750c0fee0c7a99e135299c08751f288c">samp_tbLoadFITSHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a generic table.load.fits message. <a href="#750c0fee0c7a99e135299c08751f288c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#144ec2329355d91022d5ea38736c0093">samp_tbLoadVOTHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a generic table.load.votable message. <a href="#144ec2329355d91022d5ea38736c0093"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#d9184eb45a5bc93b5205fd5b1c6ef688">samp_tbHighlightHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a table.highlight.row message. <a href="#d9184eb45a5bc93b5205fd5b1c6ef688"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#98d68d7091c0b7790631bb53e0ace656">samp_tbSelectHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a table.select.rowList message. <a href="#98d68d7091c0b7790631bb53e0ace656"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#3f5632858a2b09759ffe98cd2e183cfb">samp_pointAtHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a coord.pointAt.sky message. <a href="#3f5632858a2b09759ffe98cd2e183cfb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#bc319b97b3dbea29bd79c4f723db5438">samp_specLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a spectrum.load.* message. <a href="#bc319b97b3dbea29bd79c4f723db5438"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#dd2bca8fa3bf3b4ebbf449edc6b65d85">samp_specSSAHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a spectrum.load.ssa-generic message. <a href="#dd2bca8fa3bf3b4ebbf449edc6b65d85"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b">samp_cmdExecHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.cmd.exec message. <a href="#c57d19afc6fa0b4bc9c7a0fd50d0f54b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#e25a92f57babd71d43653d7fcb81025c">samp_envGetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.env.set message. <a href="#e25a92f57babd71d43653d7fcb81025c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#0910e6b9d11cdd3111c1f18450de394a">samp_envSetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.env.set message. <a href="#0910e6b9d11cdd3111c1f18450de394a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#659c272ce881662c1826a04728dc06f6">samp_paramGetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.param.set message. <a href="#659c272ce881662c1826a04728dc06f6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#071aa9e32f2e94d5b667e87cf65d2bdf">samp_paramSetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.param.set message. <a href="#071aa9e32f2e94d5b667e87cf65d2bdf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#262bf09278c61b60b5189fef7f26d26b">samp_bibcodeHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a bibcode.load message. <a href="#262bf09278c61b60b5189fef7f26d26b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#c0bf7cf7fea362c0c82ad7bc3f267c48">samp_resLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#c0bf7cf7fea362c0c82ad7bc3f267c48"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#287569451dc1bf59d1f9f6d13b56716d">samp_resConeHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#287569451dc1bf59d1f9f6d13b56716d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#8b2300222d7b11f144eb4385412e69a5">samp_resSiapHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#8b2300222d7b11f144eb4385412e69a5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#866578a01c3b762435823b1b11869c42">samp_resSsapHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#866578a01c3b762435823b1b11869c42"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#ad42ca17cbaf23012ad497559ea45e4c">samp_resTapHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#ad42ca17cbaf23012ad497559ea45e4c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#fa207ebdc587ba5eeab60fbf79b635d4">samp_resVOSpaceHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#fa207ebdc587ba5eeab60fbf79b635d4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e743048f5b1f903496b2a8a2e9666367"></a><!-- doxytag: member="sampHandlers.c::samp_printMessage" ref="e743048f5b1f903496b2a8a2e9666367" args="(String mtype, String sender, String msg_id, Map params)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_printMessage</b> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#a8a947c24f2c9333adf4e5d7fa11d134">samp_printMap</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#5361571754505eaefdf5739cd3e9519e">samp_nullResponse</a> (void *data)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc687f745f400b41c9af4f6419bf9bf8"></a><!-- doxytag: member="sampHandlers.c::samp_testEcho" ref="cc687f745f400b41c9af4f6419bf9bf8" args="(void *data)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_testEcho</b> (void *data)</td></tr> + +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">nullMap</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#a2106c7fe3a5747178c046238fbd5d55">nullList</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12abcaf1a16a8a7c2ef6358cdbf4d705"></a><!-- doxytag: member="sampHandlers.c::sampP" ref="12abcaf1a16a8a7c2ef6358cdbf4d705" args="" --> +<a class="el" href="structSamp.html">Samp</a> * </td><td class="memItemRight" valign="bottom"><b>sampP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHandlers_8c.html#b04b61ee02d86e15b02b861699ae7424">sampH</a></td></tr> + +</table> +<hr><h2>Detailed Description</h2> +Message handlers for the interface. +<p> +SAMPHANDLERS.C -- Message handlers for the interface.<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/09 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="262bf09278c61b60b5189fef7f26d26b"></a><!-- doxytag: member="sampHandlers.c::samp_bibcodeHandler" ref="262bf09278c61b60b5189fef7f26d26b" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_bibcodeHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a bibcode.load message. +<p> +SAMP_BIBCODEHANDLER -- Handle a bibcode.load message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c57d19afc6fa0b4bc9c7a0fd50d0f54b"></a><!-- doxytag: member="sampHandlers.c::samp_cmdExecHandler" ref="c57d19afc6fa0b4bc9c7a0fd50d0f54b" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_cmdExecHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.cmd.exec message. +<p> +SAMP_CMDEXECHANDLER -- Handle a client.cmd.exec message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e25a92f57babd71d43653d7fcb81025c"></a><!-- doxytag: member="sampHandlers.c::samp_envGetHandler" ref="e25a92f57babd71d43653d7fcb81025c" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_envGetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.env.set message. +<p> +SAMP_ENVGETHANDLER -- Handle a client.env.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00067">samp_freeMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>, <a class="el" href="sampMethods_8c_source.html#l00237">samp_setHandlerReply()</a>, <a class="el" href="sampMap_8c_source.html#l00153">samp_setMapInMap()</a>, <a class="el" href="sampMap_8c_source.html#l00135">samp_setStringInMap()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0910e6b9d11cdd3111c1f18450de394a"></a><!-- doxytag: member="sampHandlers.c::samp_envSetHandler" ref="0910e6b9d11cdd3111c1f18450de394a" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_envSetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.env.set message. +<p> +SAMP_ENVSETHANDLER -- Handle a client.env.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="23644999b70eebfe75f52c465d1ed97f"></a><!-- doxytag: member="sampHandlers.c::samp_execUserHandler" ref="23644999b70eebfe75f52c465d1ed97f" args="(String sender, String mtype, String msg_id, Map params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_execUserHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>params</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Execute the user-defined handler for the mtype. +<p> +SAMP_EXECUSERHANDLER -- Execute the user-defined handler for the mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message-id string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>Mtype parameter Map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00308">samp_getFloatFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00288">samp_getIntFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00268">samp_getListFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>, and <a class="el" href="sampMethods_8c_source.html#l00189">samp_receiveResponse()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6ef18dbc5870f58d2161c9ba03a81d26"></a><!-- doxytag: member="sampHandlers.c::samp_getSampHandler" ref="6ef18dbc5870f58d2161c9ba03a81d26" args="(String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* samp_getSampHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the Samphandler for the named mtype. +<p> +SAMP_GETSAMPHANDLER -- Get the Samphandler for the named mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, and <a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">Subs::sampFunc</a>.</p> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>, and <a class="el" href="samp_8c_source.html#l00475">samp_Subscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6bb258d378627da1aa0254fccdb6bd2c"></a><!-- doxytag: member="sampHandlers.c::samp_getUserHandler" ref="6bb258d378627da1aa0254fccdb6bd2c" args="(String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* samp_getUserHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the User handler for the named mtype. +<p> +SAMP_GETUSERHANDLER -- Get the User handler for the named mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, and <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs::userFunc</a>.</p> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l01118">samp_bibcodeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00906">samp_cmdExecHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00994">samp_envSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00547">samp_imLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01082">samp_paramSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00451">samp_PingHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00786">samp_pointAtHandler()</a>, <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>, <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00482">samp_StatusHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00705">samp_tbHighlightHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00621">samp_tbLoadFITSHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00663">samp_tbLoadVOTHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="bea5fa0cd958545710afcf3c5da9dc15"></a><!-- doxytag: member="sampHandlers.c::samp_hubHandler" ref="bea5fa0cd958545710afcf3c5da9dc15" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle <a class="el" href="structHub.html">Hub</a> event messages. +<p> +SAMP_HUBHANDLER -- Handle <a class="el" href="structHub.html">Hub</a> event messages.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9bd8036dd65dc4f874f39568b691a123"></a><!-- doxytag: member="sampHandlers.c::samp_imLoadHandler" ref="9bd8036dd65dc4f874f39568b691a123" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_imLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle an image.load.fits message. +<p> +SAMP_IMLOADHANDLER -- Handle an image.load.fits message.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5361571754505eaefdf5739cd3e9519e"></a><!-- doxytag: member="sampHandlers.c::samp_nullResponse" ref="5361571754505eaefdf5739cd3e9519e" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_nullResponse </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_NULLRESPONSE -- Handler to ignore async replies. +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00422">samp_hubSendShutdown()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, and <a class="el" href="sampClient_8c_source.html#l00278">samp_Reply()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="659c272ce881662c1826a04728dc06f6"></a><!-- doxytag: member="sampHandlers.c::samp_paramGetHandler" ref="659c272ce881662c1826a04728dc06f6" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramGetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.param.set message. +<p> +SAMP_PARAMGETHANDLER -- Handle a client.param.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00067">samp_freeMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>, <a class="el" href="sampMethods_8c_source.html#l00237">samp_setHandlerReply()</a>, <a class="el" href="sampMap_8c_source.html#l00153">samp_setMapInMap()</a>, <a class="el" href="sampMap_8c_source.html#l00135">samp_setStringInMap()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="071aa9e32f2e94d5b667e87cf65d2bdf"></a><!-- doxytag: member="sampHandlers.c::samp_paramSetHandler" ref="071aa9e32f2e94d5b667e87cf65d2bdf" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramSetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.param.set message. +<p> +SAMP_PARAMSETHANDLER -- Handle a client.param.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="16d8b8822d169107b8702ae753797923"></a><!-- doxytag: member="sampHandlers.c::samp_PingHandler" ref="16d8b8822d169107b8702ae753797923" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_PingHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Is app alive and responding to messages? +<p> +SAMP_PINGHANDLER -- Simple aliveness test function.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, and <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3f5632858a2b09759ffe98cd2e183cfb"></a><!-- doxytag: member="sampHandlers.c::samp_pointAtHandler" ref="3f5632858a2b09759ffe98cd2e183cfb" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_pointAtHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a coord.pointAt.sky message. +<p> +SAMP_POINTATHANDLER -- Handle a coord.pointAt.sky message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00308">samp_getFloatFromMap()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a8a947c24f2c9333adf4e5d7fa11d134"></a><!-- doxytag: member="sampHandlers.c::samp_printMap" ref="a8a947c24f2c9333adf4e5d7fa11d134" args="(String name, Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_printMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_PRINTMAP -- Print the contents of a Map structure. +</div> +</div><p> +<a class="anchor" name="287569451dc1bf59d1f9f6d13b56716d"></a><!-- doxytag: member="sampHandlers.c::samp_resConeHandler" ref="287569451dc1bf59d1f9f6d13b56716d" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resConeHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESCONEHANDLER -- Handle a voresource.loadlist.cone message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c0bf7cf7fea362c0c82ad7bc3f267c48"></a><!-- doxytag: member="sampHandlers.c::samp_resLoadHandler" ref="c0bf7cf7fea362c0c82ad7bc3f267c48" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESLOADHANDLER -- handle a voresource.loadlist.* message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8b2300222d7b11f144eb4385412e69a5"></a><!-- doxytag: member="sampHandlers.c::samp_resSiapHandler" ref="8b2300222d7b11f144eb4385412e69a5" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resSiapHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESSIAPHANDLER -- Handle a voresource.loadlist.siap message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="866578a01c3b762435823b1b11869c42"></a><!-- doxytag: member="sampHandlers.c::samp_resSsapHandler" ref="866578a01c3b762435823b1b11869c42" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resSsapHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESSSAPHANDLER -- Handle a voresource.loadlist.ssap message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ad42ca17cbaf23012ad497559ea45e4c"></a><!-- doxytag: member="sampHandlers.c::samp_resTapHandler" ref="ad42ca17cbaf23012ad497559ea45e4c" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resTapHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESTAPHANDLER -- Handle a voresource.loadlist.tap message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="fa207ebdc587ba5eeab60fbf79b635d4"></a><!-- doxytag: member="sampHandlers.c::samp_resVOSpaceHandler" ref="fa207ebdc587ba5eeab60fbf79b635d4" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resVOSpaceHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESVOSPACEHANDLER -- Handle a voresource.loadlist.vospace message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2e8ec01a0dd96314622ae313206583db"></a><!-- doxytag: member="sampHandlers.c::samp_setSampHandler" ref="2e8ec01a0dd96314622ae313206583db" args="(handle_t handle, String mtype, void *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setSampHandler </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the SAMP interface handler for the mtype. +<p> +SAMP_SETSAMPHANDLER -- Set the SAMP interface handler for the mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, and <a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">Subs::sampFunc</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00475">samp_Subscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="81222e1f3572585fa30f11a78aa08c3f"></a><!-- doxytag: member="sampHandlers.c::samp_setUserHandler" ref="81222e1f3572585fa30f11a78aa08c3f" args="(handle_t handle, String mtype, void *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setUserHandler </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the user-interface handler for the mtype. +<p> +SAMP_SETUSERHANDLER -- Set the user-interface handler for the mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, and <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs::userFunc</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00475">samp_Subscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="bc319b97b3dbea29bd79c4f723db5438"></a><!-- doxytag: member="sampHandlers.c::samp_specLoadHandler" ref="bc319b97b3dbea29bd79c4f723db5438" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_specLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a spectrum.load.* message. +<p> +SAMP_SPECLOADHANDLER -- Handle a spectrum.load.* message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="dd2bca8fa3bf3b4ebbf449edc6b65d85"></a><!-- doxytag: member="sampHandlers.c::samp_specSSAHandler" ref="dd2bca8fa3bf3b4ebbf449edc6b65d85" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_specSSAHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a spectrum.load.ssa-generic message. +<p> +SAMP_SPECSSAHANDLER -- Handle a spectrum.load.ssa-generic message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00248">samp_getMapFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2e342b672e77e012cc98a6f5506a44be"></a><!-- doxytag: member="sampHandlers.c::samp_StatusHandler" ref="2e342b672e77e012cc98a6f5506a44be" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_StatusHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return status of the task. +<p> +SAMP_STATUSHANDLER -- Return status of the task.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, and <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d9184eb45a5bc93b5205fd5b1c6ef688"></a><!-- doxytag: member="sampHandlers.c::samp_tbHighlightHandler" ref="d9184eb45a5bc93b5205fd5b1c6ef688" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbHighlightHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a table.highlight.row message. +<p> +SAMP_TBHIGHLIGHTHANDLER -- Handle a table.highlight.row message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00288">samp_getIntFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="750c0fee0c7a99e135299c08751f288c"></a><!-- doxytag: member="sampHandlers.c::samp_tbLoadFITSHandler" ref="750c0fee0c7a99e135299c08751f288c" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbLoadFITSHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a generic table.load.fits message. +<p> +SAMP_TBLOADFITSHANDLER -- Handle a generic table.load.fits message *<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="26f96dc6cbf72283e2ee9cb8b4619ed3"></a><!-- doxytag: member="sampHandlers.c::samp_tbLoadHandler" ref="26f96dc6cbf72283e2ee9cb8b4619ed3" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a generic table.load.* message. +<p> +SAMP_TBLOADHANDLER -- Handle a generic table.load.* message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00621">samp_tbLoadFITSHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00663">samp_tbLoadVOTHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="144ec2329355d91022d5ea38736c0093"></a><!-- doxytag: member="sampHandlers.c::samp_tbLoadVOTHandler" ref="144ec2329355d91022d5ea38736c0093" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbLoadVOTHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a generic table.load.votable message. +<p> +SAMP_TBLOADVOTHANDLER -- Handle a generic table.load.votable message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="98d68d7091c0b7790631bb53e0ace656"></a><!-- doxytag: member="sampHandlers.c::samp_tbSelectHandler" ref="98d68d7091c0b7790631bb53e0ace656" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbSelectHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a table.select.rowList message. +<p> +SAMP_TBSELECTHANDLER -- Handle a table.select.rowList message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>, <a class="el" href="sampMap_8c_source.html#l00268">samp_getListFromMap()</a>, <a class="el" href="sampMap_8c_source.html#l00226">samp_getStringFromMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<hr><h2>Variable Documentation</h2> +<a class="anchor" name="a2106c7fe3a5747178c046238fbd5d55"></a><!-- doxytag: member="sampHandlers.c::nullList" ref="a2106c7fe3a5747178c046238fbd5d55" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="el" href="sampMethods_8c.html#a2106c7fe3a5747178c046238fbd5d55">nullList</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_OK Map struct +</div> +</div><p> +<a class="anchor" name="68bf22a5b3f2531242f5c6d6ecf2ea1e"></a><!-- doxytag: member="sampHandlers.c::nullMap" ref="68bf22a5b3f2531242f5c6d6ecf2ea1e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="el" href="sampMethods_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">nullMap</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP handle +</div> +</div><p> +<a class="anchor" name="b04b61ee02d86e15b02b861699ae7424"></a><!-- doxytag: member="sampHandlers.c::sampH" ref="b04b61ee02d86e15b02b861699ae7424" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t <a class="el" href="sampMethods_8c.html#b04b61ee02d86e15b02b861699ae7424">sampH</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP struct pointer +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampHub_8c.html b/vendor/voclient/libsamp/doc/html/sampHub_8c.html new file mode 100644 index 00000000..ac8d5529 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampHub_8c.html @@ -0,0 +1,624 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampHub.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampHub.c File Reference</h1>Methods related to the SAMP <a class="el" href="structHub.html">Hub</a> interface. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include <time.h></code><br> +<code>#include <pthread.h></code><br> +<code>#include <ctype.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15f13b436c106e975a91e0d343005e01"></a><!-- doxytag: member="sampHub.c::HUB_DBG" ref="15f13b436c106e975a91e0d343005e01" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>HUB_DBG</b> (getenv("HUB_DBG")!=NULL||access("/tmp/HUB_DBG",F_OK)==0)</td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#ab66aed8f93a9cd5734a8dd62e427418">samp_hubOpen</a> (<a class="el" href="structSamp.html">Samp</a> *sampP)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Discover and open a connection to the SAMP <a class="el" href="structHub.html">Hub</a>. <a href="#ab66aed8f93a9cd5734a8dd62e427418"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#52f471568663ac6f0116d57a9ce00f00">samp_hubClose</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close a connection to the <a class="el" href="structHub.html">Hub</a>. <a href="#52f471568663ac6f0116d57a9ce00f00"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#a927eb8dcb67e245aeb5a8a4feeb6230">samp_hubRunning</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#e792eedc70daa9b2d010ca6cd8e57fe8">samp_getAvailableHubs</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of available Hubs. <a href="#e792eedc70daa9b2d010ca6cd8e57fe8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b4292d136520c3d276d655e2093dd30"></a><!-- doxytag: member="sampHub.c::samp_getActiveHubName" ref="4b4292d136520c3d276d655e2093dd30" args="(handle_t handle)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getActiveHubName</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf266e81b16f556e2f42cad5a2eb9157"></a><!-- doxytag: member="sampHub.c::samp_getActiveHub" ref="bf266e81b16f556e2f42cad5a2eb9157" args="(handle_t handle)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_getActiveHub</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7ea81f81c8b5b5a6d7a323e9c98cd12"></a><!-- doxytag: member="sampHub.c::samp_hubInit" ref="b7ea81f81c8b5b5a6d7a323e9c98cd12" args="(handle_t handle, char *appName, char *descr)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_hubInit</b> (handle_t handle, char *appName, char *descr)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#2933b26ac05c440196368edad0167bdf">samp_processHubEvent</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. <a href="#2933b26ac05c440196368edad0167bdf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#19f64b527fcc431541206e41f8e36132">samp_hubEvent</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. <a href="#19f64b527fcc431541206e41f8e36132"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#13ad32079ae1db571e3114b7bd8ba356">samp_hubRegister</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a Register message to the <a class="el" href="structHub.html">Hub</a>. <a href="#13ad32079ae1db571e3114b7bd8ba356"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#6d4e32ed0eb19f02cc8a75f75a98deec">samp_hubUnRegister</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a UnRegister message to the <a class="el" href="structHub.html">Hub</a>. <a href="#6d4e32ed0eb19f02cc8a75f75a98deec"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#a704d2a0d290f2fdfb3ebfffc39adcb3">samp_hubSendShutdown</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a samp.app.event.shutdown message to the <a class="el" href="structHub.html">Hub</a>. <a href="#a704d2a0d290f2fdfb3ebfffc39adcb3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#2fcb0032e5ae98fff93becdb06da49f9">samp_hubSetXmlrpcCallback</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the client callback and send to <a class="el" href="structHub.html">Hub</a>. <a href="#2fcb0032e5ae98fff93becdb06da49f9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#47b1a9a4627fde97f95b40b372153cf6">samp_hubPing</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Ping the <a class="el" href="structHub.html">Hub</a> to see if it is alive. <a href="#47b1a9a4627fde97f95b40b372153cf6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#088f1e762175d0dbc315853d06e50149">samp_hubDeclareMetadata</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare "standard" metadata to the <a class="el" href="structHub.html">Hub</a>. <a href="#088f1e762175d0dbc315853d06e50149"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#7be493427eac28b2a064eedd8a7d63ff">samp_hubDeclareSubscriptions</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare mtype subscriptions to the <a class="el" href="structHub.html">Hub</a>. <a href="#7be493427eac28b2a064eedd8a7d63ff"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structHub.html">Hub</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a> = (<a class="el" href="structHub.html">Hub</a> *) NULL</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#037f00cb1101b007b4bf45e8bee1bd3e">numHubs</a> = 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#86b0db44d25bc3079d8d9d75e01a0ecd">hubHandles</a> [MAX_HUBS]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">pthread_mutex_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#c49d9bc6850c63f257c18f2920915d9c">samp_mutex</a> = PTHREAD_MUTEX_INITIALIZER</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12abcaf1a16a8a7c2ef6358cdbf4d705"></a><!-- doxytag: member="sampHub.c::sampP" ref="12abcaf1a16a8a7c2ef6358cdbf4d705" args="" --> +<a class="el" href="structSamp.html">Samp</a> * </td><td class="memItemRight" valign="bottom"><b>sampP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b45e068a722f83368367449cb0a5312b"></a><!-- doxytag: member="sampHub.c::numSamps" ref="b45e068a722f83368367449cb0a5312b" args="" --> +int </td><td class="memItemRight" valign="bottom"><b>numSamps</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9ee46f73e7f3c5e99958a618b2b6ed5a"></a><!-- doxytag: member="sampHub.c::sampHandles" ref="9ee46f73e7f3c5e99958a618b2b6ed5a" args="[MAX_SAMPS]" --> +handle_t </td><td class="memItemRight" valign="bottom"><b>sampHandles</b> [MAX_SAMPS]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampHub_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">nullMap</a></td></tr> + +</table> +<hr><h2>Detailed Description</h2> +Methods related to the SAMP <a class="el" href="structHub.html">Hub</a> interface. +<p> +SAMPHUB.C -- Methods related to the SAMP <a class="el" href="structHub.html">Hub</a> interface.<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/09 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="e792eedc70daa9b2d010ca6cd8e57fe8"></a><!-- doxytag: member="sampHub.c::samp_getAvailableHubs" ref="e792eedc70daa9b2d010ca6cd8e57fe8" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_getAvailableHubs </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a list of available Hubs. +<p> +SAMP_GETAVAILABLEHUBS -- Get a list of available Hubs<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>hub handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>List of hub handles </dd></dl> + +</div> +</div><p> +<a class="anchor" name="52f471568663ac6f0116d57a9ce00f00"></a><!-- doxytag: member="sampHub.c::samp_hubClose" ref="52f471568663ac6f0116d57a9ce00f00" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubClose </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Close a connection to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBCLOSE -- Close a connection to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>hub handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>unregister status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00147">Hub::meta</a>, <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>, <a class="el" href="sampUtil_8c_source.html#l00072">samp_freeHandle()</a>, and <a class="el" href="sampHub_8c_source.html#l00395">samp_hubUnRegister()</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00145">sampClose()</a>, and <a class="el" href="samp_8c_source.html#l00323">sampShutdown()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="088f1e762175d0dbc315853d06e50149"></a><!-- doxytag: member="sampHub.c::samp_hubDeclareMetadata" ref="088f1e762175d0dbc315853d06e50149" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubDeclareMetadata </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declare "standard" metadata to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_DECLAREMETADATA -- Declare "standard" metadata to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00145">Hub::description</a>, <a class="el" href="samp_8h_source.html#l00106">appMD::docURL</a>, <a class="el" href="samp_8h_source.html#l00105">appMD::iconURL</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00147">Hub::meta</a>, <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>, and <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>.</p> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00121">samp_DeclareMetadata()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="7be493427eac28b2a064eedd8a7d63ff"></a><!-- doxytag: member="sampHub.c::samp_hubDeclareSubscriptions" ref="7be493427eac28b2a064eedd8a7d63ff" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubDeclareSubscriptions </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declare mtype subscriptions to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBDECLARESUBSCRIPTIONS -- Declare mtype subscriptions to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, <a class="el" href="samp_8c_source.html#l00053">nullMap</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="samp_8h_source.html#l00161">Hub::samp</a>, <a class="el" href="sampMap_8c_source.html#l00067">samp_freeMap()</a>, and <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs::userFunc</a>.</p> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00227">samp_DeclareSubscriptions()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="19f64b527fcc431541206e41f8e36132"></a><!-- doxytag: member="sampHub.c::samp_hubEvent" ref="19f64b527fcc431541206e41f8e36132" args="(String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubEvent </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. +<p> +SAMP_HUBEVENT -- Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="structHub.html">Hub</a> event code or -1 if not found </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00070">HUB_SHUTDOWN</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ab66aed8f93a9cd5734a8dd62e427418"></a><!-- doxytag: member="sampHub.c::samp_hubOpen" ref="ab66aed8f93a9cd5734a8dd62e427418" args="(Samp *sampP)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t samp_hubOpen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structSamp.html">Samp</a> * </td> + <td class="paramname"> <em>sampP</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Discover and open a connection to the SAMP <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBOPEN -- Discover and open a connection to the SAMP <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>samp</em> </td><td>Same structure </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>hub handle </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00155">Hub::appId</a>, <a class="el" href="samp_8h_source.html#l00172">Samp::appVer</a>, <a class="el" href="samp_8h_source.html#l00144">Hub::appVer</a>, <a class="el" href="samp_8h_source.html#l00104">appMD::desc</a>, <a class="el" href="samp_8h_source.html#l00145">Hub::description</a>, <a class="el" href="samp_8h_source.html#l00173">Samp::description</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00147">Hub::meta</a>, <a class="el" href="samp_8h_source.html#l00161">Hub::samp</a>, <a class="el" href="sampHub_8c_source.html#l00354">samp_hubRegister()</a>, <a class="el" href="sampHub_8c_source.html#l00448">samp_hubSetXmlrpcCallback()</a>, <a class="el" href="sampUtil_8c_source.html#l00049">samp_newHandle()</a>, <a class="el" href="sampUtil_8c_source.html#l00108">samp_P2H()</a>, <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>, and <a class="el" href="samp_8h_source.html#l00150">Hub::url</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="47b1a9a4627fde97f95b40b372153cf6"></a><!-- doxytag: member="sampHub.c::samp_hubPing" ref="47b1a9a4627fde97f95b40b372153cf6" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubPing </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Ping the <a class="el" href="structHub.html">Hub</a> to see if it is alive. +<p> +SAMP_HUBPING -- Ping the <a class="el" href="structHub.html">Hub</a> to see if it is alive.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, and <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>.</p> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="13ad32079ae1db571e3114b7bd8ba356"></a><!-- doxytag: member="sampHub.c::samp_hubRegister" ref="13ad32079ae1db571e3114b7bd8ba356" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubRegister </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a Register message to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUB_REGISTER -- Send a Register message to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00157">Hub::hubId</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="samp_8h_source.html#l00149">Hub::secret</a>, and <a class="el" href="samp_8h_source.html#l00158">Hub::selfId</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a927eb8dcb67e245aeb5a8a4feeb6230"></a><!-- doxytag: member="sampHub.c::samp_hubRunning" ref="a927eb8dcb67e245aeb5a8a4feeb6230" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubRunning </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_HUBRUNNING -- See whether a <a class="el" href="structHub.html">Hub</a> is running. The test simply checks the existence of a <a class="el" href="structHub.html">Hub</a> lockfile. +<p>References <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a704d2a0d290f2fdfb3ebfffc39adcb3"></a><!-- doxytag: member="sampHub.c::samp_hubSendShutdown" ref="a704d2a0d290f2fdfb3ebfffc39adcb3" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubSendShutdown </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a samp.app.event.shutdown message to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBSENDSHUTDOWN -- Send a samp.app.event.shutdown message to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, and <a class="el" href="sampHandlers_8c_source.html#l01582">samp_nullResponse()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2fcb0032e5ae98fff93becdb06da49f9"></a><!-- doxytag: member="sampHub.c::samp_hubSetXmlrpcCallback" ref="2fcb0032e5ae98fff93becdb06da49f9" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubSetXmlrpcCallback </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the client callback and send to <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBSETXMLRPCCALLBACK -- Set the client callback and send to <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, and <a class="el" href="sampUtil_8c_source.html#l00194">samp_serverPort()</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6d4e32ed0eb19f02cc8a75f75a98deec"></a><!-- doxytag: member="sampHub.c::samp_hubUnRegister" ref="6d4e32ed0eb19f02cc8a75f75a98deec" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubUnRegister </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a UnRegister message to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBUNREGISTER -- Send a UnRegister message to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, and <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, and <a class="el" href="sampCommands_8c_source.html#l00102">samp_UnRegister()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2933b26ac05c440196368edad0167bdf"></a><!-- doxytag: member="sampHub.c::samp_processHubEvent" ref="2933b26ac05c440196368edad0167bdf" args="(String mtype, Map params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_processHubEvent </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>params</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. +<p> +SAMP_HUBEVENT -- Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>message parameter Map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>non-zero value if a <a class="el" href="structHub.html">Hub</a> event was processed </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00070">HUB_SHUTDOWN</a>, <a class="el" href="samp_8c_source.html#l00834">samp_addClient()</a>, <a class="el" href="sampHub_8c_source.html#l00320">samp_hubEvent()</a>, <a class="el" href="sampHub_8c_source.html#l00031">samp_mutex</a>, <a class="el" href="sampUtil_8c_source.html#l00108">samp_P2H()</a>, <a class="el" href="samp_8c_source.html#l00908">samp_removeClient()</a>, <a class="el" href="samp_8c_source.html#l00051">sampH</a>, and <a class="el" href="samp_8c_source.html#l00323">sampShutdown()</a>.</p> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>.</p> + +</div> +</div><p> +<hr><h2>Variable Documentation</h2> +<a class="anchor" name="d702b07240de0e0cf9e4b781a38317ad"></a><!-- doxytag: member="sampHub.c::hub" ref="d702b07240de0e0cf9e4b781a38317ad" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structHub.html">Hub</a>* <a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a> = (<a class="el" href="structHub.html">Hub</a> *) NULL </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +empty List struct +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampCommands_8c_source.html#l00121">samp_DeclareMetadata()</a>, <a class="el" href="sampCommands_8c_source.html#l00227">samp_DeclareSubscriptions()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00188">samp_GetMetadata()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>, <a class="el" href="sampClient_8c_source.html#l00278">samp_Reply()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>, and <a class="el" href="sampCommands_8c_source.html#l00102">samp_UnRegister()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="86b0db44d25bc3079d8d9d75e01a0ecd"></a><!-- doxytag: member="sampHub.c::hubHandles" ref="86b0db44d25bc3079d8d9d75e01a0ecd" args="[MAX_HUBS]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t <a class="el" href="sampHub_8c.html#86b0db44d25bc3079d8d9d75e01a0ecd">hubHandles</a>[MAX_HUBS] </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +No. of available hubs +</div> +</div><p> +<a class="anchor" name="68bf22a5b3f2531242f5c6d6ecf2ea1e"></a><!-- doxytag: member="sampHub.c::nullMap" ref="68bf22a5b3f2531242f5c6d6ecf2ea1e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="el" href="sampMethods_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">nullMap</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP handle +</div> +</div><p> +<a class="anchor" name="037f00cb1101b007b4bf45e8bee1bd3e"></a><!-- doxytag: member="sampHub.c::numHubs" ref="037f00cb1101b007b4bf45e8bee1bd3e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="sampHub_8c.html#037f00cb1101b007b4bf45e8bee1bd3e">numHubs</a> = 0 </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +HUB connection +</div> +</div><p> +<a class="anchor" name="c49d9bc6850c63f257c18f2920915d9c"></a><!-- doxytag: member="sampHub.c::samp_mutex" ref="c49d9bc6850c63f257c18f2920915d9c" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">pthread_mutex_t <a class="el" href="sampHub_8c.html#c49d9bc6850c63f257c18f2920915d9c">samp_mutex</a> = PTHREAD_MUTEX_INITIALIZER </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +lock so we can update struct +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampList_8c.html b/vendor/voclient/libsamp/doc/html/sampList_8c.html new file mode 100644 index 00000000..8cda5200 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampList_8c.html @@ -0,0 +1,544 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampList.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampList.c File Reference</h1>(Internal) interface to support the List structure. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#b5375a6478dccefe7df2b48416604b29">samp_newList</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new List object. <a href="#b5375a6478dccefe7df2b48416604b29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#b162ae9b9f98da80f6bb5c34b5cbcbf6">samp_freeList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given List object. <a href="#b162ae9b9f98da80f6bb5c34b5cbcbf6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#c260afb0cbf19b427e3eba96a2341e52">samp_listLen</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of elements in a List. <a href="#c260afb0cbf19b427e3eba96a2341e52"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#5b69180b036e58528c98b1cf5a42825a">samp_setStringInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a List (append). <a href="#5b69180b036e58528c98b1cf5a42825a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#ea188bb711f3b5549d11204b0ff2da08">samp_setMapInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Map in a List (append). <a href="#ea188bb711f3b5549d11204b0ff2da08"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#0ff97d44e62b7c88a046a29324552400">samp_setListInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list1, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list2)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a List in another List (append). <a href="#0ff97d44e62b7c88a046a29324552400"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#a803bead8b452de6e1d08b8b3b9e8828">samp_setIntInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int ival)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an Int in a List (append). <a href="#a803bead8b452de6e1d08b8b3b9e8828"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#18d586491620a63b3a4d6c3667ee2aa5">samp_setFloatInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, float rval)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Float in a List (append). <a href="#18d586491620a63b3a4d6c3667ee2aa5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#2d1cd41c4583ac300aaa2d50ad3f76ed">samp_getStringFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string from the List. <a href="#2d1cd41c4583ac300aaa2d50ad3f76ed"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#33ca96ee3a8e7d26356c7b66f469da74">samp_getMapFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Map from the List. <a href="#33ca96ee3a8e7d26356c7b66f469da74"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#1ec1ddadb4e889792b6fa7df6f6c3125">samp_getListFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a List from the List. <a href="#1ec1ddadb4e889792b6fa7df6f6c3125"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1174e001b2d16ed0aa1b317cfc883af1"></a><!-- doxytag: member="sampList.c::samp_getIntFromList" ref="1174e001b2d16ed0aa1b317cfc883af1" args="(List list, int index)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_getIntFromList</b> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="sampList_8c.html#4e8339b2b3f5ff1a58cebb74eddca9e6">samp_getFloatFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Float from the List. <a href="#4e8339b2b3f5ff1a58cebb74eddca9e6"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +(Internal) interface to support the List structure. +<p> +SAMPLIST.C -- (Internal) interface to support the List structure.<p> +list = samp_newList () samp_freeList (List list) len = samp_listLen (List list)<p> +samp_setStringInList (List list, char *value) samp_setMapInList (List list, Map map) samp_setListInList (List list1, List list2) samp_setIntInList (List list, int val) samp_setFloatInList (List list, float val)<p> +str = samp_getStringFromList (List list, int index) map = samp_getMapFromList (List list, int index) list = samp_getListFromList (List list, int index) ival = samp_getIntFromList (List list, int index) rval = samp_getFloatFromList (List list, int index)<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/09 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="b162ae9b9f98da80f6bb5c34b5cbcbf6"></a><!-- doxytag: member="sampList.c::samp_freeList" ref="b162ae9b9f98da80f6bb5c34b5cbcbf6" args="(List list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given List object. +<p> +SAMP_FREELIST -- Free the given List object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4e8339b2b3f5ff1a58cebb74eddca9e6"></a><!-- doxytag: member="sampList.c::samp_getFloatFromList" ref="4e8339b2b3f5ff1a58cebb74eddca9e6" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float samp_getFloatFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a Float from the List. +<p> +SAMP_GETFLOATFROMLIST -- Get a Float from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the desired value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>int value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1ec1ddadb4e889792b6fa7df6f6c3125"></a><!-- doxytag: member="sampList.c::samp_getListFromList" ref="1ec1ddadb4e889792b6fa7df6f6c3125" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_getListFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a List from the List. +<p> +Get an Int from the List.<p> +SAMP_GETLISTFROMLIST -- Get a List from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the List </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>List handle</dd></dl> +SAMP_GETINTFROMLIST -- Get an Int from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the desired value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>int value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="33ca96ee3a8e7d26356c7b66f469da74"></a><!-- doxytag: member="sampList.c::samp_getMapFromList" ref="33ca96ee3a8e7d26356c7b66f469da74" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getMapFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a Map from the List. +<p> +SAMP_GETMAPFROMLIST -- Get a Map from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the Map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Map handle </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2d1cd41c4583ac300aaa2d50ad3f76ed"></a><!-- doxytag: member="sampList.c::samp_getStringFromList" ref="2d1cd41c4583ac300aaa2d50ad3f76ed" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_getStringFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a string from the List. +<p> +SAMP_GETSTRINGFROMLIST -- Get a string from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>character string </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c260afb0cbf19b427e3eba96a2341e52"></a><!-- doxytag: member="sampList.c::samp_listLen" ref="c260afb0cbf19b427e3eba96a2341e52" args="(List list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_listLen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get number of elements in a List. +<p> +SAMP_LISTLEN -- Get number of elements in a List.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, <a class="el" href="sampCommands_8c_source.html#l00323">samp_GetSubscribedClients()</a>, <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b5375a6478dccefe7df2b48416604b29"></a><!-- doxytag: member="sampList.c::samp_newList" ref="b5375a6478dccefe7df2b48416604b29" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t samp_newList </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new List object. +<p> +SAMP_NEWLIST -- Create a new List object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to List object </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, <a class="el" href="sampCommands_8c_source.html#l00323">samp_GetSubscribedClients()</a>, <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="18d586491620a63b3a4d6c3667ee2aa5"></a><!-- doxytag: member="sampList.c::samp_setFloatInList" ref="18d586491620a63b3a4d6c3667ee2aa5" args="(List list, float rval)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setFloatInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>rval</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Float in a List (append). +<p> +SAMP_SETFLOATINLIST -- Set a Float in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list1</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>rval</em> </td><td>Float value to be appended </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a803bead8b452de6e1d08b8b3b9e8828"></a><!-- doxytag: member="sampList.c::samp_setIntInList" ref="a803bead8b452de6e1d08b8b3b9e8828" args="(List list, int ival)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setIntInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>ival</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an Int in a List (append). +<p> +SAMP_SETINTINLIST -- Set an Int in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list1</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>ival</em> </td><td>Integer value to be appended </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0ff97d44e62b7c88a046a29324552400"></a><!-- doxytag: member="sampList.c::samp_setListInList" ref="0ff97d44e62b7c88a046a29324552400" args="(List list1, List list2)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setListInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list2</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a List in another List (append). +<p> +SAMP_SETLISTINLIST -- Set a List in another List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list1</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>list2</em> </td><td>List to be appended </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ea188bb711f3b5549d11204b0ff2da08"></a><!-- doxytag: member="sampList.c::samp_setMapInList" ref="ea188bb711f3b5549d11204b0ff2da08" args="(List list, Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setMapInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Map in a List (append). +<p> +SAMP_SETMAPINLIST -- Set a Map in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>Map object to be set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="5b69180b036e58528c98b1cf5a42825a"></a><!-- doxytag: member="sampList.c::samp_setStringInList" ref="5b69180b036e58528c98b1cf5a42825a" args="(List list, char *value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setStringInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a string in a List (append). +<p> +SAMP_SETSTRINGINLIST -- Set a string in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>string value to set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, and <a class="el" href="sampCommands_8c_source.html#l00323">samp_GetSubscribedClients()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampLog_8c.html b/vendor/voclient/libsamp/doc/html/sampLog_8c.html new file mode 100644 index 00000000..e4549f8a --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampLog_8c.html @@ -0,0 +1,169 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampLog.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampLog.c File Reference</h1>SAMP trace and logging interface. +<a href="#_details">More...</a> +<p> +<code>#include <stdio.h></code><br> +<code>#include <fcntl.h></code><br> +<code>#include <signal.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <stdlib.h></code><br> +<code>#include <string.h></code><br> +<code>#include <stdarg.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7ca95aa869dee3c8acc0b1e278ec08be"></a><!-- doxytag: member="sampLog.c::SZ_FMTSPEC" ref="7ca95aa869dee3c8acc0b1e278ec08be" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_FMTSPEC</b> 25</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adbbc7b02d94a4c18646813ac8d7dec1"></a><!-- doxytag: member="sampLog.c::EOS" ref="adbbc7b02d94a4c18646813ac8d7dec1" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>EOS</b> 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4fa28a492427bc4af75248e22537e9b4"></a><!-- doxytag: member="sampLog.c::T_INT" ref="4fa28a492427bc4af75248e22537e9b4" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>T_INT</b> 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e80924a839d0f80571bcd1d2b6ec084"></a><!-- doxytag: member="sampLog.c::T_DOUBLE" ref="6e80924a839d0f80571bcd1d2b6ec084" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>T_DOUBLE</b> 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2381f297a8fbb736886d7d1b6b99b42"></a><!-- doxytag: member="sampLog.c::T_CHAR" ref="e2381f297a8fbb736886d7d1b6b99b42" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>T_CHAR</b> 2</td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampLog_8c.html#4919f892b6fccced4e6b9d777071b781">sampLog</a> (handle_t handle, char *format,...)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">SAMP message logger. <a href="#4919f892b6fccced4e6b9d777071b781"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampLog_8c.html#2b3dd1662e61c83e29109126689b08b9">sampTrace</a> (handle_t handle, char *format,...)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">SAMP tracer. <a href="#2b3dd1662e61c83e29109126689b08b9"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +SAMP trace and logging interface. +<p> +SAMPLOG.C -- SAMP trace and logging interface.<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>6/10/09 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="4919f892b6fccced4e6b9d777071b781"></a><!-- doxytag: member="sampLog.c::sampLog" ref="4919f892b6fccced4e6b9d777071b781" args="(handle_t handle, char *format,...)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void sampLog </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>format</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"> <em>...</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP message logger. +<p> +SAMPLOG -- SAMP message logger.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>SAMP handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>message format string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, and <a class="el" href="samp_8h_source.html#l00202">Samp::logfd</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2b3dd1662e61c83e29109126689b08b9"></a><!-- doxytag: member="sampLog.c::sampTrace" ref="2b3dd1662e61c83e29109126689b08b9" args="(handle_t handle, char *format,...)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void sampTrace </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>format</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"> <em>...</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP tracer. +<p> +SAMPTRACE -- SAMP tracer.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>SAMP handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>message format string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, <a class="el" href="samp_8c_source.html#l00145">sampClose()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampMTypes_8c.html b/vendor/voclient/libsamp/doc/html/sampMTypes_8c.html new file mode 100644 index 00000000..4007553d --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampMTypes_8c.html @@ -0,0 +1,1012 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampMTypes.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampMTypes.c File Reference</h1>SAMP interface procedures for application mtypes. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include <time.h></code><br> +<code>#include <ctype.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#34e9d38073f36daaf41c418f8d680ee5">samp_tableLoadVOTable</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to load a VOTable. <a href="#34e9d38073f36daaf41c418f8d680ee5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#74aeaaf742121348390ec854c30c1479">samp_tableLoadFITS</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to load a FITS table. <a href="#74aeaaf742121348390ec854c30c1479"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#e38ac987f1dfd87ad64f97d55396270e">samp_tableHighlightRow</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, int row)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to highlight a table row. <a href="#e38ac987f1dfd87ad64f97d55396270e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#f133efb67fe4bcfd2b9c8ab9d23b4c5e">samp_tableSelectRowList</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, int rows[], int nrows)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to select a list of table rows. <a href="#f133efb67fe4bcfd2b9c8ab9d23b4c5e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#4812b571ed87f7842ca20b7024770df3">samp_imageLoadFITS</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> imageId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to load a FITS image. <a href="#4812b571ed87f7842ca20b7024770df3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#e1e86e79d9a1768e5f265cbb44279172">samp_coordPointAtSky</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, float ra, float dec)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to point at an RA/Dec coordinate. <a href="#e1e86e79d9a1768e5f265cbb44279172"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#18b351385bd175581a6788a4f7342f07">samp_specLoadSSAGeneric</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> meta, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> spectrumId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a generic spectrum from an SSA service. <a href="#18b351385bd175581a6788a4f7342f07"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#5900317c1609ddd5b6da70dc0eb2040c">samp_cmdExec</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> cmd)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a command in a remote application. <a href="#5900317c1609ddd5b6da70dc0eb2040c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#9c64fef9c158d7fd4ff7f72691ccd319">samp_envGet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an environment variable in a remote application. <a href="#9c64fef9c158d7fd4ff7f72691ccd319"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#ded4b8bdac87c5b6faa7f13d8abb22a1">samp_envSet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an environment variable in a remote application. <a href="#ded4b8bdac87c5b6faa7f13d8abb22a1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#19b75403d63714c4fccc8a8d4fa4c8cf">samp_paramGet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a parameter variable in a remote application. <a href="#19b75403d63714c4fccc8a8d4fa4c8cf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#535cb6760c733a75746d2f104b1a01be">samp_paramSet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an parameter variable in a remote application. <a href="#535cb6760c733a75746d2f104b1a01be"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#ae7f51c1f6169b918568a1202d0fa031">samp_bibLoad</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> bibcode)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Exchange a bibcode. <a href="#ae7f51c1f6169b918568a1202d0fa031"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#8013c549ef47e0507edf39c8ab1b62aa">samp_resourceLoad</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> type, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resMap)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Exchange a resource list. <a href="#8013c549ef47e0507edf39c8ab1b62aa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#b2ff2e029c57b56ad57416c624341fe6">samp_sendGeneric</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> args[])</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a geenric message. <a href="#b2ff2e029c57b56ad57416c624341fe6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMTypes_8c.html#80ef1a82845b96091857c7d4a3c7972c">samp_sendMsg</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the specified message. <a href="#80ef1a82845b96091857c7d4a3c7972c"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +SAMP interface procedures for application mtypes. +<p> +SAMPMTYPES.C -- SAMP interface procedures for application mtypes.<p> +samp_tableLoadVOTable (handle, recip, url, tableId, name) samp_tableLoadFITS (handle, recip, url, tableId, name) samp_tableHighlightRow (handle, recip, tableId, url, row) samp_tableSelectRowList (handle, recip, tableId, url, rows[], nrows)<p> +samp_imageLoadFITS (handle, recip, url, imageId, name) samp_coordPointAtSky (handle, recip, ra, dec)<p> +samp_specLoadSSAGeneric (handle, recip, url, meta_map, specId, name) samp_cmdExec (handle, recip, cmd) samp_envGet (handle, recip, name) samp_envSet (handle, recip, name, value) samp_paramGet (handle, recip, name) samp_paramSet (handle, recip, name, value) samp_bibLoad (handle, recip, bibcode) samp_resourceLoad (handle, recip, type, resList[])<p> +samp_sendGeneric (handle, recip, mtype, args) samp_sendMsg (handle, recip, Map msg_map)<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/18/11 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="ae7f51c1f6169b918568a1202d0fa031"></a><!-- doxytag: member="sampMTypes.c::samp_bibLoad" ref="ae7f51c1f6169b918568a1202d0fa031" args="(handle_t handle, String recip, String bibcode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_bibLoad </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>bibcode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Exchange a bibcode. +<p> +SAMP_BIBLOAD -- Exchange a bibcode.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bibcode</em> </td><td>Bibcode string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5900317c1609ddd5b6da70dc0eb2040c"></a><!-- doxytag: member="sampMTypes.c::samp_cmdExec" ref="5900317c1609ddd5b6da70dc0eb2040c" args="(handle_t handle, String recip, String cmd)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_cmdExec </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>cmd</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Execute a command in a remote application. +<p> +SAMP_CMDEXEC -- Execute a command in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>cmd</em> </td><td>Command string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e1e86e79d9a1768e5f265cbb44279172"></a><!-- doxytag: member="sampMTypes.c::samp_coordPointAtSky" ref="e1e86e79d9a1768e5f265cbb44279172" args="(handle_t handle, String recip, float ra, float dec)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_coordPointAtSky </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>ra</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>dec</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to point at an RA/Dec coordinate. +<p> +SAMP_COORDPOINTATSKY -- Tell an app to point at an RA/Dec coordinate.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>ra</em> </td><td>RA of coord in degrees </td></tr> + <tr><td valign="top"></td><td valign="top"><em>dec</em> </td><td>Dec of coord in degrees </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00181">samp_addFloatParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="9c64fef9c158d7fd4ff7f72691ccd319"></a><!-- doxytag: member="sampMTypes.c::samp_envGet" ref="9c64fef9c158d7fd4ff7f72691ccd319" args="(handle_t handle, String recip, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_envGet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get an environment variable in a remote application. +<p> +SAMP_ENVGET -- Get an environment variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL, Value of variable, or list of values </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ded4b8bdac87c5b6faa7f13d8abb22a1"></a><!-- doxytag: member="sampMTypes.c::samp_envSet" ref="ded4b8bdac87c5b6faa7f13d8abb22a1" args="(handle_t handle, String recip, String name, String value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_envSet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an environment variable in a remote application. +<p> +SAMP_ENVSET -- Set an environment variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value of variable or NULL </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4812b571ed87f7842ca20b7024770df3"></a><!-- doxytag: member="sampMTypes.c::samp_imageLoadFITS" ref="4812b571ed87f7842ca20b7024770df3" args="(handle_t handle, String recip, String url, String imageId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_imageLoadFITS </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>imageId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to load a FITS image. +<p> +SAMP_IMAGELOADFITS -- Tell an app to load a FITS image.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>imageId</em> </td><td>ID assigned to image (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name assigned to image (optional) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="19b75403d63714c4fccc8a8d4fa4c8cf"></a><!-- doxytag: member="sampMTypes.c::samp_paramGet" ref="19b75403d63714c4fccc8a8d4fa4c8cf" args="(handle_t handle, String recip, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_paramGet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a parameter variable in a remote application. +<p> +SAMP_PARAMGET -- Get a parameter variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL, Value of variable, or list of values </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00175">Samp::errortxt</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="samp_8h_source.html#l00156">Hub::privateKey</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>.</p> + +</div> +</div><p> +<a class="anchor" name="535cb6760c733a75746d2f104b1a01be"></a><!-- doxytag: member="sampMTypes.c::samp_paramSet" ref="535cb6760c733a75746d2f104b1a01be" args="(handle_t handle, String recip, String name, String value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramSet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an parameter variable in a remote application. +<p> +SAMP_PARAMSET -- Set an parameter variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value of variable or NULL </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8013c549ef47e0507edf39c8ab1b62aa"></a><!-- doxytag: member="sampMTypes.c::samp_resourceLoad" ref="8013c549ef47e0507edf39c8ab1b62aa" args="(handle_t handle, String recip, String type, String name, Map resMap)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resourceLoad </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>resMap</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Exchange a resource list. +<p> +SAMP_RESOURCELOAD -- Exchange a resource list.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Resource type (or NULL) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Descriptive name (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>resMap</em> </td><td>Resource map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00116">samp_addMapParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b2ff2e029c57b56ad57416c624341fe6"></a><!-- doxytag: member="sampMTypes.c::samp_sendGeneric" ref="b2ff2e029c57b56ad57416c624341fe6" args="(handle_t handle, String recip, String mtype, String args[])" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_sendGeneric </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>args</em>[]</td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a geenric message. +<p> +SAMP_SENDGENERIC -- Send a generic message.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>Message type </td></tr> + <tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>Argument list </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR</dd></dl> +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. +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00181">samp_addFloatParam()</a>, <a class="el" href="sampParam_8c_source.html#l00154">samp_addIntParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="80ef1a82845b96091857c7d4a3c7972c"></a><!-- doxytag: member="sampMTypes.c::samp_sendMsg" ref="80ef1a82845b96091857c7d4a3c7972c" args="(handle_t handle, String recip, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_sendMsg </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send the specified message. +<p> +SAMP_SENDMSG -- Send the specified message.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, and <a class="el" href="sampClient_8c_source.html#l00360">samp_setErr()</a>.</p> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="18b351385bd175581a6788a4f7342f07"></a><!-- doxytag: member="sampMTypes.c::samp_specLoadSSAGeneric" ref="18b351385bd175581a6788a4f7342f07" args="(handle_t handle, String recip, String url, Map meta, String spectrumId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_specLoadSSAGeneric </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>meta</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>spectrumId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Load a generic spectrum from an SSA service. +<p> +SAMP_SPECLOADSSAGENERIC -- Load a generic spectrum from an SSA service.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL of spectrum to load </td></tr> + <tr><td valign="top"></td><td valign="top"><em>meta</em> </td><td>Metadata map describing data found at the URL </td></tr> + <tr><td valign="top"></td><td valign="top"><em>spectrumId</em> </td><td>Identifier for spectrum (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name used to label spectrum (optional); </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00116">samp_addMapParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e38ac987f1dfd87ad64f97d55396270e"></a><!-- doxytag: member="sampMTypes.c::samp_tableHighlightRow" ref="e38ac987f1dfd87ad64f97d55396270e" args="(handle_t handle, String recip, String tableId, String url, int row)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tableHighlightRow </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>row</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to highlight a table row. +<p> +SAMP_TABLEHIGHLIGHTROW -- Tell an app to highlight a table row.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID associated with a previously loaded table </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>rows</em> </td><td>List of (zero-based) row indices </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00154">samp_addIntParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="74aeaaf742121348390ec854c30c1479"></a><!-- doxytag: member="sampMTypes.c::samp_tableLoadFITS" ref="74aeaaf742121348390ec854c30c1479" args="(handle_t handle, String recip, String url, String tableId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tableLoadFITS </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to load a FITS table. +<p> +SAMP_TABLELOADFITS -- Tell an app to load a FITS table.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID assigned to table (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name assigned to table (optional) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="34e9d38073f36daaf41c418f8d680ee5"></a><!-- doxytag: member="sampMTypes.c::samp_tableLoadVOTable" ref="34e9d38073f36daaf41c418f8d680ee5" args="(handle_t handle, String recip, String url, String tableId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tableLoadVOTable </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to load a VOTable. +<p> +SAMP_TABLELOADVOTABLE -- Tell an app to load a VOTable.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID assigned to table (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name assigned to table (optional) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f133efb67fe4bcfd2b9c8ab9d23b4c5e"></a><!-- doxytag: member="sampMTypes.c::samp_tableSelectRowList" ref="f133efb67fe4bcfd2b9c8ab9d23b4c5e" args="(handle_t handle, String recip, String tableId, String url, int rows[], int nrows)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tableSelectRowList </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>rows</em>[], </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>nrows</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to select a list of table rows. +<p> +SAMP_TABLESELECTROWLIST -- Tell an app to select a list of table rows.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID associated with a previously loaded table </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>rows</em> </td><td>Array of (zero-based) row indices </td></tr> + <tr><td valign="top"></td><td valign="top"><em>nrows</em> </td><td>Number of rows </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="sampHub_8c_source.html#l00026">hub</a>, <a class="el" href="sampParam_8c_source.html#l00135">samp_addListParam()</a>, <a class="el" href="sampList_8c_source.html#l00063">samp_freeList()</a>, <a class="el" href="sampMsg_8c_source.html#l00053">samp_freeMsg()</a>, <a class="el" href="sampMsg_8c_source.html#l00109">samp_msgParam()</a>, <a class="el" href="sampList_8c_source.html#l00047">samp_newList()</a>, <a class="el" href="sampMsg_8c_source.html#l00036">samp_newMsg()</a>, <a class="el" href="sampParam_8c_source.html#l00041">samp_newParam()</a>, <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>, and <a class="el" href="sampList_8c_source.html#l00152">samp_setIntInList()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampMap_8c.html b/vendor/voclient/libsamp/doc/html/sampMap_8c.html new file mode 100644 index 00000000..80ccf1c5 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampMap_8c.html @@ -0,0 +1,593 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampMap.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampMap.c File Reference</h1>(Internal) Interface to support the Map structure +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#9985b96289047cafc24f2adbfeed977f">samp_newMap</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Map object. <a href="#9985b96289047cafc24f2adbfeed977f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#fe80438de542c6657d623993360b37d1">samp_freeMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given Map object. <a href="#fe80438de542c6657d623993360b37d1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c99f7146ad3acd3e381a02d5df1234f"></a><!-- doxytag: member="sampMap.c::samp_getMapSize" ref="1c99f7146ad3acd3e381a02d5df1234f" args="(Map map)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_getMapSize</b> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c8a1b402743b52f2837e97cf41e9e34"></a><!-- doxytag: member="sampMap.c::samp_getMapKey" ref="4c8a1b402743b52f2837e97cf41e9e34" args="(Map map, int index)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getMapKey</b> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, int index)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7dcdf07dd7f3252f3bf2dd5002c62251"></a><!-- doxytag: member="sampMap.c::samp_getMapVal" ref="7dcdf07dd7f3252f3bf2dd5002c62251" args="(Map map, int index)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getMapVal</b> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, int index)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#b9b2157de89369eb5cd95bfe804eb89a">samp_setStringInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a Map (append). <a href="#b9b2157de89369eb5cd95bfe804eb89a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#f102490efe1b92d99b67f244dc498c7b">samp_setMapInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map1, char *key, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map2)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Map in a Map (append). <a href="#f102490efe1b92d99b67f244dc498c7b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#362c2f670c98dd6a3ef69debd1871604">samp_setListInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a List in a Map (append). <a href="#362c2f670c98dd6a3ef69debd1871604"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#c22ec42dbf9a01c9b4e00cf011e7eb9d">samp_setIntInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Int in a Map (append). <a href="#c22ec42dbf9a01c9b4e00cf011e7eb9d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#0f07ae542f5b317311b3799bd96a88fd">samp_setFloatInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, float value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a Map (append). <a href="#0f07ae542f5b317311b3799bd96a88fd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#96ca606e0e7da659c3dc0a30846bcd66">samp_getStringFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string from the Map. <a href="#96ca606e0e7da659c3dc0a30846bcd66"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#525e8ffdfa32867f392f2c1340215453">samp_getMapFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Map from the Map. <a href="#525e8ffdfa32867f392f2c1340215453"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#31ddb90cf2184ae0151b9e7ec8c1a51f">samp_getListFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a LIST from the Map. <a href="#31ddb90cf2184ae0151b9e7ec8c1a51f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#210fc0eba30abddf1bdc2e780d58072c">samp_getIntFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a integer from the Map. <a href="#210fc0eba30abddf1bdc2e780d58072c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMap_8c.html#b0d3768990294554a298c4057b3b315d">samp_getFloatFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a float from the Map. <a href="#b0d3768990294554a298c4057b3b315d"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +(Internal) Interface to support the Map structure +<p> +SAMPMAP.C -- (Internal) Interface to support the Map structure<p> +map = samp_newMap () samp_freeMap (Map map)<p> +nelem = samp_getMapSize (Map map) key = samp_getMapKey (Map map, int index) val = samp_getMapVal (Map map, int index)<p> +samp_setStringInMap (Map map, char *value) samp_setMapInMap (Map map1, Map map2) samp_setListInMap (Map map, List list) samp_setIntInMap (Map map, int ival) samp_setFloatInMap (Map map, float rval)<p> +str = samp_getStringFromMap (Map map, char *key) map = samp_getMapFromMap (Map map, char *key) list = samp_getListFromMap (Map map, char *key) ival = samp_getIntFromMap (Map map, char *key) rval = samp_getFloatFromMap (Map map, char *key)<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/09 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="fe80438de542c6657d623993360b37d1"></a><!-- doxytag: member="sampMap.c::samp_freeMap" ref="fe80438de542c6657d623993360b37d1" args="(Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given Map object. +<p> +SAMP_FREEMAP -- Free the given Map object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>Map object to free </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, and <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b0d3768990294554a298c4057b3b315d"></a><!-- doxytag: member="sampMap.c::samp_getFloatFromMap" ref="b0d3768990294554a298c4057b3b315d" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float samp_getFloatFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a float from the Map. +<p> +SAMP_GETFLOATFROMMAP -- Get a float from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>floating point value </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00786">samp_pointAtHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="210fc0eba30abddf1bdc2e780d58072c"></a><!-- doxytag: member="sampMap.c::samp_getIntFromMap" ref="210fc0eba30abddf1bdc2e780d58072c" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_getIntFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a integer from the Map. +<p> +SAMP_GETINTFROMMAP -- Get a integer from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>integer value </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00705">samp_tbHighlightHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="31ddb90cf2184ae0151b9e7ec8c1a51f"></a><!-- doxytag: member="sampMap.c::samp_getListFromMap" ref="31ddb90cf2184ae0151b9e7ec8c1a51f" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_getListFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a LIST from the Map. +<p> +SAMP_GETLISTFROMMAP -- Get a LIST from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to List value </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="525e8ffdfa32867f392f2c1340215453"></a><!-- doxytag: member="sampMap.c::samp_getMapFromMap" ref="525e8ffdfa32867f392f2c1340215453" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getMapFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a Map from the Map. +<p> +SAMP_GETMAPFROMMAP -- Get a Map from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to Map value </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="96ca606e0e7da659c3dc0a30846bcd66"></a><!-- doxytag: member="sampMap.c::samp_getStringFromMap" ref="96ca606e0e7da659c3dc0a30846bcd66" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_getStringFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a string from the Map. +<p> +SAMP_GETSTRINGFROMMAP -- Get a string from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>string value from Map </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l01118">samp_bibcodeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00906">samp_cmdExecHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00994">samp_envSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00547">samp_imLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01082">samp_paramSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00705">samp_tbHighlightHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00621">samp_tbLoadFITSHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00663">samp_tbLoadVOTHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="9985b96289047cafc24f2adbfeed977f"></a><!-- doxytag: member="sampMap.c::samp_newMap" ref="9985b96289047cafc24f2adbfeed977f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t samp_newMap </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new Map object. +<p> +SAMP_NEWMAP -- Create a new Map object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Map </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="samp_8c_source.html#l00957">samp_getNullMap()</a>, <a class="el" href="samp_8c_source.html#l00942">samp_getOKMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0f07ae542f5b317311b3799bd96a88fd"></a><!-- doxytag: member="sampMap.c::samp_setFloatInMap" ref="0f07ae542f5b317311b3799bd96a88fd" args="(Map map, char *key, float value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setFloatInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a string in a Map (append). +<p> +SAMP_SETFLOATINMAP -- Set a Float in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c22ec42dbf9a01c9b4e00cf011e7eb9d"></a><!-- doxytag: member="sampMap.c::samp_setIntInMap" ref="c22ec42dbf9a01c9b4e00cf011e7eb9d" args="(Map map, char *key, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setIntInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Int in a Map (append). +<p> +SAMP_SETINTINMAP -- Set a Int in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="362c2f670c98dd6a3ef69debd1871604"></a><!-- doxytag: member="sampMap.c::samp_setListInMap" ref="362c2f670c98dd6a3ef69debd1871604" args="(Map map, char *key, List list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setListInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a List in a Map (append). +<p> +SAMP_SETLISTINMAP -- Set a List in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>handle to List object to set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f102490efe1b92d99b67f244dc498c7b"></a><!-- doxytag: member="sampMap.c::samp_setMapInMap" ref="f102490efe1b92d99b67f244dc498c7b" args="(Map map1, char *key, Map map2)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setMapInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map2</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Map in a Map (append). +<p> +SAMP_SETMAPINMAP -- Set a Map in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map1</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>map2</em> </td><td>handle to Map object to set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="samp_8c_source.html#l00942">samp_getOKMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b9b2157de89369eb5cd95bfe804eb89a"></a><!-- doxytag: member="sampMap.c::samp_setStringInMap" ref="b9b2157de89369eb5cd95bfe804eb89a" args="(Map map, char *key, char *value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setStringInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a string in a Map (append). +<p> +SAMP_SETSTRINGINMAP -- Set a string in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Map value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="samp_8c_source.html#l00942">samp_getOKMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampMethods_8c.html b/vendor/voclient/libsamp/doc/html/sampMethods_8c.html new file mode 100644 index 00000000..ad9c8b7a --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampMethods_8c.html @@ -0,0 +1,294 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampMethods.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampMethods.c File Reference</h1>SAMP methods implemented by a callable client. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include <time.h></code><br> +<code>#include <ctype.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee07de873e18503ecd72f89d07e4c628"></a><!-- doxytag: member="sampMethods.c::METH_DBG" ref="ee07de873e18503ecd72f89d07e4c628" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>METH_DBG</b> (getenv("METH_DBG")!=NULL||access("/tmp/METH_DBG",F_OK)==0)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae51f9fc173a9cba2485f91d93fe8428"></a><!-- doxytag: member="sampMethods.c::OK_Map" ref="ae51f9fc173a9cba2485f91d93fe8428" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>OK_Map</b> samp_getOKMap()</td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMethods_8c.html#59f85e0fce4c9ae7121c98e137d3f743">samp_receiveCall</a> (void *data)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">test.echo method <a href="#59f85e0fce4c9ae7121c98e137d3f743"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMethods_8c.html#03be7cc9e154a6ccdd499286df640936">samp_receiveNotification</a> (void *data)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">receiveNotification () client method. <a href="#03be7cc9e154a6ccdd499286df640936"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMethods_8c.html#754b50ad59145c7fd1e4c8f4277f11e4">samp_receiveResponse</a> (void *data)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">receiveResponse () client method. <a href="#754b50ad59145c7fd1e4c8f4277f11e4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMethods_8c.html#82fec51207e326e6373e174bb6855634">samp_setHandlerReply</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="structSamp.html">Samp</a> Handler reply map. <a href="#82fec51207e326e6373e174bb6855634"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMethods_8c.html#eebed5000d39977556e0bc330a020915">samp_getHandlerReply</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structSamp.html">Samp</a> Handler reply map. <a href="#eebed5000d39977556e0bc330a020915"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMethods_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">nullMap</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMethods_8c.html#a2106c7fe3a5747178c046238fbd5d55">nullList</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12abcaf1a16a8a7c2ef6358cdbf4d705"></a><!-- doxytag: member="sampMethods.c::sampP" ref="12abcaf1a16a8a7c2ef6358cdbf4d705" args="" --> +<a class="el" href="structSamp.html">Samp</a> * </td><td class="memItemRight" valign="bottom"><b>sampP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMethods_8c.html#b04b61ee02d86e15b02b861699ae7424">sampH</a></td></tr> + +</table> +<hr><h2>Detailed Description</h2> +SAMP methods implemented by a callable client. +<p> +SAMPMETHODS.C -- SAMP methods implemented by a callable client.<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/09 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="eebed5000d39977556e0bc330a020915"></a><!-- doxytag: member="sampMethods.c::samp_getHandlerReply" ref="eebed5000d39977556e0bc330a020915" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getHandlerReply </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the <a class="el" href="structSamp.html">Samp</a> Handler reply map. +<p> +SAMP_GETHANDLERREPLY -- Get the <a class="el" href="structSamp.html">Samp</a> Handler reply map.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Map handle for reply map </dd></dl> + +<p>References <a class="el" href="samp_8c_source.html#l00053">nullMap</a>, and <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>.</p> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, and <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="59f85e0fce4c9ae7121c98e137d3f743"></a><!-- doxytag: member="sampMethods.c::samp_receiveCall" ref="59f85e0fce4c9ae7121c98e137d3f743" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_receiveCall </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +test.echo method +<p> +receiveCall () client method.<p> +SAMP_TESTECHO -- test.echo method<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno</dd></dl> +SAMP_RECEIVECALL -- receiveCall() client method.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampMethods_8c_source.html#l00252">samp_getHandlerReply()</a>, <a class="el" href="sampHandlers_8c_source.html#l00159">samp_getSampHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampClient_8c_source.html#l00278">samp_Reply()</a>, <a class="el" href="samp_8c_source.html#l00051">sampH</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="03be7cc9e154a6ccdd499286df640936"></a><!-- doxytag: member="sampMethods.c::samp_receiveNotification" ref="03be7cc9e154a6ccdd499286df640936" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_receiveNotification </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +receiveNotification () client method. +<p> +SAMP_RECEIVENOTIFICATION -- receiveNotification() client method.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampMethods_8c_source.html#l00252">samp_getHandlerReply()</a>, <a class="el" href="sampHandlers_8c_source.html#l00159">samp_getSampHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="754b50ad59145c7fd1e4c8f4277f11e4"></a><!-- doxytag: member="sampMethods.c::samp_receiveResponse" ref="754b50ad59145c7fd1e4c8f4277f11e4" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_receiveResponse </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +receiveResponse () client method. +<p> +SAMP_RECEIVERESPONSE -- receiveResponse() client method.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno </dd></dl> + +<p>References <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>, <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, and <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>.</p> + +</div> +</div><p> +<a class="anchor" name="82fec51207e326e6373e174bb6855634"></a><!-- doxytag: member="sampMethods.c::samp_setHandlerReply" ref="82fec51207e326e6373e174bb6855634" args="(Map resp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setHandlerReply </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>resp</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the <a class="el" href="structSamp.html">Samp</a> Handler reply map. +<p> +SAMP_SETHANDLERREPLY -- Set the <a class="el" href="structSamp.html">Samp</a> Handler reply map.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>resp</em> </td><td>response map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>.</p> + +</div> +</div><p> +<hr><h2>Variable Documentation</h2> +<a class="anchor" name="a2106c7fe3a5747178c046238fbd5d55"></a><!-- doxytag: member="sampMethods.c::nullList" ref="a2106c7fe3a5747178c046238fbd5d55" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="el" href="sampMethods_8c.html#a2106c7fe3a5747178c046238fbd5d55">nullList</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_OK Map struct +<p>Referenced by <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="68bf22a5b3f2531242f5c6d6ecf2ea1e"></a><!-- doxytag: member="sampMethods.c::nullMap" ref="68bf22a5b3f2531242f5c6d6ecf2ea1e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="el" href="sampMethods_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">nullMap</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP handle +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00252">samp_getHandlerReply()</a>, <a class="el" href="samp_8c_source.html#l00942">samp_getOKMap()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b04b61ee02d86e15b02b861699ae7424"></a><!-- doxytag: member="sampMethods.c::sampH" ref="b04b61ee02d86e15b02b861699ae7424" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t <a class="el" href="sampMethods_8c.html#b04b61ee02d86e15b02b861699ae7424">sampH</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP struct pointer +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>, <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampMsg_8c.html b/vendor/voclient/libsamp/doc/html/sampMsg_8c.html new file mode 100644 index 00000000..98ae88ab --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampMsg_8c.html @@ -0,0 +1,163 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampMsg.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampMsg.c File Reference</h1>(Internal) Interface to Message objects. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMsg_8c.html#d6dfdab2715ea070713515754dd499dd">samp_newMsg</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Msg object. <a href="#d6dfdab2715ea070713515754dd499dd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMsg_8c.html#adf2979a5fad0c9a855740330b7fd9ce">samp_freeMsg</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given Msg object. <a href="#adf2979a5fad0c9a855740330b7fd9ce"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34c9e29fa57216f19a70764df8e5826b"></a><!-- doxytag: member="sampMsg.c::samp_msgMType" ref="34c9e29fa57216f19a70764df8e5826b" args="(Msg msg, String mtype)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_msgMType</b> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b6887edd7c0924460bcee0282544c82f"></a><!-- doxytag: member="sampMsg.c::samp_msgTag" ref="b6887edd7c0924460bcee0282544c82f" args="()" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_msgTag</b> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampMsg_8c.html#281c8f7f8b21a74704dd200d5aaed481">samp_msgParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to the Msg. <a href="#281c8f7f8b21a74704dd200d5aaed481"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +(Internal) Interface to Message objects. +<p> +SAMPMSG.C -- (Internal) Interface to Message objects.<p> +msg = samp_newMsg () samp_msgMType (Msg msg, String mtype) samp_msgParam (Msg msg, Param param) samp_msgTag () samp_freeMsg (Msg msg)<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/11 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="adf2979a5fad0c9a855740330b7fd9ce"></a><!-- doxytag: member="sampMsg.c::samp_freeMsg" ref="adf2979a5fad0c9a855740330b7fd9ce" args="(Msg msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeMsg </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given Msg object. +<p> +SAMP_FREEMSG -- Free the given Msg object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Msg object to free </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="281c8f7f8b21a74704dd200d5aaed481"></a><!-- doxytag: member="sampMsg.c::samp_msgParam" ref="281c8f7f8b21a74704dd200d5aaed481" args="(Msg msg, Param param)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_msgParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td> + <td class="paramname"> <em>param</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a parameter to the Msg. +<p> +SAMP_MSGPARAM -- Add a parameter to the Msg.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>parameter map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d6dfdab2715ea070713515754dd499dd"></a><!-- doxytag: member="sampMsg.c::samp_newMsg" ref="d6dfdab2715ea070713515754dd499dd" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> samp_newMsg </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new Msg object. +<p> +SAMP_NEWMSG -- Create a new Msg object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Msg </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampParam_8c.html b/vendor/voclient/libsamp/doc/html/sampParam_8c.html new file mode 100644 index 00000000..279262d1 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampParam_8c.html @@ -0,0 +1,392 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampParam.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampParam.c File Reference</h1>(Internal) Interface to Param objects. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampParam_8c.html#8750d9db641826f700973dae3fcdc920">samp_newParam</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Param object. <a href="#8750d9db641826f700973dae3fcdc920"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampParam_8c.html#5a6fbf3ac37164268afae80c35666c5e">samp_freeParam</a> (<a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given Msg object. <a href="#5a6fbf3ac37164268afae80c35666c5e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sampParam_8c.html#d8c5669be313874fef1c484643683f49">samp_paramInit</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of Params. <a href="#d8c5669be313874fef1c484643683f49"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62c2d0b887252730fd6f7bdaa7211403"></a><!-- doxytag: member="sampParam.c::samp_addStringParam" ref="62c2d0b887252730fd6f7bdaa7211403" args="(Msg msg, char *keyw, String val)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_addStringParam</b> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> val)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampParam_8c.html#e3e90c84dd6b1a08d8af18ca9e168b37">samp_addMapParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to the Param. <a href="#e3e90c84dd6b1a08d8af18ca9e168b37"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampParam_8c.html#24f72c4ed033ed2f219b420e491b3c0f">samp_addListParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to the Param. <a href="#24f72c4ed033ed2f219b420e491b3c0f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampParam_8c.html#6897da75444209fc1819042bde906aa6">samp_addIntParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, int val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <SAMP int>=""> parameter to the Param. <a href="#6897da75444209fc1819042bde906aa6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampParam_8c.html#d297770f4ab1338697d69b2705d6c1d9">samp_addFloatParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, float val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <SAMP float>=""> parameter to the Param. <a href="#d297770f4ab1338697d69b2705d6c1d9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampParam_8c.html#7680995e5d4f26ea3d91bf72c9c72e51">samp_paramLen</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of Params. <a href="#7680995e5d4f26ea3d91bf72c9c72e51"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +(Internal) Interface to Param objects. +<p> +SAMPPARAM.C -- (Internal) Interface to Param objects.<p> +param = samp_newParam () samp_freeParam (Param param)<p> +param = samp_paramInit (Msg msg); samp_addStringParam (Msg msg, char *keyw, String val) samp_addListParam (Msg msg, char *keyw, List val) samp_addMapParam (Msg msg, char *keyw, Map val) N = samp_paramLen (Msg msg)<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/11 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="d297770f4ab1338697d69b2705d6c1d9"></a><!-- doxytag: member="sampParam.c::samp_addFloatParam" ref="d297770f4ab1338697d69b2705d6c1d9" args="(Msg msg, char *keyw, float val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addFloatParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a <SAMP float>=""> parameter to the Param. +<p> +SAMP_ADDFLOATPARAM -- Add a <SAMP float>=""> parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>floating point value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="sampParam_8c_source.html#l00073">samp_paramInit()</a>.</p> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6897da75444209fc1819042bde906aa6"></a><!-- doxytag: member="sampParam.c::samp_addIntParam" ref="6897da75444209fc1819042bde906aa6" args="(Msg msg, char *keyw, int val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addIntParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a <SAMP int>=""> parameter to the Param. +<p> +SAMP_ADDINTPARAM -- Add a <SAMP int>=""> parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>integer value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="sampParam_8c_source.html#l00073">samp_paramInit()</a>.</p> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="24f72c4ed033ed2f219b420e491b3c0f"></a><!-- doxytag: member="sampParam.c::samp_addListParam" ref="24f72c4ed033ed2f219b420e491b3c0f" args="(Msg msg, char *keyw, List val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addListParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a parameter to the Param. +<p> +SAMP_ADDLISTPARAM -- Add a List parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>value list </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="sampParam_8c_source.html#l00073">samp_paramInit()</a>.</p> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e3e90c84dd6b1a08d8af18ca9e168b37"></a><!-- doxytag: member="sampParam.c::samp_addMapParam" ref="e3e90c84dd6b1a08d8af18ca9e168b37" args="(Msg msg, char *keyw, Map val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addMapParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a parameter to the Param. +<p> +SAMP_ADDMAPPARAM -- Add a Map parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>value map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="sampParam_8c_source.html#l00073">samp_paramInit()</a>.</p> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5a6fbf3ac37164268afae80c35666c5e"></a><!-- doxytag: member="sampParam.c::samp_freeParam" ref="5a6fbf3ac37164268afae80c35666c5e" args="(Param param)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td> + <td class="paramname"> <em>param</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given Msg object. +<p> +SAMP_FREEPARAM -- Free the given Param object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>Param object to free </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8750d9db641826f700973dae3fcdc920"></a><!-- doxytag: member="sampParam.c::samp_newParam" ref="8750d9db641826f700973dae3fcdc920" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> samp_newParam </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new Param object. +<p> +SAMP_NEWPARAM -- Create a new Param object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Param </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d8c5669be313874fef1c484643683f49"></a><!-- doxytag: member="sampParam.c::samp_paramInit" ref="d8c5669be313874fef1c484643683f49" args="(Msg msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> samp_paramInit </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get number of Params. +<p> +SAMP_PARAMINIT -- Get number of Params.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampParam_8c_source.html#l00181">samp_addFloatParam()</a>, <a class="el" href="sampParam_8c_source.html#l00154">samp_addIntParam()</a>, <a class="el" href="sampParam_8c_source.html#l00135">samp_addListParam()</a>, and <a class="el" href="sampParam_8c_source.html#l00116">samp_addMapParam()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="7680995e5d4f26ea3d91bf72c9c72e51"></a><!-- doxytag: member="sampParam.c::samp_paramLen" ref="7680995e5d4f26ea3d91bf72c9c72e51" args="(Msg msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramLen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get number of Params. +<p> +SAMP_PARAMLEN -- Get number of Params.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/sampUtil_8c.html b/vendor/voclient/libsamp/doc/html/sampUtil_8c.html new file mode 100644 index 00000000..66601248 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/sampUtil_8c.html @@ -0,0 +1,278 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: sampUtil.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>sampUtil.c File Reference</h1>Utility methods to convert struct pointers to user handles. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include <time.h></code><br> +<code>#include <ctype.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="23ed8e629c0a28eab14f92c888c8d7ef"></a><!-- doxytag: member="sampUtil.c::MAX_HANDLES" ref="23ed8e629c0a28eab14f92c888c8d7ef" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_HANDLES</b> 128</td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d0aef2f09b9cce38d4ea8024831c6e5"></a><!-- doxytag: member="sampUtil.c::samp_P2H" ref="4d0aef2f09b9cce38d4ea8024831c6e5" args="(void *ptr)" --> +handle_t </td><td class="memItemRight" valign="bottom"><b>samp_P2H</b> (void *ptr)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="909310a995650c224515c9ca0a3ef582"></a><!-- doxytag: member="sampUtil.c::samp_H2P" ref="909310a995650c224515c9ca0a3ef582" args="(handle_t handle)" --> +void * </td><td class="memItemRight" valign="bottom"><b>samp_H2P</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="711aa545f55e9307f662062deefd5903"></a><!-- doxytag: member="sampUtil.c::samp_newHandle" ref="711aa545f55e9307f662062deefd5903" args="(void *ptr)" --> +handle_t </td><td class="memItemRight" valign="bottom"><b>samp_newHandle</b> (void *ptr)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f02a7c646a9ed56e545d8bf33434c207"></a><!-- doxytag: member="sampUtil.c::samp_freeHandle" ref="f02a7c646a9ed56e545d8bf33434c207" args="(handle_t handle)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_freeHandle</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampUtil_8c.html#aed9017996a8361f8abf5b5c6a954414">samp_app2id</a> (handle_t handle, char *appName)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an application name to a public-ID. <a href="#aed9017996a8361f8abf5b5c6a954414"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampUtil_8c.html#a75368198ec8cd2fff6ad304806862b8">samp_id2app</a> (handle_t handle, char *pubId)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a public-ID to the application name. <a href="#a75368198ec8cd2fff6ad304806862b8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sampUtil_8c.html#0fb77074a0a38a4eab5dcf4e397dfef3">samp_serverPort</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a unique port number for the server. <a href="#0fb77074a0a38a4eab5dcf4e397dfef3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sampUtil_8c.html#c7538c339e59556bfd0a87973ad61a43">samp_printMetadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the metadata for the application. <a href="#c7538c339e59556bfd0a87973ad61a43"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sampUtil_8c.html#ed777ec70a7f11254f04a2ee11be391b">samp_getMetadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metadata item for the application. <a href="#ed777ec70a7f11254f04a2ee11be391b"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef3481f5da99207929f0c0c5ee4c328b"></a><!-- doxytag: member="sampUtil.c::numHandles" ref="ef3481f5da99207929f0c0c5ee4c328b" args="" --> +int </td><td class="memItemRight" valign="bottom"><b>numHandles</b> = 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c3d68c02a974f30f9150b4556e5e00d4"></a><!-- doxytag: member="sampUtil.c::sampHandles" ref="c3d68c02a974f30f9150b4556e5e00d4" args="[MAX_HANDLES]" --> +long </td><td class="memItemRight" valign="bottom"><b>sampHandles</b> [MAX_HANDLES]</td></tr> + +</table> +<hr><h2>Detailed Description</h2> +Utility methods to convert struct pointers to user handles. +<p> +SAMPUTIL.C -- Utility methods to convert struct pointers to user handles.<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/09 </dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="aed9017996a8361f8abf5b5c6a954414"></a><!-- doxytag: member="sampUtil.c::samp_app2id" ref="aed9017996a8361f8abf5b5c6a954414" args="(handle_t handle, char *appName)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_app2id </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>appName</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Convert an application name to a public-ID. +<p> +SAMP_APP2ID -- Convert an application name to a public-ID.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>appName</em> </td><td>name of registered application </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>public ID of application </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, and <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>.</p> + +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ed777ec70a7f11254f04a2ee11be391b"></a><!-- doxytag: member="sampUtil.c::samp_getMetadata" ref="ed777ec70a7f11254f04a2ee11be391b" args="(handle_t handle, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_getMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the metadata item for the application. +<p> +SAMP_GETMETADATA -- Get the metadata item for the application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00173">Samp::description</a>, <a class="el" href="samp_8h_source.html#l00106">appMD::docURL</a>, <a class="el" href="samp_8h_source.html#l00105">appMD::iconURL</a>, <a class="el" href="samp_8h_source.html#l00177">Samp::meta</a>, and <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a75368198ec8cd2fff6ad304806862b8"></a><!-- doxytag: member="sampUtil.c::samp_id2app" ref="a75368198ec8cd2fff6ad304806862b8" args="(handle_t handle, char *pubId)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* samp_id2app </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>pubId</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Convert a public-ID to the application name. +<p> +SAMP_ID2APP -- Convert a public-ID to the application name.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>pubId</em> </td><td>public ID of application </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>name of registered application </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, and <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c7538c339e59556bfd0a87973ad61a43"></a><!-- doxytag: member="sampUtil.c::samp_printMetadata" ref="c7538c339e59556bfd0a87973ad61a43" args="(handle_t handle, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_printMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Print the metadata for the application. +<p> +SAMP_PRINTMETADATA -- Print the metadata for the application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00173">Samp::description</a>, <a class="el" href="samp_8h_source.html#l00106">appMD::docURL</a>, <a class="el" href="samp_8h_source.html#l00105">appMD::iconURL</a>, <a class="el" href="samp_8h_source.html#l00177">Samp::meta</a>, and <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0fb77074a0a38a4eab5dcf4e397dfef3"></a><!-- doxytag: member="sampUtil.c::samp_serverPort" ref="0fb77074a0a38a4eab5dcf4e397dfef3" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_serverPort </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return a unique port number for the server. +<p> +SAMP_SERVERPORT -- Return a unique port number for the server.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>port number </dd></dl> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00448">samp_hubSetXmlrpcCallback()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/samp_8c.html b/vendor/voclient/libsamp/doc/html/samp_8c.html new file mode 100644 index 00000000..b709967e --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/samp_8c.html @@ -0,0 +1,1285 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: samp.c File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>samp.c File Reference</h1>Top-level interface to the SAMP library. +<a href="#_details">More...</a> +<p> +<code>#include <stdlib.h></code><br> +<code>#include <stdio.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include <string.h></code><br> +<code>#include <time.h></code><br> +<code>#include <signal.h></code><br> +<code>#include <ctype.h></code><br> +<code>#include "<a class="el" href="samp_8h_source.html">samp.h</a>"</code><br> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#92d198f56296c0b6a531ce4bce977185">SZ_CLIENT_LIST</a> 1024</td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#db03c60f2933ed9785bfb4457c359af2">sampInit</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> description)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the SAMP interface. <a href="#db03c60f2933ed9785bfb4457c359af2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#f861f637942c5f971bab824708581f82">sampClose</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the SAMP interface and free resources. <a href="#f861f637942c5f971bab824708581f82"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#6bfd947988e5dbc846af7f99bcd99ee7">sampDebug</a> (handle_t handle, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set interface debug level. <a href="#6bfd947988e5dbc846af7f99bcd99ee7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#e3a6e918b3fe22db2fe014da16f81aad">sampVerbose</a> (handle_t handle, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set interface debug level. <a href="#e3a6e918b3fe22db2fe014da16f81aad"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#1f6d544576fec785be1acfeaf3f2cf63">sampStartup</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Startup the SAMP interface to send/receive messages. <a href="#1f6d544576fec785be1acfeaf3f2cf63"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#d634392fbb12cf4e1b2eb05da34759c5">sampShutdown</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Shut down the active SAMP interface. <a href="#d634392fbb12cf4e1b2eb05da34759c5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#b2f9c71819e1956e1c29e969968f453c">samp_hubActive</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if the <a class="el" href="structHub.html">Hub</a> is active (i.e. connected). <a href="#b2f9c71819e1956e1c29e969968f453c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4ecb0b92b749647d1c3af8a1d11d5d4"></a><!-- doxytag: member="samp.c::samp_setOpt" ref="d4ecb0b92b749647d1c3af8a1d11d5d4" args="(handle_t handle, char *opt, int value)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_setOpt</b> (handle_t handle, char *opt, int value)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#1428f653b9502c6e6d540f873de2b24f">samp_Metadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> field, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a metadata field value for the application. <a href="#1428f653b9502c6e6d540f873de2b24f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#ed050606c5076a4a34eb8f0f982a25d4">samp_Subscribe</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, void *userFunc)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to a given mtype. <a href="#ed050606c5076a4a34eb8f0f982a25d4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#dc0e418fbaee507e661260c4480ecfcd">samp_Unsubscribe</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe to a given mtype. <a href="#dc0e418fbaee507e661260c4480ecfcd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#3e01437224c73b91e49c6428cb69735d">samp_setCallMode</a> (handle_t handle, int mode)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the default calling mode (synch or asynch). <a href="#3e01437224c73b91e49c6428cb69735d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#d636ae12dd05df43a077f91882a197ec">samp_setSyncMode</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the calling mode to use synchronous messaging. <a href="#d636ae12dd05df43a077f91882a197ec"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#9b2292b819e590b1f7c63bbdfaa09e31">samp_setASyncMode</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the calling mode to use asynchronous messaging. <a href="#9b2292b819e590b1f7c63bbdfaa09e31"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#7bfbc2e767fe234f83c13b8316a09ecd">samp_setNotifyMode</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the calling mode to use notification messaging. <a href="#7bfbc2e767fe234f83c13b8316a09ecd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#01721eabf3e664bae3bea0c2b72268e2">samp_setMsgMode</a> (handle_t handle, int mode)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the message pattern to the specified mode. <a href="#01721eabf3e664bae3bea0c2b72268e2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#b6b49029386c3efd0520daa93a4ab3eb">samp_setCallByRef</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Have interface call user handlers by reference. <a href="#b6b49029386c3efd0520daa93a4ab3eb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#a3c0bdb4c512357dbc53b0ad7a7d5b01">samp_setReplyCallback</a> (handle_t handle, int *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func). <a href="#a3c0bdb4c512357dbc53b0ad7a7d5b01"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#3db66f28546459327665f8491ea97f4d">samp_setResponseCallback</a> (handle_t handle, int *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Response callback. samp_setResponseCallback (handle_t handle, int *func). <a href="#3db66f28546459327665f8491ea97f4d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#114bf9fb0d3e6eabd8bb93f3c87f5233">samp_defaultReplyHandler</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The interface's default Reply handler. <a href="#114bf9fb0d3e6eabd8bb93f3c87f5233"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd506ac12f25f64ada7c9859af3f857f"></a><!-- doxytag: member="samp.c::samp_deaultfResponseHandler" ref="cd506ac12f25f64ada7c9859af3f857f" args="(handle_t handle)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_deaultfResponseHandler</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#985afa0baeb135c9ee72d09394314ff1">samp_replyStatus</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reply with the status of the last message sent. <a href="#985afa0baeb135c9ee72d09394314ff1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#c057d32437a96a527c63f938757099af">samp_setTimeout</a> (handle_t handle, int timeout)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the message timeout value (in seconds). <a href="#c057d32437a96a527c63f938757099af"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7731da5bec549e7554d1bdc11b13eaf6"></a><!-- doxytag: member="samp.c::samp_setAppName" ref="7731da5bec549e7554d1bdc11b13eaf6" args="(handle_t handle, String name)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_setAppName</b> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#0f50f8dbae701aa6b19912fc99f6475a">samp_setAppVersion</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> version)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the application name string. <a href="#0f50f8dbae701aa6b19912fc99f6475a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#ff4d125fc9594be25984989fad2fd3c8">samp_mapClients</a> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#8a2111bbe4c88cef635e3bf67e899563">samp_addClient</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> id)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#1e494e73abe2ddfd946fb39e84da42a9">samp_listClients</a> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="61e09b672e5f610dae0f242ea8256328"></a><!-- doxytag: member="samp.c::samp_getClients" ref="61e09b672e5f610dae0f242ea8256328" args="(handle_t handle)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getClients</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#e30e492f306a40f853a454faf60ab479">samp_removeClient</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> id)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#f299ea13607279f60f16b8639a00658f">samp_getOKMap</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#6bb8b1f5c6268ad8c7f165733d4af86d">samp_getNullMap</a> ()</td></tr> + +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12abcaf1a16a8a7c2ef6358cdbf4d705"></a><!-- doxytag: member="samp.c::sampP" ref="12abcaf1a16a8a7c2ef6358cdbf4d705" args="" --> +<a class="el" href="structSamp.html">Samp</a> * </td><td class="memItemRight" valign="bottom"><b>sampP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#b04b61ee02d86e15b02b861699ae7424">sampH</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">nullMap</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#a68efe925f0d8f29fa203c0f3747a6e2">OK_Map</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#a2106c7fe3a5747178c046238fbd5d55">nullList</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structHub.html">Hub</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#037f00cb1101b007b4bf45e8bee1bd3e">numHubs</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8c.html#dbf72aff0293f6556c1c6a2f4a62e2b9">hubHandles</a> [MAX_HUBS]</td></tr> + +</table> +<hr><h2>Detailed Description</h2> +Top-level interface to the SAMP library. +<p> +SAMP.C -- Top-level interface to the SAMP library.<p> +samp = sampInit (appName, descr) sampClose (samp)<p> +stat = sampStartup (samp) sampShutdown (samp)<p> +samp_Metadata (samp, field, value) samp_Subscribe (samp, mtype, handler) samp_Unsubscribe (samp, mtype)<p> +samp_setReplyCallback (samp, func) samp_setResponseCallback (samp, func) stat = samp_replyStatus (samp)<p> +Utility Methods: samp_setSyncMode (samp) // Default samp_setASyncMode (samp) samp_setNotifyMode (samp) samp_setCallByRef (samp)<p> +samp_setTimeout (samp, timeout) samp_setAppNmae (samp, version) samp_setAppVersion (samp, name)<p> +samp_mapClients (handle_t handle) samp_addClient (handle_t handle, String name, String id) samp_removeClient (handle_t handle, String id)<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike Fitzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/09 </dd></dl> +<hr><h2>Define Documentation</h2> +<a class="anchor" name="92d198f56296c0b6a531ce4bce977185"></a><!-- doxytag: member="samp.c::SZ_CLIENT_LIST" ref="92d198f56296c0b6a531ce4bce977185" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define SZ_CLIENT_LIST 1024 </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_GETCLIENTS -- Get a list of clients as a character string as the PubID and Name separated by a space, one client per line. +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="8a2111bbe4c88cef635e3bf67e899563"></a><!-- doxytag: member="samp.c::samp_addClient" ref="8a2111bbe4c88cef635e3bf67e899563" args="(handle_t handle, String name, String id)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_addClient </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>id</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_ADDCLIENT -- Add a newly registered client to the list of known apps so we can do the public-private name translation. +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="114bf9fb0d3e6eabd8bb93f3c87f5233"></a><!-- doxytag: member="samp.c::samp_defaultReplyHandler" ref="114bf9fb0d3e6eabd8bb93f3c87f5233" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_defaultReplyHandler </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The interface's default Reply handler. +<p> +SAMP_DEFAULTREPLYHANDLER -- The interface's default Reply handler.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="6bb8b1f5c6268ad8c7f165733d4af86d"></a><!-- doxytag: member="samp.c::samp_getNullMap" ref="6bb8b1f5c6268ad8c7f165733d4af86d" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getNullMap </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_GETNULLMAP -- Generate a 'Null' map we can return to the <a class="el" href="structHub.html">Hub</a>. +<p>References <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f299ea13607279f60f16b8639a00658f"></a><!-- doxytag: member="samp.c::samp_getOKMap" ref="f299ea13607279f60f16b8639a00658f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getOKMap </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_GETOKMAP -- Generate an 'OK' map we can return to the <a class="el" href="structHub.html">Hub</a>. +<p>References <a class="el" href="samp_8c_source.html#l00053">nullMap</a>, <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>, <a class="el" href="sampMap_8c_source.html#l00153">samp_setMapInMap()</a>, and <a class="el" href="sampMap_8c_source.html#l00135">samp_setStringInMap()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b2f9c71819e1956e1c29e969968f453c"></a><!-- doxytag: member="samp.c::samp_hubActive" ref="b2f9c71819e1956e1c29e969968f453c" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_hubActive </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Determine if the <a class="el" href="structHub.html">Hub</a> is active (i.e. connected). +<p> +SAMP_HUBACTIVE -- Determine if the <a class="el" href="structHub.html">Hub</a> is active (i.e. connected).<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00197">Samp::active</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1e494e73abe2ddfd946fb39e84da42a9"></a><!-- doxytag: member="samp.c::samp_listClients" ref="1e494e73abe2ddfd946fb39e84da42a9" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_listClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_LISTCLIENTS -- List the available clients to stdout. +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, and <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ff4d125fc9594be25984989fad2fd3c8"></a><!-- doxytag: member="samp.c::samp_mapClients" ref="ff4d125fc9594be25984989fad2fd3c8" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_mapClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_MAPCLIENTS -- Map the public-ids of registered clients to the appName. +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="sampList_8c_source.html#l00063">samp_freeList()</a>, <a class="el" href="sampCommands_8c_source.html#l00188">samp_GetMetadata()</a>, <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, <a class="el" href="sampList_8c_source.html#l00192">samp_getStringFromList()</a>, <a class="el" href="sampList_8c_source.html#l00080">samp_listLen()</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1428f653b9502c6e6d540f873de2b24f"></a><!-- doxytag: member="samp.c::samp_Metadata" ref="1428f653b9502c6e6d540f873de2b24f" args="(handle_t handle, String field, String value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_Metadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a metadata field value for the application. +<p> +SAMP_METADATA -- Set a metadata field for the application. This will be sent to the <a class="el" href="structHub.html">Hub</a> later in a declareMetadata() call.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>field</em> </td><td>metadata field to set (name, author, etc) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>samp</em> </td><td>value of field </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00111">appMD::aKey</a>, <a class="el" href="samp_8h_source.html#l00172">Samp::appVer</a>, <a class="el" href="samp_8h_source.html#l00144">Hub::appVer</a>, <a class="el" href="samp_8h_source.html#l00112">appMD::aVal</a>, <a class="el" href="samp_8h_source.html#l00104">appMD::desc</a>, <a class="el" href="samp_8h_source.html#l00145">Hub::description</a>, <a class="el" href="samp_8h_source.html#l00173">Samp::description</a>, <a class="el" href="samp_8h_source.html#l00106">appMD::docURL</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00105">appMD::iconURL</a>, <a class="el" href="samp_8h_source.html#l00147">Hub::meta</a>, <a class="el" href="samp_8h_source.html#l00177">Samp::meta</a>, <a class="el" href="samp_8h_source.html#l00110">appMD::nkeys</a>, and <a class="el" href="sampLog_8c_source.html#l00091">sampTrace()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e30e492f306a40f853a454faf60ab479"></a><!-- doxytag: member="samp.c::samp_removeClient" ref="e30e492f306a40f853a454faf60ab479" args="(handle_t handle, String id)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_removeClient </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>id</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_REMOVECLIENT -- Remove a registered client from the list of known apps that do the public-private name translation. +<p>References <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, and <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="985afa0baeb135c9ee72d09394314ff1"></a><!-- doxytag: member="samp.c::samp_replyStatus" ref="985afa0baeb135c9ee72d09394314ff1" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_replyStatus </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reply with the status of the last message sent. +<p> +SAMP_REPLYSTATUS -- Reply with the status of the last message sent.<p> +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<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>samp</em> </td><td>samp struct ptr </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>message status </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0f50f8dbae701aa6b19912fc99f6475a"></a><!-- doxytag: member="samp.c::samp_setAppVersion" ref="0f50f8dbae701aa6b19912fc99f6475a" args="(handle_t handle, String version)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setAppVersion </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>version</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the application name string. +<p> +Set the application version string.<p> +SAMP_SETAPPNAME -- Set the application name string.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>application name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing</dd></dl> +SAMP_SETAPPVERSION -- Set the application version string.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>application version </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00144">Hub::appVer</a>, <a class="el" href="samp_8h_source.html#l00172">Samp::appVer</a>, and <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>.</p> + +</div> +</div><p> +<a class="anchor" name="9b2292b819e590b1f7c63bbdfaa09e31"></a><!-- doxytag: member="samp.c::samp_setASyncMode" ref="9b2292b819e590b1f7c63bbdfaa09e31" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setASyncMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the calling mode to use asynchronous messaging. +<p> +SAMP_SETASYNCMODE -- Set the calling mode to use asynchronous messaging.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b6b49029386c3efd0520daa93a4ab3eb"></a><!-- doxytag: member="samp.c::samp_setCallByRef" ref="b6b49029386c3efd0520daa93a4ab3eb" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setCallByRef </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Have interface call user handlers by reference. +<p> +SAMP_SETCALLBYREF -- Have interface call user handlers by reference.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00200">Samp::handlerMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3e01437224c73b91e49c6428cb69735d"></a><!-- doxytag: member="samp.c::samp_setCallMode" ref="3e01437224c73b91e49c6428cb69735d" args="(handle_t handle, int mode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setCallMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>mode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the default calling mode (synch or asynch). +<p> +SAMP_SETCALLMODE -- Set the default calling mode (synch or asynch)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>call mode (synch or asynch) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="01721eabf3e664bae3bea0c2b72268e2"></a><!-- doxytag: member="samp.c::samp_setMsgMode" ref="01721eabf3e664bae3bea0c2b72268e2" args="(handle_t handle, int mode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setMsgMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>mode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the message pattern to the specified mode. +<p> +SAMP_SETMSGMODE -- Set the message pattern to the specified mode.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>message mode </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="7bfbc2e767fe234f83c13b8316a09ecd"></a><!-- doxytag: member="samp.c::samp_setNotifyMode" ref="7bfbc2e767fe234f83c13b8316a09ecd" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setNotifyMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the calling mode to use notification messaging. +<p> +SAMP_SETNOTIFYMODE -- Set the calling mode to use notification messaging.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a3c0bdb4c512357dbc53b0ad7a7d5b01"></a><!-- doxytag: member="samp.c::samp_setReplyCallback" ref="a3c0bdb4c512357dbc53b0ad7a7d5b01" args="(handle_t handle, int *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setReplyCallback </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func). +<p> +SAMP_SETREPLYCALLBACK -- Set the Reply callback.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback for Reply message </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3db66f28546459327665f8491ea97f4d"></a><!-- doxytag: member="samp.c::samp_setResponseCallback" ref="3db66f28546459327665f8491ea97f4d" args="(handle_t handle, int *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setResponseCallback </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the Response callback. samp_setResponseCallback (handle_t handle, int *func). +<p> +SAMP_SETRESPONSECALLBACK -- Set the Response callback.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback for message response </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="d636ae12dd05df43a077f91882a197ec"></a><!-- doxytag: member="samp.c::samp_setSyncMode" ref="d636ae12dd05df43a077f91882a197ec" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setSyncMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the calling mode to use synchronous messaging. +<p> +SAMP_SETSYNCMODE -- Set the calling mode to use synchronous messaging.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c057d32437a96a527c63f938757099af"></a><!-- doxytag: member="samp.c::samp_setTimeout" ref="c057d32437a96a527c63f938757099af" args="(handle_t handle, int timeout)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setTimeout </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>timeout</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the message timeout value (in seconds). +<p> +SAMP_SETTIMEOUT -- Set the message timeout value (in seconds).<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>application name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, and <a class="el" href="samp_8h_source.html#l00159">Hub::timeout</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ed050606c5076a4a34eb8f0f982a25d4"></a><!-- doxytag: member="samp.c::samp_Subscribe" ref="ed050606c5076a4a34eb8f0f982a25d4" args="(handle_t handle, String mtype, void *userFunc)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_Subscribe </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Subscribe to a given mtype. +<p> +SAMP_SUBSCRIBE -- Subscribe to a given mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, <a class="el" href="sampHandlers_8c_source.html#l00159">samp_getSampHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00090">samp_setSampHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00046">samp_setUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="dc0e418fbaee507e661260c4480ecfcd"></a><!-- doxytag: member="samp.c::samp_Unsubscribe" ref="dc0e418fbaee507e661260c4480ecfcd" args="(handle_t handle, String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_Unsubscribe </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Unsubscribe to a given mtype. +<p> +SAMP_UNSUBSCRIBE -- Unsubscribe to a given mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00185">Samp::nsubs</a>, <a class="el" href="sampCommands_8c_source.html#l00227">samp_DeclareSubscriptions()</a>, <a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">Subs::sampFunc</a>, and <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs::userFunc</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f861f637942c5f971bab824708581f82"></a><!-- doxytag: member="samp.c::sampClose" ref="f861f637942c5f971bab824708581f82" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sampClose </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Close the SAMP interface and free resources. +<p> +SAMP_CLOSE -- Close the SAMP interface.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00194">Samp::hubHandle</a>, <a class="el" href="sampUtil_8c_source.html#l00072">samp_freeHandle()</a>, <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, <a class="el" href="sampLog_8c_source.html#l00091">sampTrace()</a>, and <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6bfd947988e5dbc846af7f99bcd99ee7"></a><!-- doxytag: member="samp.c::sampDebug" ref="6bfd947988e5dbc846af7f99bcd99ee7" args="(handle_t handle, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sampDebug </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set interface debug level. +<p> +SAMPDEBUG -- Set interface debug level.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>debug value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, and <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +</div> +</div><p> +<a class="anchor" name="db03c60f2933ed9785bfb4457c359af2"></a><!-- doxytag: member="samp.c::sampInit" ref="db03c60f2933ed9785bfb4457c359af2" args="(String appName, String description)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle sampInit </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>descr</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Initialize the SAMP interface. +<p> +SAMP_INIT -- Initialize the SAMP interface.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>appName</em> </td><td>application name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>description</em> </td><td>description of application </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>samp handle </dd></dl> + +<p>References <a class="el" href="samp_8c_source.html#l00055">nullList</a>, <a class="el" href="samp_8c_source.html#l00053">nullMap</a>, <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>, <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, <a class="el" href="sampUtil_8c_source.html#l00049">samp_newHandle()</a>, <a class="el" href="sampList_8c_source.html#l00047">samp_newList()</a>, <a class="el" href="sampMap_8c_source.html#l00051">samp_newMap()</a>, <a class="el" href="sampUtil_8c_source.html#l00194">samp_serverPort()</a>, <a class="el" href="sampMap_8c_source.html#l00153">samp_setMapInMap()</a>, <a class="el" href="sampMap_8c_source.html#l00135">samp_setStringInMap()</a>, <a class="el" href="samp_8c_source.html#l00051">sampH</a>, and <a class="el" href="sampLog_8c_source.html#l00091">sampTrace()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d634392fbb12cf4e1b2eb05da34759c5"></a><!-- doxytag: member="samp.c::sampShutdown" ref="d634392fbb12cf4e1b2eb05da34759c5" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sampShutdown </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Shut down the active SAMP interface. +<p> +SAMP_SHUTDOWN -- Shut down the active SAMP interface.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00197">Samp::active</a>, <a class="el" href="samp_8h_source.html#l00194">Samp::hubHandle</a>, <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, <a class="el" href="samp_8h_source.html#l00179">Samp::svrThread</a>, and <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1f6d544576fec785be1acfeaf3f2cf63"></a><!-- doxytag: member="samp.c::sampStartup" ref="1f6d544576fec785be1acfeaf3f2cf63" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sampStartup </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Startup the SAMP interface to send/receive messages. +<p> +SAMP_STARTUP -- Startup the SAMP interface to send/receive messages.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00197">Samp::active</a>, <a class="el" href="samp_8h_source.html#l00187">Samp::clients</a>, <a class="el" href="samp_8h_source.html#l00193">Samp::hub</a>, <a class="el" href="samp_8h_source.html#l00194">Samp::hubHandle</a>, <a class="el" href="samp_8h_source.html#l00153">Hub::id</a>, <a class="el" href="samp_8h_source.html#l00198">Samp::mapClients</a>, <a class="el" href="samp_8h_source.html#l00134">Client::name</a>, <a class="el" href="samp_8h_source.html#l00188">Samp::nclients</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, <a class="el" href="samp_8h_source.html#l00205">Samp::trace</a>, and <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e3a6e918b3fe22db2fe014da16f81aad"></a><!-- doxytag: member="samp.c::sampVerbose" ref="e3a6e918b3fe22db2fe014da16f81aad" args="(handle_t handle, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sampVerbose </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set interface debug level. +<p> +SAMPVERBOSE -- Set interface verbose level.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>verbose value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +</div> +</div><p> +<hr><h2>Variable Documentation</h2> +<a class="anchor" name="d702b07240de0e0cf9e4b781a38317ad"></a><!-- doxytag: member="samp.c::hub" ref="d702b07240de0e0cf9e4b781a38317ad" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structHub.html">Hub</a>* <a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +empty List struct +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampCommands_8c_source.html#l00121">samp_DeclareMetadata()</a>, <a class="el" href="sampCommands_8c_source.html#l00227">samp_DeclareSubscriptions()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00188">samp_GetMetadata()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>, <a class="el" href="sampClient_8c_source.html#l00278">samp_Reply()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>, and <a class="el" href="sampCommands_8c_source.html#l00102">samp_UnRegister()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="dbf72aff0293f6556c1c6a2f4a62e2b9"></a><!-- doxytag: member="samp.c::hubHandles" ref="dbf72aff0293f6556c1c6a2f4a62e2b9" args="[MAX_HUBS]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">long <a class="el" href="sampHub_8c.html#86b0db44d25bc3079d8d9d75e01a0ecd">hubHandles</a>[MAX_HUBS] </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +No. of available hubs +</div> +</div><p> +<a class="anchor" name="a2106c7fe3a5747178c046238fbd5d55"></a><!-- doxytag: member="samp.c::nullList" ref="a2106c7fe3a5747178c046238fbd5d55" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="el" href="sampMethods_8c.html#a2106c7fe3a5747178c046238fbd5d55">nullList</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_OK Map struct +<p>Referenced by <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="68bf22a5b3f2531242f5c6d6ecf2ea1e"></a><!-- doxytag: member="samp.c::nullMap" ref="68bf22a5b3f2531242f5c6d6ecf2ea1e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="el" href="sampMethods_8c.html#68bf22a5b3f2531242f5c6d6ecf2ea1e">nullMap</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP handle +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00252">samp_getHandlerReply()</a>, <a class="el" href="samp_8c_source.html#l00942">samp_getOKMap()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="037f00cb1101b007b4bf45e8bee1bd3e"></a><!-- doxytag: member="samp.c::numHubs" ref="037f00cb1101b007b4bf45e8bee1bd3e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="sampHub_8c.html#037f00cb1101b007b4bf45e8bee1bd3e">numHubs</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +HUB connection +</div> +</div><p> +<a class="anchor" name="a68efe925f0d8f29fa203c0f3747a6e2"></a><!-- doxytag: member="samp.c::OK_Map" ref="a68efe925f0d8f29fa203c0f3747a6e2" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="el" href="samp_8c.html#a68efe925f0d8f29fa203c0f3747a6e2">OK_Map</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +empty Map struct +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00252">samp_getHandlerReply()</a>, <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>, <a class="el" href="sampMethods_8c_source.html#l00189">samp_receiveResponse()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b04b61ee02d86e15b02b861699ae7424"></a><!-- doxytag: member="samp.c::sampH" ref="b04b61ee02d86e15b02b861699ae7424" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t <a class="el" href="sampMethods_8c.html#b04b61ee02d86e15b02b861699ae7424">sampH</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP struct pointer +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>, <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/samp_8h.html b/vendor/voclient/libsamp/doc/html/samp_8h.html new file mode 100644 index 00000000..6b45624a --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/samp_8h.html @@ -0,0 +1,7080 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: samp.h File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>samp.h File Reference</h1>SAMP interface include file. +<a href="#_details">More...</a> +<p> +<code>#include <xmlrpc-c/base.h></code><br> +<code>#include <xmlrpc-c/client.h></code><br> +<code>#include <xmlrpc-c/server.h></code><br> +<code>#include <xmlrpc-c/server_abyss.h></code><br> +<code>#include <sys/types.h></code><br> +<code>#include <sys/stat.h></code><br> +<code>#include <unistd.h></code><br> +<code>#include "xrpc.h"</code><br> + +<p> +<a href="samp_8h_source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structappMD.html">appMD</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structSubs.html">Subs</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structClient.html">Client</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html">Hub</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html">Samp</a></td></tr> + +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6fc88d7dbc85d8d10379f58c910ce847"></a><!-- doxytag: member="samp.h::SZ_NAME" ref="6fc88d7dbc85d8d10379f58c910ce847" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_NAME</b> 256</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="32108415ff44b6f7537b9516f4a84be7"></a><!-- doxytag: member="samp.h::SZ_LINE" ref="32108415ff44b6f7537b9516f4a84be7" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_LINE</b> 256</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b6cc171ab550fcd6c34d92e010fcec3"></a><!-- doxytag: member="samp.h::SZ_SECRET" ref="7b6cc171ab550fcd6c34d92e010fcec3" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_SECRET</b> 64</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e01a6ceff717c54fca995bb444611a8"></a><!-- doxytag: member="samp.h::SZ_DESC" ref="3e01a6ceff717c54fca995bb444611a8" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_DESC</b> 8192</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="76e806c1a560659f0c849d427b64644a"></a><!-- doxytag: member="samp.h::SZ_URL" ref="76e806c1a560659f0c849d427b64644a" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_URL</b> 1024</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08329a2ecb12005e4089db9f336bde2a"></a><!-- doxytag: member="samp.h::SZ_CMD" ref="08329a2ecb12005e4089db9f336bde2a" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_CMD</b> 1024</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9c1311707cba8abcf575d13a527bc7b"></a><!-- doxytag: member="samp.h::SZ_SBUF" ref="c9c1311707cba8abcf575d13a527bc7b" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_SBUF</b> 65536</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="85a4ed506c27f31c98227e3683fb4394"></a><!-- doxytag: member="samp.h::SZ_RESSTR" ref="85a4ed506c27f31c98227e3683fb4394" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SZ_RESSTR</b> 1024</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3aaff003637cf49539879ebf960c7764"></a><!-- doxytag: member="samp.h::DEF_PORT" ref="3aaff003637cf49539879ebf960c7764" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>DEF_PORT</b> 9876</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="53712d3c054c04a805c2a09b075a898f"></a><!-- doxytag: member="samp.h::DEF_TIMEOUT" ref="53712d3c054c04a805c2a09b075a898f" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>DEF_TIMEOUT</b> "15"</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e5a1caf522da4cb934712482b0aed5b"></a><!-- doxytag: member="samp.h::MAX_SAMPS" ref="6e5a1caf522da4cb934712482b0aed5b" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_SAMPS</b> 16</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aeadc2a66777c5ca1a67bca1bc4648c5"></a><!-- doxytag: member="samp.h::MAX_HUBS" ref="aeadc2a66777c5ca1a67bca1bc4648c5" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_HUBS</b> 16</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0543164fb84dcec0c53c79671c473519"></a><!-- doxytag: member="samp.h::MAX_MDATTRS" ref="0543164fb84dcec0c53c79671c473519" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_MDATTRS</b> 32</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cecb71b936e9c443f548540fb7a54ff"></a><!-- doxytag: member="samp.h::MAX_SUBS" ref="4cecb71b936e9c443f548540fb7a54ff" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_SUBS</b> 256</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a8f91f93d75a07f0ae45077db45b3eb"></a><!-- doxytag: member="samp.h::MAX_CLIENTS" ref="0a8f91f93d75a07f0ae45077db45b3eb" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_CLIENTS</b> 32</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b94af9dcb0358f28d175d80eed98330"></a><!-- doxytag: member="samp.h::MAX_ROWS" ref="3b94af9dcb0358f28d175d80eed98330" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MAX_ROWS</b> 256</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b30409909356bb21b32a71574cc5ed4"></a><!-- doxytag: member="samp.h::SAMP_ERR" ref="2b30409909356bb21b32a71574cc5ed4" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_ERR</b> -1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2aa93712e218c9a6aa47726222da2ea8"></a><!-- doxytag: member="samp.h::SAMP_PENDING" ref="2aa93712e218c9a6aa47726222da2ea8" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_PENDING</b> 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="118ac4276b5889bad5aefbf8d976dc65"></a><!-- doxytag: member="samp.h::SAMP_OK" ref="118ac4276b5889bad5aefbf8d976dc65" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_OK</b> 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82bc77041ac33dba80902508e0e67cb1"></a><!-- doxytag: member="samp.h::SAMP_CBR" ref="82bc77041ac33dba80902508e0e67cb1" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_CBR</b> 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c1d67de0da93f180a22f4aa0a6c791e"></a><!-- doxytag: member="samp.h::SAMP_CBV" ref="8c1d67de0da93f180a22f4aa0a6c791e" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_CBV</b> 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6f3ff8853aee2ab95b5b95bc6118e089"></a><!-- doxytag: member="samp.h::SAMP_SYNCH" ref="6f3ff8853aee2ab95b5b95bc6118e089" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_SYNCH</b> 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0ce138af3ddf15f2f260970f61334aa"></a><!-- doxytag: member="samp.h::SAMP_ASYNCH" ref="b0ce138af3ddf15f2f260970f61334aa" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_ASYNCH</b> 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e57045e053a2de9ff90f33e2d5f8c96"></a><!-- doxytag: member="samp.h::SAMP_NOTIFY" ref="4e57045e053a2de9ff90f33e2d5f8c96" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_NOTIFY</b> 2</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="37bd37c1c7194b07b5c741deaa9bc067"></a><!-- doxytag: member="samp.h::SAMP_INT" ref="37bd37c1c7194b07b5c741deaa9bc067" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_INT</b> TY_INT</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="27a60dff10f0bce5fe7e901eab813b5a"></a><!-- doxytag: member="samp.h::SAMP_DOUBLE" ref="27a60dff10f0bce5fe7e901eab813b5a" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_DOUBLE</b> TY_DOUBLE</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="315222074686150aef1320e4024706cd"></a><!-- doxytag: member="samp.h::SAMP_BOOL" ref="315222074686150aef1320e4024706cd" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_BOOL</b> TY_BOOL</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3f3753974db5c38ecf207e8c194e5327"></a><!-- doxytag: member="samp.h::SAMP_STRING" ref="3f3753974db5c38ecf207e8c194e5327" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_STRING</b> TY_STRING</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="179ebb149a064e82a5989ec4278e5533"></a><!-- doxytag: member="samp.h::SAMP_DATETIME" ref="179ebb149a064e82a5989ec4278e5533" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_DATETIME</b> TY_DATETIME</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="268da1193f3e31a3835123617a606a11"></a><!-- doxytag: member="samp.h::SAMP_SAMPRUCT" ref="268da1193f3e31a3835123617a606a11" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_SAMPRUCT</b> TY_STRUCT</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba4e9235f0d88ec1a557a37e499a82e7"></a><!-- doxytag: member="samp.h::SAMP_ARRAY" ref="ba4e9235f0d88ec1a557a37e499a82e7" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_ARRAY</b> TY_ARRAY</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="725ce7161437542f8e767ef6742a7aef"></a><!-- doxytag: member="samp.h::SAMP_TRACE" ref="725ce7161437542f8e767ef6742a7aef" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>SAMP_TRACE</b> 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#fc367e0d449c3afa2d429eedc85407aa">HUB_SHUTDOWN</a> 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9f7120104f528bcad4d3c35451b466fa"></a><!-- doxytag: member="samp.h::HUB_REGISTER" ref="9f7120104f528bcad4d3c35451b466fa" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>HUB_REGISTER</b> 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="87abcce3ae8ebd84eaf49765275737cd"></a><!-- doxytag: member="samp.h::HUB_UNREGISTER" ref="87abcce3ae8ebd84eaf49765275737cd" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>HUB_UNREGISTER</b> 2</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dacba3969403cc030f9942696d48f226"></a><!-- doxytag: member="samp.h::HUB_SUBSCRIPTIONS" ref="dacba3969403cc030f9942696d48f226" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>HUB_SUBSCRIPTIONS</b> 3</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3deb0e45988e39beaad0b05ed31d958b"></a><!-- doxytag: member="samp.h::HUB_METADATA" ref="3deb0e45988e39beaad0b05ed31d958b" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>HUB_METADATA</b> 4</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5aa908cb222be1b5df868c96a440236c"></a><!-- doxytag: member="samp.h::HUB_DISCONNECT" ref="5aa908cb222be1b5df868c96a440236c" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>HUB_DISCONNECT</b> 5</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2e76b1116a74dcd3fbc695ebaa01bd3d"></a><!-- doxytag: member="samp.h::LEN_DESC" ref="2e76b1116a74dcd3fbc695ebaa01bd3d" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>LEN_DESC</b> 32768</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6afabdc09a49a433ee19d8a9486056d"></a><!-- doxytag: member="samp.h::min" ref="c6afabdc09a49a433ee19d8a9486056d" args="(a, b)" --> +#define </td><td class="memItemRight" valign="bottom"><b>min</b>(a, b) (a<b?a:b)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ffe776513b24d84b39af8ab0930fef7f"></a><!-- doxytag: member="samp.h::max" ref="ffe776513b24d84b39af8ab0930fef7f" args="(a, b)" --> +#define </td><td class="memItemRight" valign="bottom"><b>max</b>(a, b) (a>b?a:b)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="400c6ad9a4514ac728ef6f26c41e26df"></a><!-- doxytag: member="samp.h::MSG_SYNC" ref="400c6ad9a4514ac728ef6f26c41e26df" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MSG_SYNC</b> 0</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f38b71e9d650543379f59e8f7ade60c8"></a><!-- doxytag: member="samp.h::MSG_ASYNC" ref="f38b71e9d650543379f59e8f7ade60c8" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MSG_ASYNC</b> 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee5730f808625a70be4589312bd6c9ab"></a><!-- doxytag: member="samp.h::MSG_NOTIFY" ref="ee5730f808625a70be4589312bd6c9ab" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>MSG_NOTIFY</b> 2</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5ce6908d24bcc91b57bc9ac9923a3855"></a><!-- doxytag: member="samp.h::DEF_CALLMODE" ref="5ce6908d24bcc91b57bc9ac9923a3855" args="" --> +#define </td><td class="memItemRight" valign="bottom"><b>DEF_CALLMODE</b> MSG_ASYNC</td></tr> + +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e421d328f66b7f783a4c746afc1d017"></a><!-- doxytag: member="samp.h::handle_t" ref="0e421d328f66b7f783a4c746afc1d017" args="" --> +typedef long </td><td class="memItemRight" valign="bottom"><b>handle_t</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef char * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc13f9a2430a2e5b4d08f22a005c28ca"></a><!-- doxytag: member="samp.h::appMDP" ref="cc13f9a2430a2e5b4d08f22a005c28ca" args="" --> +typedef struct <a class="el" href="structappMD.html">appMD</a> * </td><td class="memItemRight" valign="bottom"><b>appMDP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5f6c3b3319ba8bd60a15bac1b8fe9a96"></a><!-- doxytag: member="samp.h::SubsP" ref="5f6c3b3319ba8bd60a15bac1b8fe9a96" args="" --> +typedef struct <a class="el" href="structSubs.html">Subs</a> * </td><td class="memItemRight" valign="bottom"><b>SubsP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46ebb9354eb637730c6acd2818807321"></a><!-- doxytag: member="samp.h::ClientP" ref="46ebb9354eb637730c6acd2818807321" args="" --> +typedef struct <a class="el" href="structClient.html">Client</a> * </td><td class="memItemRight" valign="bottom"><b>ClientP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cf8156b03ce4e66cd90203b1038112a8"></a><!-- doxytag: member="samp.h::HubP" ref="cf8156b03ce4e66cd90203b1038112a8" args="" --> +typedef struct <a class="el" href="structHub.html">Hub</a> * </td><td class="memItemRight" valign="bottom"><b>HubP</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="159006987ca77a172c19bd254cb6f1c5"></a><!-- doxytag: member="samp.h::SampP" ref="159006987ca77a172c19bd254cb6f1c5" args="" --> +typedef struct <a class="el" href="structSamp.html">Samp</a> * </td><td class="memItemRight" valign="bottom"><b>SampP</b></td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#30f39c72c3783055faa82ad3860f3d1d">sampInit</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> description)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the SAMP interface. <a href="#30f39c72c3783055faa82ad3860f3d1d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#2e77115e730e95b31d897b8c50999b74">samp_Metadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> field, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a metadata field value for the application. <a href="#2e77115e730e95b31d897b8c50999b74"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#c6b76655d73825acdacfac8b5a1139ee">samp_Subscribe</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, void *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to a given mtype. <a href="#c6b76655d73825acdacfac8b5a1139ee"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#b3fded97bbbf3751c4916543959f16a5">samp_Unsubscribe</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe to a given mtype. <a href="#b3fded97bbbf3751c4916543959f16a5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#8e18ae12df031094ace47863f93b3634">sampStartup</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Startup the SAMP interface to send/receive messages. <a href="#8e18ae12df031094ace47863f93b3634"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#65908d088c8b917d10db38c147590ad9">sampShutdown</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Shut down the active SAMP interface. <a href="#65908d088c8b917d10db38c147590ad9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#124214f79e99619b377d98ed2fd93eb9">sampDebug</a> (handle_t handle, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set interface debug level. <a href="#124214f79e99619b377d98ed2fd93eb9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#c0c812e5d3f2c9ee6c54067e4c81b3dd">sampVerbose</a> (handle_t handle, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set interface debug level. <a href="#c0c812e5d3f2c9ee6c54067e4c81b3dd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#123413db26ad50a84bd41863af5deae5">sampClose</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the SAMP interface and free resources. <a href="#123413db26ad50a84bd41863af5deae5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#14a1f14f60ac385c758346aed0f0272b">samp_hubActive</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if the <a class="el" href="structHub.html">Hub</a> is active (i.e. connected). <a href="#14a1f14f60ac385c758346aed0f0272b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4ecb0b92b749647d1c3af8a1d11d5d4"></a><!-- doxytag: member="samp.h::samp_setOpt" ref="d4ecb0b92b749647d1c3af8a1d11d5d4" args="(handle_t handle, char *opt, int value)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_setOpt</b> (handle_t handle, char *opt, int value)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#1d00dc78292cfbc01262ef65ab055063">samp_setSyncMode</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the calling mode to use synchronous messaging. <a href="#1d00dc78292cfbc01262ef65ab055063"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#a9aef12dd82bfd38a2382a4ac88c54af">samp_setASyncMode</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the calling mode to use asynchronous messaging. <a href="#a9aef12dd82bfd38a2382a4ac88c54af"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#9056a8601300892f918835259c7fdb3b">samp_setNotifyMode</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the calling mode to use notification messaging. <a href="#9056a8601300892f918835259c7fdb3b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#68b51d70127bbff10fd30396e40a482d">samp_setMsgMode</a> (handle_t handle, int mode)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the message pattern to the specified mode. <a href="#68b51d70127bbff10fd30396e40a482d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#d4c1514e94c9ef511cfcd27004c38c4d">samp_setCallByRef</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Have interface call user handlers by reference. <a href="#d4c1514e94c9ef511cfcd27004c38c4d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#fc27715ec9a5cb60cf0b5415eb7f9a48">samp_setCallMode</a> (handle_t handle, int mode)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the default calling mode (synch or asynch). <a href="#fc27715ec9a5cb60cf0b5415eb7f9a48"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#a3c0bdb4c512357dbc53b0ad7a7d5b01">samp_setReplyCallback</a> (handle_t handle, int *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func). <a href="#a3c0bdb4c512357dbc53b0ad7a7d5b01"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#3db66f28546459327665f8491ea97f4d">samp_setResponseCallback</a> (handle_t handle, int *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Response callback. samp_setResponseCallback (handle_t handle, int *func). <a href="#3db66f28546459327665f8491ea97f4d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#e11a97c262ab5ab4438eca6c60c0d8cf">samp_setTimeout</a> (handle_t handle, int timeout)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the message timeout value (in seconds). <a href="#e11a97c262ab5ab4438eca6c60c0d8cf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7731da5bec549e7554d1bdc11b13eaf6"></a><!-- doxytag: member="samp.h::samp_setAppName" ref="7731da5bec549e7554d1bdc11b13eaf6" args="(handle_t handle, String name)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_setAppName</b> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#8fbfdc550ede5d52840300ab33639c49">samp_setAppVersion</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> version)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the application name string. <a href="#8fbfdc550ede5d52840300ab33639c49"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#96851f1c15e4baf67949d86d15f2568d">samp_defaultReplyHandler</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The interface's default Reply handler. <a href="#96851f1c15e4baf67949d86d15f2568d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd506ac12f25f64ada7c9859af3f857f"></a><!-- doxytag: member="samp.h::samp_deaultfResponseHandler" ref="cd506ac12f25f64ada7c9859af3f857f" args="(handle_t handle)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_deaultfResponseHandler</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#d47754f3b9fceff4d3019821519432b4">samp_replyStatus</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reply with the status of the last message sent. <a href="#d47754f3b9fceff4d3019821519432b4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#ff4d125fc9594be25984989fad2fd3c8">samp_mapClients</a> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#1e494e73abe2ddfd946fb39e84da42a9">samp_listClients</a> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="61e09b672e5f610dae0f242ea8256328"></a><!-- doxytag: member="samp.h::samp_getClients" ref="61e09b672e5f610dae0f242ea8256328" args="(handle_t handle)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getClients</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#8a2111bbe4c88cef635e3bf67e899563">samp_addClient</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> id)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#e30e492f306a40f853a454faf60ab479">samp_removeClient</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> id)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#cbf9b52550a9ab0b3515c32e692c46fb">samp_getOKMap</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#27baec44edb57136951b5f86ae893246">samp_getNullMap</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#aef9c2f86c7e4f49fe3df343ef06f3ba">samp_Register</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Register with the <a class="el" href="structHub.html">Hub</a> using the currently stored metadata. <a href="#aef9c2f86c7e4f49fe3df343ef06f3ba"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#5e3a44429f332694cc2cedc2e38856ce">samp_UnRegister</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Un-Register from the hub. <a href="#5e3a44429f332694cc2cedc2e38856ce"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#94cdccbcfa524fa515de77544b6c6eaa">samp_DeclareMetadata</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">(Re)Declare all of our metadata. <a href="#94cdccbcfa524fa515de77544b6c6eaa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#7688cbf8ef852483c077be96151763a6">samp_Ping</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Ping the hub/app to see if it is alive (returns >0). <a href="#7688cbf8ef852483c077be96151763a6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#636e11796b78ae9881e7c61df8516d2a">samp_GetMetadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metadata for a specified app. <a href="#636e11796b78ae9881e7c61df8516d2a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#ef695801c121c6191d3af4574569ab8c">samp_DeclareSubscriptions</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare the messages we're interested in. <a href="#ef695801c121c6191d3af4574569ab8c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4f65b6315c8bd7380176d2b97462354"></a><!-- doxytag: member="samp.h::samp_GetSubscriptions" ref="c4f65b6315c8bd7380176d2b97462354" args="(handle_t handle, String pubId)" --> +<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><b>samp_GetSubscriptions</b> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#2c532e076dd6446f079691ed02197a57">samp_GetRegisteredClients</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get public-ids of the registered clients. <a href="#2c532e076dd6446f079691ed02197a57"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#d28a9085ab8cacbe978e300ac99f6ae5">samp_GetSubscribedClients</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get clients matching the mtype subscription. <a href="#d28a9085ab8cacbe978e300ac99f6ae5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#45c2023312cd2adfa40feb2eb8a3e143">samp_tableLoadVOTable</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to load a VOTable. <a href="#45c2023312cd2adfa40feb2eb8a3e143"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#6b950e53c7fdf481a13c8a2ec353dca1">samp_tableLoadFITS</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to load a FITS table. <a href="#6b950e53c7fdf481a13c8a2ec353dca1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#2ec386ef5bd7dee20ffa1fead0b0210a">samp_imageLoadFITS</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> imageId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to load a FITS image. <a href="#2ec386ef5bd7dee20ffa1fead0b0210a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#0503d3ee247a6a962a2a8da672261ab7">samp_tableHighlightRow</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, int row)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to highlight a table row. <a href="#0503d3ee247a6a962a2a8da672261ab7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#a410ef908863f7c5b2c99844ebb73d35">samp_tableSelectRowList</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, int rows[], int nrows)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to select a list of table rows. <a href="#a410ef908863f7c5b2c99844ebb73d35"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#0651eec8ddc8707bb8fbc4dfdcfff5e2">samp_coordPointAtSky</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, float ra, float dec)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell an app to point at an RA/Dec coordinate. <a href="#0651eec8ddc8707bb8fbc4dfdcfff5e2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#4869a1bb04a96514f153dc5bfbed8e6e">samp_specLoadSSAGeneric</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> meta, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> spectrumId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a generic spectrum from an SSA service. <a href="#4869a1bb04a96514f153dc5bfbed8e6e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#be012673358bfd254e2c6ad9f6e92240">samp_cmdExec</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> cmd)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute a command in a remote application. <a href="#be012673358bfd254e2c6ad9f6e92240"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#ba313c7608a7658c673065c83113ec5b">samp_envGet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an environment variable in a remote application. <a href="#ba313c7608a7658c673065c83113ec5b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#e842347910a3cfd746def74b0fd564aa">samp_envSet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an environment variable in a remote application. <a href="#e842347910a3cfd746def74b0fd564aa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#4c75de6ddcffde6e3dde7beea68de81c">samp_paramGet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a parameter variable in a remote application. <a href="#4c75de6ddcffde6e3dde7beea68de81c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#7a5c9f092b57dfb3206c8decc8558fd3">samp_paramSet</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an parameter variable in a remote application. <a href="#7a5c9f092b57dfb3206c8decc8558fd3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#abeaa1ac9d09a666a9fa34a7d274483d">samp_bibLoad</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> bibcode)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Exchange a bibcode. <a href="#abeaa1ac9d09a666a9fa34a7d274483d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#a0bb33d232fcb52aaa470d1f1b1a89d7">samp_resourceLoad</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> type, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resMap)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Exchange a resource list. <a href="#a0bb33d232fcb52aaa470d1f1b1a89d7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#5837826e5b4e86b2dda0892c48b96faf">samp_sendGeneric</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> args[])</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a geenric message. <a href="#5837826e5b4e86b2dda0892c48b96faf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#4607721d55904450d4066c360d3dcddd">samp_sendMsg</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the specified message. <a href="#4607721d55904450d4066c360d3dcddd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#c73788ae17493c4042948f6b861ddd74">samp_notify</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a notify() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#c73788ae17493c4042948f6b861ddd74"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#a046d61f43fce831a71621f98b6d9741">samp_notifyAll</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a notifyAll() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#a046d61f43fce831a71621f98b6d9741"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#919cca4cfc557e0c05914b805401fbd3">samp_call</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tag, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a call() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#919cca4cfc557e0c05914b805401fbd3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#2cbf26c662884a4ae9587f7b9f4113a6">samp_callAll</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a callAll() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#2cbf26c662884a4ae9587f7b9f4113a6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#c69c39e8ee091c006289b486dee10711">samp_callAndWait</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Make a callAndWait() call to the <a class="el" href="structHub.html">Hub</a>. <a href="#c69c39e8ee091c006289b486dee10711"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#89fc488147fe2e08b4f3c044c7079962">samp_Reply</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reply to a message. <a href="#89fc488147fe2e08b4f3c044c7079962"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#0a61726448d9b1a026b20ff6beead44e">samp_clientName</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structClient.html">Client</a> name from a pubic-id. <a href="#0a61726448d9b1a026b20ff6beead44e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#3c026895e4d28567eb63c3b9cc16cd40">samp_setErr</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the error response string. <a href="#3c026895e4d28567eb63c3b9cc16cd40"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#fd8a4da020cd2fedaf70ae8af0b6a1c8">samp_getErr</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the error response string. <a href="#fd8a4da020cd2fedaf70ae8af0b6a1c8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#59f85e0fce4c9ae7121c98e137d3f743">samp_receiveCall</a> (void *data)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">test.echo method <a href="#59f85e0fce4c9ae7121c98e137d3f743"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#03be7cc9e154a6ccdd499286df640936">samp_receiveNotification</a> (void *data)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">receiveNotification () client method. <a href="#03be7cc9e154a6ccdd499286df640936"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#754b50ad59145c7fd1e4c8f4277f11e4">samp_receiveResponse</a> (void *data)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">receiveResponse () client method. <a href="#754b50ad59145c7fd1e4c8f4277f11e4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#1cd88b9e964d61403d6aad89dddce591">samp_setHandlerReply</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the <a class="el" href="structSamp.html">Samp</a> Handler reply map. <a href="#1cd88b9e964d61403d6aad89dddce591"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#0a0d9e41bebb554869f099dcf142a7bf">samp_getHandlerReply</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structSamp.html">Samp</a> Handler reply map. <a href="#0a0d9e41bebb554869f099dcf142a7bf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#b969017f97d850b092bde60a2d445a2b">samp_setUserHandler</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, void *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the user-interface handler for the mtype. <a href="#b969017f97d850b092bde60a2d445a2b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#8b83cf8a75c16c45c547be68f0bf9f64">samp_setSampHandler</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, void *func)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the SAMP interface handler for the mtype. <a href="#8b83cf8a75c16c45c547be68f0bf9f64"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#ce2ea31b9bd82db4c5040ffd0511bd8b">samp_getUserHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the User handler for the named mtype. <a href="#ce2ea31b9bd82db4c5040ffd0511bd8b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#f295f9e7746644f834ac54b1deb95b4c">samp_getSampHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Samphandler for the named mtype. <a href="#f295f9e7746644f834ac54b1deb95b4c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#e09217f0e615e01dfcffbdebda2516e8">samp_execUserHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Execute the user-defined handler for the mtype. <a href="#e09217f0e615e01dfcffbdebda2516e8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1b7812ba89eebe15ad24f36a3d439a0a"></a><!-- doxytag: member="samp.h::samp_genericMsgHandler" ref="1b7812ba89eebe15ad24f36a3d439a0a" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_genericMsgHandler</b> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#16d8b8822d169107b8702ae753797923">samp_PingHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Is app alive and responding to messages? <a href="#16d8b8822d169107b8702ae753797923"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#2e342b672e77e012cc98a6f5506a44be">samp_StatusHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return status of the task. <a href="#2e342b672e77e012cc98a6f5506a44be"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#9bd8036dd65dc4f874f39568b691a123">samp_imLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle an image.load.fits message. <a href="#9bd8036dd65dc4f874f39568b691a123"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#26f96dc6cbf72283e2ee9cb8b4619ed3">samp_tbLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a generic table.load.* message. <a href="#26f96dc6cbf72283e2ee9cb8b4619ed3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#750c0fee0c7a99e135299c08751f288c">samp_tbLoadFITSHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a generic table.load.fits message. <a href="#750c0fee0c7a99e135299c08751f288c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#144ec2329355d91022d5ea38736c0093">samp_tbLoadVOTHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a generic table.load.votable message. <a href="#144ec2329355d91022d5ea38736c0093"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#d9184eb45a5bc93b5205fd5b1c6ef688">samp_tbHighlightHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a table.highlight.row message. <a href="#d9184eb45a5bc93b5205fd5b1c6ef688"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#98d68d7091c0b7790631bb53e0ace656">samp_tbSelectHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a table.select.rowList message. <a href="#98d68d7091c0b7790631bb53e0ace656"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#3f5632858a2b09759ffe98cd2e183cfb">samp_pointAtHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a coord.pointAt.sky message. <a href="#3f5632858a2b09759ffe98cd2e183cfb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#bc319b97b3dbea29bd79c4f723db5438">samp_specLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a spectrum.load.* message. <a href="#bc319b97b3dbea29bd79c4f723db5438"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#dd2bca8fa3bf3b4ebbf449edc6b65d85">samp_specSSAHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a spectrum.load.ssa-generic message. <a href="#dd2bca8fa3bf3b4ebbf449edc6b65d85"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b">samp_cmdExecHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.cmd.exec message. <a href="#c57d19afc6fa0b4bc9c7a0fd50d0f54b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#e25a92f57babd71d43653d7fcb81025c">samp_envGetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.env.set message. <a href="#e25a92f57babd71d43653d7fcb81025c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#0910e6b9d11cdd3111c1f18450de394a">samp_envSetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.env.set message. <a href="#0910e6b9d11cdd3111c1f18450de394a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#659c272ce881662c1826a04728dc06f6">samp_paramGetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.param.set message. <a href="#659c272ce881662c1826a04728dc06f6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#071aa9e32f2e94d5b667e87cf65d2bdf">samp_paramSetHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a client.param.set message. <a href="#071aa9e32f2e94d5b667e87cf65d2bdf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#262bf09278c61b60b5189fef7f26d26b">samp_bibcodeHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a bibcode.load message. <a href="#262bf09278c61b60b5189fef7f26d26b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#c0bf7cf7fea362c0c82ad7bc3f267c48">samp_resLoadHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#c0bf7cf7fea362c0c82ad7bc3f267c48"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#287569451dc1bf59d1f9f6d13b56716d">samp_resConeHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#287569451dc1bf59d1f9f6d13b56716d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#8b2300222d7b11f144eb4385412e69a5">samp_resSiapHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#8b2300222d7b11f144eb4385412e69a5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#866578a01c3b762435823b1b11869c42">samp_resSsapHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#866578a01c3b762435823b1b11869c42"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#ad42ca17cbaf23012ad497559ea45e4c">samp_resTapHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#ad42ca17cbaf23012ad497559ea45e4c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#fa207ebdc587ba5eeab60fbf79b635d4">samp_resVOSpaceHandler</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">handle a voresource.loadlist message <a href="#fa207ebdc587ba5eeab60fbf79b635d4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e743048f5b1f903496b2a8a2e9666367"></a><!-- doxytag: member="samp.h::samp_printMessage" ref="e743048f5b1f903496b2a8a2e9666367" args="(String mtype, String sender, String msg_id, Map params)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_printMessage</b> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#a8a947c24f2c9333adf4e5d7fa11d134">samp_printMap</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#5361571754505eaefdf5739cd3e9519e">samp_nullResponse</a> (void *data)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cc687f745f400b41c9af4f6419bf9bf8"></a><!-- doxytag: member="samp.h::samp_testEcho" ref="cc687f745f400b41c9af4f6419bf9bf8" args="(void *data)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_testEcho</b> (void *data)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#ef92557afa5ed6731ac0a0a1ba6dfd7c">samp_hubOpen</a> (<a class="el" href="structSamp.html">Samp</a> *samp)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Discover and open a connection to the SAMP <a class="el" href="structHub.html">Hub</a>. <a href="#ef92557afa5ed6731ac0a0a1ba6dfd7c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#39a580ced499e50d39d327f7709834e7">samp_hubClose</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close a connection to the <a class="el" href="structHub.html">Hub</a>. <a href="#39a580ced499e50d39d327f7709834e7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#d0343ad884d5a958d7d91928ad06a369">samp_getAvailableHubs</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a list of available Hubs. <a href="#d0343ad884d5a958d7d91928ad06a369"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4b4292d136520c3d276d655e2093dd30"></a><!-- doxytag: member="samp.h::samp_getActiveHubName" ref="4b4292d136520c3d276d655e2093dd30" args="(handle_t handle)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getActiveHubName</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf266e81b16f556e2f42cad5a2eb9157"></a><!-- doxytag: member="samp.h::samp_getActiveHub" ref="bf266e81b16f556e2f42cad5a2eb9157" args="(handle_t handle)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_getActiveHub</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#a927eb8dcb67e245aeb5a8a4feeb6230">samp_hubRunning</a> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12c4307b544d66d57d54cbc4c031dd35"></a><!-- doxytag: member="samp.h::samp_hubInit" ref="12c4307b544d66d57d54cbc4c031dd35" args="(handle_t samp, char *appName, char *descr)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_hubInit</b> (handle_t samp, char *appName, char *descr)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#265b5d07cce485a6979fe5f4a2217624">samp_processHubEvent</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. <a href="#265b5d07cce485a6979fe5f4a2217624"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#a48b9a99f22537127df46a94dfa9ae4a">samp_hubEvent</a> (<a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. <a href="#a48b9a99f22537127df46a94dfa9ae4a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#77a14721e2373c805b58f69a018ea69c">samp_hubRegister</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a Register message to the <a class="el" href="structHub.html">Hub</a>. <a href="#77a14721e2373c805b58f69a018ea69c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#b0c37311ca30e1fdadfdd1fd16ff3ab4">samp_hubUnRegister</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a UnRegister message to the <a class="el" href="structHub.html">Hub</a>. <a href="#b0c37311ca30e1fdadfdd1fd16ff3ab4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#6c7b8a8ff1f3c2435d153bc08da87dce">samp_hubSendShutdown</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a samp.app.event.shutdown message to the <a class="el" href="structHub.html">Hub</a>. <a href="#6c7b8a8ff1f3c2435d153bc08da87dce"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#fc0bfbd699ab2cbce2f755a0506ca6dc">samp_hubSetXmlrpcCallback</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the client callback and send to <a class="el" href="structHub.html">Hub</a>. <a href="#fc0bfbd699ab2cbce2f755a0506ca6dc"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#155739318fa72883a3e32fccf8a6d5c9">samp_hubPing</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Ping the <a class="el" href="structHub.html">Hub</a> to see if it is alive. <a href="#155739318fa72883a3e32fccf8a6d5c9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#bf1ae8a1c9c8cf520a22e6ea4d815712">samp_hubDeclareMetadata</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare "standard" metadata to the <a class="el" href="structHub.html">Hub</a>. <a href="#bf1ae8a1c9c8cf520a22e6ea4d815712"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#a6c0f67a76bd1f27898a66fe26b53fdd">samp_hubDeclareSubscriptions</a> (<a class="el" href="structHub.html">Hub</a> *<a class="el" href="sampHub_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Declare mtype subscriptions to the <a class="el" href="structHub.html">Hub</a>. <a href="#a6c0f67a76bd1f27898a66fe26b53fdd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#cdc925da798ee7a1ce30427d47812bd2">samp_newList</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new List object. <a href="#cdc925da798ee7a1ce30427d47812bd2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#b162ae9b9f98da80f6bb5c34b5cbcbf6">samp_freeList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given List object. <a href="#b162ae9b9f98da80f6bb5c34b5cbcbf6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#c260afb0cbf19b427e3eba96a2341e52">samp_listLen</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of elements in a List. <a href="#c260afb0cbf19b427e3eba96a2341e52"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#5b69180b036e58528c98b1cf5a42825a">samp_setStringInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a List (append). <a href="#5b69180b036e58528c98b1cf5a42825a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#ea188bb711f3b5549d11204b0ff2da08">samp_setMapInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Map in a List (append). <a href="#ea188bb711f3b5549d11204b0ff2da08"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#0ff97d44e62b7c88a046a29324552400">samp_setListInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list1, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list2)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a List in another List (append). <a href="#0ff97d44e62b7c88a046a29324552400"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#2d8a8a26d7284bb211a933895cddd29c">samp_setIntInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an Int in a List (append). <a href="#2d8a8a26d7284bb211a933895cddd29c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#041a551aff57ca03f3ff72a9803e2b58">samp_setFloatInList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, float value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Float in a List (append). <a href="#041a551aff57ca03f3ff72a9803e2b58"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#b101c5b1175490474e41ac9060bdaabf">samp_getStringFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string from the List. <a href="#b101c5b1175490474e41ac9060bdaabf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#33ca96ee3a8e7d26356c7b66f469da74">samp_getMapFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Map from the List. <a href="#33ca96ee3a8e7d26356c7b66f469da74"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#b74e90fdfe79b1c4f7668fdb28d041a1">samp_getListFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a List from the List. <a href="#b74e90fdfe79b1c4f7668fdb28d041a1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1174e001b2d16ed0aa1b317cfc883af1"></a><!-- doxytag: member="samp.h::samp_getIntFromList" ref="1174e001b2d16ed0aa1b317cfc883af1" args="(List list, int index)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_getIntFromList</b> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#cf9b570dd76203d2299ed7bdba048bb9">samp_getFloatFromList</a> (<a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, int index)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Float from the List. <a href="#cf9b570dd76203d2299ed7bdba048bb9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#d88b5d5e9014deba8071f7defd220dbb">samp_newMap</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Map object. <a href="#d88b5d5e9014deba8071f7defd220dbb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#fe80438de542c6657d623993360b37d1">samp_freeMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given Map object. <a href="#fe80438de542c6657d623993360b37d1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c99f7146ad3acd3e381a02d5df1234f"></a><!-- doxytag: member="samp.h::samp_getMapSize" ref="1c99f7146ad3acd3e381a02d5df1234f" args="(Map map)" --> +int </td><td class="memItemRight" valign="bottom"><b>samp_getMapSize</b> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c8a1b402743b52f2837e97cf41e9e34"></a><!-- doxytag: member="samp.h::samp_getMapKey" ref="4c8a1b402743b52f2837e97cf41e9e34" args="(Map map, int index)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getMapKey</b> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, int index)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7dcdf07dd7f3252f3bf2dd5002c62251"></a><!-- doxytag: member="samp.h::samp_getMapVal" ref="7dcdf07dd7f3252f3bf2dd5002c62251" args="(Map map, int index)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_getMapVal</b> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, int index)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#b9b2157de89369eb5cd95bfe804eb89a">samp_setStringInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, char *value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a Map (append). <a href="#b9b2157de89369eb5cd95bfe804eb89a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#f102490efe1b92d99b67f244dc498c7b">samp_setMapInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map1, char *key, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map2)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Map in a Map (append). <a href="#f102490efe1b92d99b67f244dc498c7b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#362c2f670c98dd6a3ef69debd1871604">samp_setListInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a List in a Map (append). <a href="#362c2f670c98dd6a3ef69debd1871604"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#c22ec42dbf9a01c9b4e00cf011e7eb9d">samp_setIntInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, int value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a Int in a Map (append). <a href="#c22ec42dbf9a01c9b4e00cf011e7eb9d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#0f07ae542f5b317311b3799bd96a88fd">samp_setFloatInMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key, float value)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a Map (append). <a href="#0f07ae542f5b317311b3799bd96a88fd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#e615ad9482fa88705b2488a37c987c2a">samp_getStringFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a string from the Map. <a href="#e615ad9482fa88705b2488a37c987c2a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#525e8ffdfa32867f392f2c1340215453">samp_getMapFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a Map from the Map. <a href="#525e8ffdfa32867f392f2c1340215453"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#31ddb90cf2184ae0151b9e7ec8c1a51f">samp_getListFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a LIST from the Map. <a href="#31ddb90cf2184ae0151b9e7ec8c1a51f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#594a51772e9b0693a3c77006eb88c96a">samp_getIntFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a integer from the Map. <a href="#594a51772e9b0693a3c77006eb88c96a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#89c38f762afd50c85f6ff659bdf0a923">samp_getFloatFromMap</a> (<a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, char *key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a float from the Map. <a href="#89c38f762afd50c85f6ff659bdf0a923"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#d343c08e241ff4e17a0eb8fa3d9f4781">samp_newMsg</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Msg object. <a href="#d343c08e241ff4e17a0eb8fa3d9f4781"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#adf2979a5fad0c9a855740330b7fd9ce">samp_freeMsg</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given Msg object. <a href="#adf2979a5fad0c9a855740330b7fd9ce"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="34c9e29fa57216f19a70764df8e5826b"></a><!-- doxytag: member="samp.h::samp_msgMType" ref="34c9e29fa57216f19a70764df8e5826b" args="(Msg msg, String mtype)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_msgMType</b> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#281c8f7f8b21a74704dd200d5aaed481">samp_msgParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to the Msg. <a href="#281c8f7f8b21a74704dd200d5aaed481"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb9eff6a0f442a1c9fde13c1e9fc097d"></a><!-- doxytag: member="samp.h::samp_msgTag" ref="cb9eff6a0f442a1c9fde13c1e9fc097d" args="(void)" --> +char * </td><td class="memItemRight" valign="bottom"><b>samp_msgTag</b> (void)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#3e2fe98bee9ac2b0c882de78e9b5085f">samp_newParam</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new Param object. <a href="#3e2fe98bee9ac2b0c882de78e9b5085f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#5a6fbf3ac37164268afae80c35666c5e">samp_freeParam</a> (<a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the given Msg object. <a href="#5a6fbf3ac37164268afae80c35666c5e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#f2953eb691b695482ffbbea71948374f">samp_paramInit</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of Params. <a href="#f2953eb691b695482ffbbea71948374f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62c2d0b887252730fd6f7bdaa7211403"></a><!-- doxytag: member="samp.h::samp_addStringParam" ref="62c2d0b887252730fd6f7bdaa7211403" args="(Msg msg, char *keyw, String val)" --> +void </td><td class="memItemRight" valign="bottom"><b>samp_addStringParam</b> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> val)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#e3e90c84dd6b1a08d8af18ca9e168b37">samp_addMapParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to the Param. <a href="#e3e90c84dd6b1a08d8af18ca9e168b37"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#24f72c4ed033ed2f219b420e491b3c0f">samp_addListParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a parameter to the Param. <a href="#24f72c4ed033ed2f219b420e491b3c0f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#6897da75444209fc1819042bde906aa6">samp_addIntParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, int val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <SAMP int>=""> parameter to the Param. <a href="#6897da75444209fc1819042bde906aa6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#d297770f4ab1338697d69b2705d6c1d9">samp_addFloatParam</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, char *keyw, float val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <SAMP float>=""> parameter to the Param. <a href="#d297770f4ab1338697d69b2705d6c1d9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#5a44618b7681acff67b3883341494d2d">samp_paramLen</a> (<a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of Params. <a href="#5a44618b7681acff67b3883341494d2d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#329a8a5f83162ed49baa28f008131d45">sampLog</a> (handle_t handle, char *format,...)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">SAMP message logger. <a href="#329a8a5f83162ed49baa28f008131d45"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#65e3987c9b510018dcdd91203b437e40">sampTrace</a> (handle_t handle, char *format,...)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">SAMP tracer. <a href="#65e3987c9b510018dcdd91203b437e40"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#711aa545f55e9307f662062deefd5903">samp_newHandle</a> (void *ptr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an unused object handle. <a href="#711aa545f55e9307f662062deefd5903"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#f02a7c646a9ed56e545d8bf33434c207">samp_freeHandle</a> (handle_t handle)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the handle for later re-use. <a href="#f02a7c646a9ed56e545d8bf33434c207"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#4d0aef2f09b9cce38d4ea8024831c6e5">samp_P2H</a> (void *ptr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a pointer to a handle. <a href="#4d0aef2f09b9cce38d4ea8024831c6e5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="598e10661c7c7f4d13ae721c03056497"></a><!-- doxytag: member="samp.h::samp_H2P" ref="598e10661c7c7f4d13ae721c03056497" args="(handle_t handle)" --> +void * </td><td class="memItemRight" valign="bottom"><b>samp_H2P</b> (handle_t handle)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#5e555288172e59ccf28c901c6bc10793">samp_app2id</a> (handle_t handle, char *appName)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an application name to a public-ID. <a href="#5e555288172e59ccf28c901c6bc10793"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#343e25bf33431d973d9f81bc25eddcf7">samp_id2app</a> (handle_t handle, char *pubId)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a public-ID to the application name. <a href="#343e25bf33431d973d9f81bc25eddcf7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#6157dc4b47c65323a3015a434cd02e69">samp_serverPort</a> (void)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a unique port number for the server. <a href="#6157dc4b47c65323a3015a434cd02e69"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#5b2ef060b3adb18aea7a5a6099c4d0d0">samp_printMetadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the metadata for the application. <a href="#5b2ef060b3adb18aea7a5a6099c4d0d0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="samp_8h.html#def0598aa30c5c1a2276cdddf705de69">samp_getMetadata</a> (handle_t handle, <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the metadata item for the application. <a href="#def0598aa30c5c1a2276cdddf705de69"></a><br></td></tr> +</table> +<hr><h2>Detailed Description</h2> +SAMP interface include file. +<p> +SAMP.H -- SAMP interface include file.<p> +<dl class="author" compact><dt><b>Author:</b></dt><dd>Mike FItzpatrick </dd></dl> +<dl class="date" compact><dt><b>Date:</b></dt><dd>7/10/09 </dd></dl> +<hr><h2>Define Documentation</h2> +<a class="anchor" name="fc367e0d449c3afa2d429eedc85407aa"></a><!-- doxytag: member="samp.h::HUB_SHUTDOWN" ref="fc367e0d449c3afa2d429eedc85407aa" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define HUB_SHUTDOWN 0 </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Special <a class="el" href="structHub.html">Hub</a> events +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00320">samp_hubEvent()</a>, and <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<hr><h2>Typedef Documentation</h2> +<a class="anchor" name="39f9d235896a8fd920f319105eb82791"></a><!-- doxytag: member="samp.h::List" ref="39f9d235896a8fd920f319105eb82791" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP Map datatype +</div> +</div><p> +<a class="anchor" name="39a90bc041db57e1a6ba736ba91eee30"></a><!-- doxytag: member="samp.h::Map" ref="39a90bc041db57e1a6ba736ba91eee30" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +generic object handle +</div> +</div><p> +<a class="anchor" name="eb3d03dd240212c044285bdd522e3b2b"></a><!-- doxytag: member="samp.h::Msg" ref="eb3d03dd240212c044285bdd522e3b2b" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP List datatype +</div> +</div><p> +<a class="anchor" name="4c5a7aff173725461e76e5f0183d7ed8"></a><!-- doxytag: member="samp.h::Param" ref="4c5a7aff173725461e76e5f0183d7ed8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef int <a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP Msg datatype +</div> +</div><p> +<a class="anchor" name="2efe6d463d80744789f228f5dc4baa39"></a><!-- doxytag: member="samp.h::String" ref="2efe6d463d80744789f228f5dc4baa39" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef char* <a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP Param datatype +</div> +</div><p> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="8a2111bbe4c88cef635e3bf67e899563"></a><!-- doxytag: member="samp.h::samp_addClient" ref="8a2111bbe4c88cef635e3bf67e899563" args="(handle_t handle, String name, String id)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_addClient </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>id</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_ADDCLIENT -- Add a newly registered client to the list of known apps so we can do the public-private name translation. +</div> +</div><p> +<a class="anchor" name="d297770f4ab1338697d69b2705d6c1d9"></a><!-- doxytag: member="samp.h::samp_addFloatParam" ref="d297770f4ab1338697d69b2705d6c1d9" args="(Msg msg, char *keyw, float val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addFloatParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a <SAMP float>=""> parameter to the Param. +<p> +SAMP_ADDFLOATPARAM -- Add a <SAMP float>=""> parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>floating point value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6897da75444209fc1819042bde906aa6"></a><!-- doxytag: member="samp.h::samp_addIntParam" ref="6897da75444209fc1819042bde906aa6" args="(Msg msg, char *keyw, int val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addIntParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a <SAMP int>=""> parameter to the Param. +<p> +SAMP_ADDINTPARAM -- Add a <SAMP int>=""> parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>integer value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="24f72c4ed033ed2f219b420e491b3c0f"></a><!-- doxytag: member="samp.h::samp_addListParam" ref="24f72c4ed033ed2f219b420e491b3c0f" args="(Msg msg, char *keyw, List val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addListParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a parameter to the Param. +<p> +SAMP_ADDLISTPARAM -- Add a List parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>value list </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e3e90c84dd6b1a08d8af18ca9e168b37"></a><!-- doxytag: member="samp.h::samp_addMapParam" ref="e3e90c84dd6b1a08d8af18ca9e168b37" args="(Msg msg, char *keyw, Map val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_addMapParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>keyw</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a parameter to the Param. +<p> +SAMP_ADDMAPPARAM -- Add a Map parameter to the Param.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>value map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5e555288172e59ccf28c901c6bc10793"></a><!-- doxytag: member="samp.h::samp_app2id" ref="5e555288172e59ccf28c901c6bc10793" args="(handle_t handle, char *appName)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">pubId samp_app2id </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>appName</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Convert an application name to a public-ID. +<p> +SAMP_APP2ID -- Convert an application name to a public-ID.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>appName</em> </td><td>name of registered application </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>public ID of application </dd></dl> + +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="262bf09278c61b60b5189fef7f26d26b"></a><!-- doxytag: member="samp.h::samp_bibcodeHandler" ref="262bf09278c61b60b5189fef7f26d26b" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_bibcodeHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a bibcode.load message. +<p> +SAMP_BIBCODEHANDLER -- Handle a bibcode.load message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="abeaa1ac9d09a666a9fa34a7d274483d"></a><!-- doxytag: member="samp.h::samp_bibLoad" ref="abeaa1ac9d09a666a9fa34a7d274483d" args="(handle_t handle, String recip, String bibcode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">val samp_bibLoad </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>bibcode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Exchange a bibcode. +<p> +SAMP_BIBLOAD -- Exchange a bibcode.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>bibcode</em> </td><td>Bibcode string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="919cca4cfc557e0c05914b805401fbd3"></a><!-- doxytag: member="samp.h::samp_call" ref="919cca4cfc557e0c05914b805401fbd3" args="(handle_t handle, String recipId, String tag, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg id samp_call </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recipId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a call() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_CALL -- Make a call() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recipId</em> </td><td>recipient ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_tag</em> </td><td>message tag </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>message ID </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2cbf26c662884a4ae9587f7b9f4113a6"></a><!-- doxytag: member="samp.h::samp_callAll" ref="2cbf26c662884a4ae9587f7b9f4113a6" args="(handle_t handle, String msg_tag, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> calls samp_callAll </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a callAll() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_CALLALL -- Make a callAll() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_tag</em> </td><td>message tag </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c69c39e8ee091c006289b486dee10711"></a><!-- doxytag: member="samp.h::samp_callAndWait" ref="c69c39e8ee091c006289b486dee10711" args="(handle_t handle, String recipId, String msg_tag, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_callAndWait </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recipId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_tag</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a callAndWait() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_CALLANDWAIT -- Make a callAndWait() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recipId</em> </td><td>recipient ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_tag</em> </td><td>message tag </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0a61726448d9b1a026b20ff6beead44e"></a><!-- doxytag: member="samp.h::samp_clientName" ref="0a61726448d9b1a026b20ff6beead44e" args="(handle_t handle, String pubId)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">name samp_clientName </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>pubId</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the <a class="el" href="structClient.html">Client</a> name from a pubic-id. +<p> +SAMP_CLIENTNAME -- Get the <a class="el" href="structClient.html">Client</a> name from a pubic-id.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>pubId</em> </td><td>public ID </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>declared application name </dd></dl> + +</div> +</div><p> +<a class="anchor" name="be012673358bfd254e2c6ad9f6e92240"></a><!-- doxytag: member="samp.h::samp_cmdExec" ref="be012673358bfd254e2c6ad9f6e92240" args="(handle_t handle, String recip, String cmd)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_cmdExec </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>cmd</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Execute a command in a remote application. +<p> +SAMP_CMDEXEC -- Execute a command in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>cmd</em> </td><td>Command string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c57d19afc6fa0b4bc9c7a0fd50d0f54b"></a><!-- doxytag: member="samp.h::samp_cmdExecHandler" ref="c57d19afc6fa0b4bc9c7a0fd50d0f54b" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_cmdExecHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.cmd.exec message. +<p> +SAMP_CMDEXECHANDLER -- Handle a client.cmd.exec message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0651eec8ddc8707bb8fbc4dfdcfff5e2"></a><!-- doxytag: member="samp.h::samp_coordPointAtSky" ref="0651eec8ddc8707bb8fbc4dfdcfff5e2" args="(handle_t handle, String recip, float ra, float dec)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_coordPointAtSky </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>ra</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>dec</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to point at an RA/Dec coordinate. +<p> +SAMP_COORDPOINTATSKY -- Tell an app to point at an RA/Dec coordinate.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>ra</em> </td><td>RA of coord in degrees </td></tr> + <tr><td valign="top"></td><td valign="top"><em>dec</em> </td><td>Dec of coord in degrees </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="94cdccbcfa524fa515de77544b6c6eaa"></a><!-- doxytag: member="samp.h::samp_DeclareMetadata" ref="94cdccbcfa524fa515de77544b6c6eaa" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_DeclareMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +(Re)Declare all of our metadata. +<p> +SAMP_DECLAREMETATA -- (Re)Declare all of our metadata.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ef695801c121c6191d3af4574569ab8c"></a><!-- doxytag: member="samp.h::samp_DeclareSubscriptions" ref="ef695801c121c6191d3af4574569ab8c" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_DeclareSubscriptions </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declare the messages we're interested in. +<p> +SAMP_DECLARESUBSCRIPIONS -- Declare the messages we're interested in.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00507">samp_Unsubscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="96851f1c15e4baf67949d86d15f2568d"></a><!-- doxytag: member="samp.h::samp_defaultReplyHandler" ref="96851f1c15e4baf67949d86d15f2568d" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_defaultReplyHandler </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The interface's default Reply handler. +<p> +SAMP_DEFAULTREPLYHANDLER -- The interface's default Reply handler.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ba313c7608a7658c673065c83113ec5b"></a><!-- doxytag: member="samp.h::samp_envGet" ref="ba313c7608a7658c673065c83113ec5b" args="(handle_t handle, String recip, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">val samp_envGet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get an environment variable in a remote application. +<p> +SAMP_ENVGET -- Get an environment variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL, Value of variable, or list of values </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e25a92f57babd71d43653d7fcb81025c"></a><!-- doxytag: member="samp.h::samp_envGetHandler" ref="e25a92f57babd71d43653d7fcb81025c" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_envGetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.env.set message. +<p> +SAMP_ENVGETHANDLER -- Handle a client.env.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e842347910a3cfd746def74b0fd564aa"></a><!-- doxytag: member="samp.h::samp_envSet" ref="e842347910a3cfd746def74b0fd564aa" args="(handle_t handle, String recip, String name, String value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_envSet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an environment variable in a remote application. +<p> +SAMP_ENVSET -- Set an environment variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value of variable or NULL </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0910e6b9d11cdd3111c1f18450de394a"></a><!-- doxytag: member="samp.h::samp_envSetHandler" ref="0910e6b9d11cdd3111c1f18450de394a" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_envSetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.env.set message. +<p> +SAMP_ENVSETHANDLER -- Handle a client.env.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e09217f0e615e01dfcffbdebda2516e8"></a><!-- doxytag: member="samp.h::samp_execUserHandler" ref="e09217f0e615e01dfcffbdebda2516e8" args="(String mtype, String sender, String msg_id, Map params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_execUserHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>params</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Execute the user-defined handler for the mtype. +<p> +SAMP_EXECUSERHANDLER -- Execute the user-defined handler for the mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message-id string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>Mtype parameter Map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>, and <a class="el" href="sampMethods_8c_source.html#l00189">samp_receiveResponse()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f02a7c646a9ed56e545d8bf33434c207"></a><!-- doxytag: member="samp.h::samp_freeHandle" ref="f02a7c646a9ed56e545d8bf33434c207" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeHandle </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the handle for later re-use. +<p> +SAMP_FREEHANDLE -- Free the handle for later re-use.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>object handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, and <a class="el" href="samp_8c_source.html#l00145">sampClose()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b162ae9b9f98da80f6bb5c34b5cbcbf6"></a><!-- doxytag: member="samp.h::samp_freeList" ref="b162ae9b9f98da80f6bb5c34b5cbcbf6" args="(List list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given List object. +<p> +SAMP_FREELIST -- Free the given List object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="fe80438de542c6657d623993360b37d1"></a><!-- doxytag: member="samp.h::samp_freeMap" ref="fe80438de542c6657d623993360b37d1" args="(Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given Map object. +<p> +SAMP_FREEMAP -- Free the given Map object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>Map object to free </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, and <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="adf2979a5fad0c9a855740330b7fd9ce"></a><!-- doxytag: member="samp.h::samp_freeMsg" ref="adf2979a5fad0c9a855740330b7fd9ce" args="(Msg msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeMsg </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given Msg object. +<p> +SAMP_FREEMSG -- Free the given Msg object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Msg object to free </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5a6fbf3ac37164268afae80c35666c5e"></a><!-- doxytag: member="samp.h::samp_freeParam" ref="5a6fbf3ac37164268afae80c35666c5e" args="(Param param)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_freeParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td> + <td class="paramname"> <em>param</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Free the given Msg object. +<p> +SAMP_FREEPARAM -- Free the given Param object<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>Param object to free </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="d0343ad884d5a958d7d91928ad06a369"></a><!-- doxytag: member="samp.h::samp_getAvailableHubs" ref="d0343ad884d5a958d7d91928ad06a369" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_getAvailableHubs </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a list of available Hubs. +<p> +SAMP_GETAVAILABLEHUBS -- Get a list of available Hubs<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>hub handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>List of hub handles </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fd8a4da020cd2fedaf70ae8af0b6a1c8"></a><!-- doxytag: member="samp.h::samp_getErr" ref="fd8a4da020cd2fedaf70ae8af0b6a1c8" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_getErr </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the error response string. +<p> +SAMP_GETERR -- Get the error response string.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Error text string </dd></dl> + +</div> +</div><p> +<a class="anchor" name="cf9b570dd76203d2299ed7bdba048bb9"></a><!-- doxytag: member="samp.h::samp_getFloatFromList" ref="cf9b570dd76203d2299ed7bdba048bb9" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ival samp_getFloatFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a Float from the List. +<p> +SAMP_GETFLOATFROMLIST -- Get a Float from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the desired value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>int value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="89c38f762afd50c85f6ff659bdf0a923"></a><!-- doxytag: member="samp.h::samp_getFloatFromMap" ref="89c38f762afd50c85f6ff659bdf0a923" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">rval samp_getFloatFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a float from the Map. +<p> +SAMP_GETFLOATFROMMAP -- Get a float from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>floating point value </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00786">samp_pointAtHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0a0d9e41bebb554869f099dcf142a7bf"></a><!-- doxytag: member="samp.h::samp_getHandlerReply" ref="0a0d9e41bebb554869f099dcf142a7bf" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_getHandlerReply </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the <a class="el" href="structSamp.html">Samp</a> Handler reply map. +<p> +SAMP_GETHANDLERREPLY -- Get the <a class="el" href="structSamp.html">Samp</a> Handler reply map.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Map handle for reply map </dd></dl> + +<p>References <a class="el" href="samp_8c_source.html#l00053">nullMap</a>, and <a class="el" href="samp_8c_source.html#l00054">OK_Map</a>.</p> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, and <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="594a51772e9b0693a3c77006eb88c96a"></a><!-- doxytag: member="samp.h::samp_getIntFromMap" ref="594a51772e9b0693a3c77006eb88c96a" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ival samp_getIntFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a integer from the Map. +<p> +SAMP_GETINTFROMMAP -- Get a integer from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>integer value </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00705">samp_tbHighlightHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b74e90fdfe79b1c4f7668fdb28d041a1"></a><!-- doxytag: member="samp.h::samp_getListFromList" ref="b74e90fdfe79b1c4f7668fdb28d041a1" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ival samp_getListFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a List from the List. +<p> +Get an Int from the List.<p> +SAMP_GETLISTFROMLIST -- Get a List from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the List </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>List handle</dd></dl> +SAMP_GETINTFROMLIST -- Get an Int from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the desired value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>int value </dd></dl> + +</div> +</div><p> +<a class="anchor" name="31ddb90cf2184ae0151b9e7ec8c1a51f"></a><!-- doxytag: member="samp.h::samp_getListFromMap" ref="31ddb90cf2184ae0151b9e7ec8c1a51f" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> samp_getListFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a LIST from the Map. +<p> +SAMP_GETLISTFROMMAP -- Get a LIST from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to List value </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="33ca96ee3a8e7d26356c7b66f469da74"></a><!-- doxytag: member="samp.h::samp_getMapFromList" ref="33ca96ee3a8e7d26356c7b66f469da74" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getMapFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a Map from the List. +<p> +SAMP_GETMAPFROMLIST -- Get a Map from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the Map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Map handle </dd></dl> + +</div> +</div><p> +<a class="anchor" name="525e8ffdfa32867f392f2c1340215453"></a><!-- doxytag: member="samp.h::samp_getMapFromMap" ref="525e8ffdfa32867f392f2c1340215453" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getMapFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a Map from the Map. +<p> +SAMP_GETMAPFROMMAP -- Get a Map from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to Map value </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="def0598aa30c5c1a2276cdddf705de69"></a><!-- doxytag: member="samp.h::samp_getMetadata" ref="def0598aa30c5c1a2276cdddf705de69" args="(handle_t handle, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">str samp_getMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>param</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the metadata item for the application. +<p> +SAMP_GETMETADATA -- Get the metadata item for the application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="636e11796b78ae9881e7c61df8516d2a"></a><!-- doxytag: member="samp.h::samp_GetMetadata" ref="636e11796b78ae9881e7c61df8516d2a" args="(handle_t handle, String pubId)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">map samp_GetMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>pubId</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the metadata for a specified app. +<p> +SAMP_GETMETADATA -- Get the metadata for a specified app.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>pubId</em> </td><td>App public-id </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Map to message response </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="27baec44edb57136951b5f86ae893246"></a><!-- doxytag: member="samp.h::samp_getNullMap" ref="27baec44edb57136951b5f86ae893246" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getNullMap </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_GETNULLMAP -- Generate a 'Null' map we can return to the <a class="el" href="structHub.html">Hub</a>. +</div> +</div><p> +<a class="anchor" name="cbf9b52550a9ab0b3515c32e692c46fb"></a><!-- doxytag: member="samp.h::samp_getOKMap" ref="cbf9b52550a9ab0b3515c32e692c46fb" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_getOKMap </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_GETOKMAP -- Generate an 'OK' map we can return to the <a class="el" href="structHub.html">Hub</a>. +</div> +</div><p> +<a class="anchor" name="2c532e076dd6446f079691ed02197a57"></a><!-- doxytag: member="samp.h::samp_GetRegisteredClients" ref="2c532e076dd6446f079691ed02197a57" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle samp_GetRegisteredClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get public-ids of the registered clients. +<p> +SAMP_GETREGISTEREDCLIENTS -- Get public-ids of the registered clients.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to list of registered clients </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="f295f9e7746644f834ac54b1deb95b4c"></a><!-- doxytag: member="samp.h::samp_getSampHandler" ref="f295f9e7746644f834ac54b1deb95b4c" args="(String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">func samp_getSampHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the Samphandler for the named mtype. +<p> +SAMP_GETSAMPHANDLER -- Get the Samphandler for the named mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>, and <a class="el" href="samp_8c_source.html#l00475">samp_Subscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b101c5b1175490474e41ac9060bdaabf"></a><!-- doxytag: member="samp.h::samp_getStringFromList" ref="b101c5b1175490474e41ac9060bdaabf" args="(List list, int index)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char * samp_getStringFromList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>index</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a string from the List. +<p> +SAMP_GETSTRINGFROMLIST -- Get a string from the List<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>List index containing the string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>character string </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e615ad9482fa88705b2488a37c987c2a"></a><!-- doxytag: member="samp.h::samp_getStringFromMap" ref="e615ad9482fa88705b2488a37c987c2a" args="(Map map, char *key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char * samp_getStringFromMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a string from the Map. +<p> +SAMP_GETSTRINGFROMMAP -- Get a string from the Map<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>string value from Map </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l01118">samp_bibcodeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00906">samp_cmdExecHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00994">samp_envSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00547">samp_imLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01082">samp_paramSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00705">samp_tbHighlightHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00621">samp_tbLoadFITSHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00663">samp_tbLoadVOTHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d28a9085ab8cacbe978e300ac99f6ae5"></a><!-- doxytag: member="samp.h::samp_GetSubscribedClients" ref="d28a9085ab8cacbe978e300ac99f6ae5" args="(handle_t handle, String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">list samp_GetSubscribedClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get clients matching the mtype subscription. +<p> +SAMP_GETSUBSCRIBEDCLIENTS -- Get clients matching the mtype subscription.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to list of clients having mtype subscription </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ce2ea31b9bd82db4c5040ffd0511bd8b"></a><!-- doxytag: member="samp.h::samp_getUserHandler" ref="ce2ea31b9bd82db4c5040ffd0511bd8b" args="(String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">func samp_getUserHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the User handler for the named mtype. +<p> +SAMP_GETUSERHANDLER -- Get the User handler for the named mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l01118">samp_bibcodeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00906">samp_cmdExecHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00994">samp_envSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00547">samp_imLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01082">samp_paramSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00451">samp_PingHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00786">samp_pointAtHandler()</a>, <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>, <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00482">samp_StatusHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00705">samp_tbHighlightHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00621">samp_tbLoadFITSHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00663">samp_tbLoadVOTHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="14a1f14f60ac385c758346aed0f0272b"></a><!-- doxytag: member="samp.h::samp_hubActive" ref="14a1f14f60ac385c758346aed0f0272b" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubActive </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Determine if the <a class="el" href="structHub.html">Hub</a> is active (i.e. connected). +<p> +SAMP_HUBACTIVE -- Determine if the <a class="el" href="structHub.html">Hub</a> is active (i.e. connected).<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00197">Samp::active</a>.</p> + +</div> +</div><p> +<a class="anchor" name="39a580ced499e50d39d327f7709834e7"></a><!-- doxytag: member="samp.h::samp_hubClose" ref="39a580ced499e50d39d327f7709834e7" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_hubClose </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Close a connection to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBCLOSE -- Close a connection to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>hub handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>unregister status </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00145">sampClose()</a>, and <a class="el" href="samp_8c_source.html#l00323">sampShutdown()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="bf1ae8a1c9c8cf520a22e6ea4d815712"></a><!-- doxytag: member="samp.h::samp_hubDeclareMetadata" ref="bf1ae8a1c9c8cf520a22e6ea4d815712" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_hubDeclareMetadata </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declare "standard" metadata to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_DECLAREMETADATA -- Declare "standard" metadata to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00121">samp_DeclareMetadata()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a6c0f67a76bd1f27898a66fe26b53fdd"></a><!-- doxytag: member="samp.h::samp_hubDeclareSubscriptions" ref="a6c0f67a76bd1f27898a66fe26b53fdd" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_hubDeclareSubscriptions </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Declare mtype subscriptions to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBDECLARESUBSCRIPTIONS -- Declare mtype subscriptions to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00227">samp_DeclareSubscriptions()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a48b9a99f22537127df46a94dfa9ae4a"></a><!-- doxytag: member="samp.h::samp_hubEvent" ref="a48b9a99f22537127df46a94dfa9ae4a" args="(String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">code samp_hubEvent </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. +<p> +SAMP_HUBEVENT -- Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="structHub.html">Hub</a> event code or -1 if not found </dd></dl> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ef92557afa5ed6731ac0a0a1ba6dfd7c"></a><!-- doxytag: member="samp.h::samp_hubOpen" ref="ef92557afa5ed6731ac0a0a1ba6dfd7c" args="(Samp *samp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle samp_hubOpen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structSamp.html">Samp</a> * </td> + <td class="paramname"> <em>sampP</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Discover and open a connection to the SAMP <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBOPEN -- Discover and open a connection to the SAMP <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>samp</em> </td><td>Same structure </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>hub handle </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="155739318fa72883a3e32fccf8a6d5c9"></a><!-- doxytag: member="samp.h::samp_hubPing" ref="155739318fa72883a3e32fccf8a6d5c9" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_hubPing </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Ping the <a class="el" href="structHub.html">Hub</a> to see if it is alive. +<p> +SAMP_HUBPING -- Ping the <a class="el" href="structHub.html">Hub</a> to see if it is alive.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="77a14721e2373c805b58f69a018ea69c"></a><!-- doxytag: member="samp.h::samp_hubRegister" ref="77a14721e2373c805b58f69a018ea69c" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_hubRegister </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a Register message to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUB_REGISTER -- Send a Register message to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a927eb8dcb67e245aeb5a8a4feeb6230"></a><!-- doxytag: member="samp.h::samp_hubRunning" ref="a927eb8dcb67e245aeb5a8a4feeb6230" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_hubRunning </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_HUBRUNNING -- See whether a <a class="el" href="structHub.html">Hub</a> is running. The test simply checks the existence of a <a class="el" href="structHub.html">Hub</a> lockfile. +<p>References <a class="el" href="sampDecl_8h_source.html#l00020">SZ_NAME</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6c7b8a8ff1f3c2435d153bc08da87dce"></a><!-- doxytag: member="samp.h::samp_hubSendShutdown" ref="6c7b8a8ff1f3c2435d153bc08da87dce" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_hubSendShutdown </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a samp.app.event.shutdown message to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBSENDSHUTDOWN -- Send a samp.app.event.shutdown message to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fc0bfbd699ab2cbce2f755a0506ca6dc"></a><!-- doxytag: member="samp.h::samp_hubSetXmlrpcCallback" ref="fc0bfbd699ab2cbce2f755a0506ca6dc" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_hubSetXmlrpcCallback </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the client callback and send to <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBSETXMLRPCCALLBACK -- Set the client callback and send to <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b0c37311ca30e1fdadfdd1fd16ff3ab4"></a><!-- doxytag: member="samp.h::samp_hubUnRegister" ref="b0c37311ca30e1fdadfdd1fd16ff3ab4" args="(Hub *hub)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_hubUnRegister </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structHub.html">Hub</a> * </td> + <td class="paramname"> <em>hub</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a UnRegister message to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_HUBUNREGISTER -- Send a UnRegister message to the <a class="el" href="structHub.html">Hub</a>.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>hub</em> </td><td>hub struct pointer </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status </dd></dl> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, and <a class="el" href="sampCommands_8c_source.html#l00102">samp_UnRegister()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="343e25bf33431d973d9f81bc25eddcf7"></a><!-- doxytag: member="samp.h::samp_id2app" ref="343e25bf33431d973d9f81bc25eddcf7" args="(handle_t handle, char *pubId)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">appName samp_id2app </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>pubId</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Convert a public-ID to the application name. +<p> +SAMP_ID2APP -- Convert a public-ID to the application name.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>pubId</em> </td><td>public ID of application </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>name of registered application </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2ec386ef5bd7dee20ffa1fead0b0210a"></a><!-- doxytag: member="samp.h::samp_imageLoadFITS" ref="2ec386ef5bd7dee20ffa1fead0b0210a" args="(handle_t handle, String recip, String url, String imageId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_imageLoadFITS </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to load a FITS image. +<p> +SAMP_IMAGELOADFITS -- Tell an app to load a FITS image.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>imageId</em> </td><td>ID assigned to image (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name assigned to image (optional) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="9bd8036dd65dc4f874f39568b691a123"></a><!-- doxytag: member="samp.h::samp_imLoadHandler" ref="9bd8036dd65dc4f874f39568b691a123" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_imLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle an image.load.fits message. +<p> +SAMP_IMLOADHANDLER -- Handle an image.load.fits message.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1e494e73abe2ddfd946fb39e84da42a9"></a><!-- doxytag: member="samp.h::samp_listClients" ref="1e494e73abe2ddfd946fb39e84da42a9" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_listClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_LISTCLIENTS -- List the available clients to stdout. +</div> +</div><p> +<a class="anchor" name="c260afb0cbf19b427e3eba96a2341e52"></a><!-- doxytag: member="samp.h::samp_listLen" ref="c260afb0cbf19b427e3eba96a2341e52" args="(List list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_listLen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get number of elements in a List. +<p> +SAMP_LISTLEN -- Get number of elements in a List.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, <a class="el" href="sampCommands_8c_source.html#l00323">samp_GetSubscribedClients()</a>, <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ff4d125fc9594be25984989fad2fd3c8"></a><!-- doxytag: member="samp.h::samp_mapClients" ref="ff4d125fc9594be25984989fad2fd3c8" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_mapClients </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_MAPCLIENTS -- Map the public-ids of registered clients to the appName. +</div> +</div><p> +<a class="anchor" name="2e77115e730e95b31d897b8c50999b74"></a><!-- doxytag: member="samp.h::samp_Metadata" ref="2e77115e730e95b31d897b8c50999b74" args="(handle_t handle, String field, String value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_Metadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>field</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a metadata field value for the application. +<p> +SAMP_METADATA -- Set a metadata field for the application. This will be sent to the <a class="el" href="structHub.html">Hub</a> later in a declareMetadata() call.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>field</em> </td><td>metadata field to set (name, author, etc) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>samp</em> </td><td>value of field </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="281c8f7f8b21a74704dd200d5aaed481"></a><!-- doxytag: member="samp.h::samp_msgParam" ref="281c8f7f8b21a74704dd200d5aaed481" args="(Msg msg, Param param)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_msgParam </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> </td> + <td class="paramname"> <em>param</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Add a parameter to the Msg. +<p> +SAMP_MSGPARAM -- Add a parameter to the Msg.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>keyw</em> </td><td>map keyword </td></tr> + <tr><td valign="top"></td><td valign="top"><em>param</em> </td><td>parameter map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="711aa545f55e9307f662062deefd5903"></a><!-- doxytag: member="samp.h::samp_newHandle" ref="711aa545f55e9307f662062deefd5903" args="(void *ptr)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t samp_newHandle </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>ptr</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get an unused object handle. +<p> +SAMP_NEWHANDLE -- Get an unused object handle.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>pointer to object to be stored </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>new object handle </dd></dl> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="cdc925da798ee7a1ce30427d47812bd2"></a><!-- doxytag: member="samp.h::samp_newList" ref="cdc925da798ee7a1ce30427d47812bd2" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_newList </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new List object. +<p> +SAMP_NEWLIST -- Create a new List object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to List object </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, <a class="el" href="sampCommands_8c_source.html#l00323">samp_GetSubscribedClients()</a>, <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d88b5d5e9014deba8071f7defd220dbb"></a><!-- doxytag: member="samp.h::samp_newMap" ref="d88b5d5e9014deba8071f7defd220dbb" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_newMap </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new Map object. +<p> +SAMP_NEWMAP -- Create a new Map object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Map </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="samp_8c_source.html#l00957">samp_getNullMap()</a>, <a class="el" href="samp_8c_source.html#l00942">samp_getOKMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d343c08e241ff4e17a0eb8fa3d9f4781"></a><!-- doxytag: member="samp.h::samp_newMsg" ref="d343c08e241ff4e17a0eb8fa3d9f4781" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_newMsg </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new Msg object. +<p> +SAMP_NEWMSG -- Create a new Msg object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Msg </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3e2fe98bee9ac2b0c882de78e9b5085f"></a><!-- doxytag: member="samp.h::samp_newParam" ref="3e2fe98bee9ac2b0c882de78e9b5085f" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_newParam </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a new Param object. +<p> +SAMP_NEWPARAM -- Create a new Param object<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to new Param </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c73788ae17493c4042948f6b861ddd74"></a><!-- doxytag: member="samp.h::samp_notify" ref="c73788ae17493c4042948f6b861ddd74" args="(handle_t handle, String recipId, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_notify </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recipId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a notify() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_NOTIFY -- Make a notify() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recipId</em> </td><td>recipient ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a046d61f43fce831a71621f98b6d9741"></a><!-- doxytag: member="samp.h::samp_notifyAll" ref="a046d61f43fce831a71621f98b6d9741" args="(handle_t handle, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_notifyAll </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Make a notifyAll() call to the <a class="el" href="structHub.html">Hub</a>. +<p> +SAMP_NOTIFYALL -- Make a notifyAll() call to the <a class="el" href="structHub.html">Hub</a><p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5361571754505eaefdf5739cd3e9519e"></a><!-- doxytag: member="samp.h::samp_nullResponse" ref="5361571754505eaefdf5739cd3e9519e" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_nullResponse </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_NULLRESPONSE -- Handler to ignore async replies. +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00422">samp_hubSendShutdown()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, and <a class="el" href="sampClient_8c_source.html#l00278">samp_Reply()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4d0aef2f09b9cce38d4ea8024831c6e5"></a><!-- doxytag: member="samp.h::samp_P2H" ref="4d0aef2f09b9cce38d4ea8024831c6e5" args="(void *ptr)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t samp_P2H </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>ptr</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Convert a pointer to a handle. +<p> +SAMP_P2H -- Convert a pointer to a handle<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>pointer to object </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>handle to object, < 0 on error </dd></dl> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, and <a class="el" href="sampHub_8c_source.html#l00250">samp_processHubEvent()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4c75de6ddcffde6e3dde7beea68de81c"></a><!-- doxytag: member="samp.h::samp_paramGet" ref="4c75de6ddcffde6e3dde7beea68de81c" args="(handle_t handle, String recip, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">val samp_paramGet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a parameter variable in a remote application. +<p> +SAMP_PARAMGET -- Get a parameter variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL, Value of variable, or list of values </dd></dl> + +</div> +</div><p> +<a class="anchor" name="659c272ce881662c1826a04728dc06f6"></a><!-- doxytag: member="samp.h::samp_paramGetHandler" ref="659c272ce881662c1826a04728dc06f6" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramGetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.param.set message. +<p> +SAMP_PARAMGETHANDLER -- Handle a client.param.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f2953eb691b695482ffbbea71948374f"></a><!-- doxytag: member="samp.h::samp_paramInit" ref="f2953eb691b695482ffbbea71948374f" args="(Msg msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">nparam samp_paramInit </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get number of Params. +<p> +SAMP_PARAMINIT -- Get number of Params.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampParam_8c_source.html#l00181">samp_addFloatParam()</a>, <a class="el" href="sampParam_8c_source.html#l00154">samp_addIntParam()</a>, <a class="el" href="sampParam_8c_source.html#l00135">samp_addListParam()</a>, and <a class="el" href="sampParam_8c_source.html#l00116">samp_addMapParam()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5a44618b7681acff67b3883341494d2d"></a><!-- doxytag: member="samp.h::samp_paramLen" ref="5a44618b7681acff67b3883341494d2d" args="(Msg msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">nparam samp_paramLen </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> </td> + <td class="paramname"> <em>msg</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get number of Params. +<p> +SAMP_PARAMLEN -- Get number of Params.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>handle to Msg object </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7a5c9f092b57dfb3206c8decc8558fd3"></a><!-- doxytag: member="samp.h::samp_paramSet" ref="7a5c9f092b57dfb3206c8decc8558fd3" args="(handle_t handle, String recip, String name, String value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_paramSet </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an parameter variable in a remote application. +<p> +SAMP_PARAMSET -- Set an parameter variable in a remote application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of variable in receiver's environment </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value of variable or NULL </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="071aa9e32f2e94d5b667e87cf65d2bdf"></a><!-- doxytag: member="samp.h::samp_paramSetHandler" ref="071aa9e32f2e94d5b667e87cf65d2bdf" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_paramSetHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a client.param.set message. +<p> +SAMP_PARAMSETHANDLER -- Handle a client.param.set message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7688cbf8ef852483c077be96151763a6"></a><!-- doxytag: member="samp.h::samp_Ping" ref="7688cbf8ef852483c077be96151763a6" args="(handle_t handle, String appName)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_Ping </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>appName</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Ping the hub/app to see if it is alive (returns >0). +<p> +SAMP_PING -- Ping the hub/app to see if it is alive (returns >0).<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>appName</em> </td><td>application name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>OK or ERR if no response </dd></dl> + +</div> +</div><p> +<a class="anchor" name="16d8b8822d169107b8702ae753797923"></a><!-- doxytag: member="samp.h::samp_PingHandler" ref="16d8b8822d169107b8702ae753797923" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_PingHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Is app alive and responding to messages? +<p> +SAMP_PINGHANDLER -- Simple aliveness test function.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3f5632858a2b09759ffe98cd2e183cfb"></a><!-- doxytag: member="samp.h::samp_pointAtHandler" ref="3f5632858a2b09759ffe98cd2e183cfb" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_pointAtHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a coord.pointAt.sky message. +<p> +SAMP_POINTATHANDLER -- Handle a coord.pointAt.sky message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a8a947c24f2c9333adf4e5d7fa11d134"></a><!-- doxytag: member="samp.h::samp_printMap" ref="a8a947c24f2c9333adf4e5d7fa11d134" args="(String name, Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_printMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_PRINTMAP -- Print the contents of a Map structure. +</div> +</div><p> +<a class="anchor" name="5b2ef060b3adb18aea7a5a6099c4d0d0"></a><!-- doxytag: member="samp.h::samp_printMetadata" ref="5b2ef060b3adb18aea7a5a6099c4d0d0" args="(handle_t handle, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_printMetadata </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Print the metadata for the application. +<p> +SAMP_PRINTMETADATA -- Print the metadata for the application.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="265b5d07cce485a6979fe5f4a2217624"></a><!-- doxytag: member="samp.h::samp_processHubEvent" ref="265b5d07cce485a6979fe5f4a2217624" args="(String mtype, Map params)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">valid samp_processHubEvent </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>params</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype. +<p> +SAMP_HUBEVENT -- Determine the type of <a class="el" href="structHub.html">Hub</a> event mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>message parameter Map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>non-zero value if a <a class="el" href="structHub.html">Hub</a> event was processed </dd></dl> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="59f85e0fce4c9ae7121c98e137d3f743"></a><!-- doxytag: member="samp.h::samp_receiveCall" ref="59f85e0fce4c9ae7121c98e137d3f743" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_receiveCall </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +test.echo method +<p> +receiveCall () client method.<p> +SAMP_TESTECHO -- test.echo method<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno</dd></dl> +SAMP_RECEIVECALL -- receiveCall() client method.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno </dd></dl> + +</div> +</div><p> +<a class="anchor" name="03be7cc9e154a6ccdd499286df640936"></a><!-- doxytag: member="samp.h::samp_receiveNotification" ref="03be7cc9e154a6ccdd499286df640936" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_receiveNotification </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +receiveNotification () client method. +<p> +SAMP_RECEIVENOTIFICATION -- receiveNotification() client method.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno </dd></dl> + +</div> +</div><p> +<a class="anchor" name="754b50ad59145c7fd1e4c8f4277f11e4"></a><!-- doxytag: member="samp.h::samp_receiveResponse" ref="754b50ad59145c7fd1e4c8f4277f11e4" args="(void *data)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_receiveResponse </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>data</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +receiveResponse () client method. +<p> +SAMP_RECEIVERESPONSE -- receiveResponse() client method.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>caller param data </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>status code or errno </dd></dl> + +</div> +</div><p> +<a class="anchor" name="aef9c2f86c7e4f49fe3df343ef06f3ba"></a><!-- doxytag: member="samp.h::samp_Register" ref="aef9c2f86c7e4f49fe3df343ef06f3ba" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle samp_Register </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Register with the <a class="el" href="structHub.html">Hub</a> using the currently stored metadata. +<p> +SAMP_REGISTER -- Register with the <a class="el" href="structHub.html">Hub</a> using the currently stored metadata.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e30e492f306a40f853a454faf60ab479"></a><!-- doxytag: member="samp.h::samp_removeClient" ref="e30e492f306a40f853a454faf60ab479" args="(handle_t handle, String id)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_removeClient </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>id</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP_REMOVECLIENT -- Remove a registered client from the list of known apps that do the public-private name translation. +</div> +</div><p> +<a class="anchor" name="89fc488147fe2e08b4f3c044c7079962"></a><!-- doxytag: member="samp.h::samp_Reply" ref="89fc488147fe2e08b4f3c044c7079962" args="(handle_t handle, String msg_id, Map resp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">status samp_Reply </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>response</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reply to a message. +<p> +SAMP_REPLY -- Reply to a message. All we do here is send the reply message, we require that the response Map already be defined.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message ID </td></tr> + <tr><td valign="top"></td><td valign="top"><em>response</em> </td><td>response map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>Referenced by <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d47754f3b9fceff4d3019821519432b4"></a><!-- doxytag: member="samp.h::samp_replyStatus" ref="d47754f3b9fceff4d3019821519432b4" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_replyStatus </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reply with the status of the last message sent. +<p> +SAMP_REPLYSTATUS -- Reply with the status of the last message sent.<p> +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<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>samp</em> </td><td>samp struct ptr </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>message status </dd></dl> + +</div> +</div><p> +<a class="anchor" name="287569451dc1bf59d1f9f6d13b56716d"></a><!-- doxytag: member="samp.h::samp_resConeHandler" ref="287569451dc1bf59d1f9f6d13b56716d" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resConeHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESCONEHANDLER -- Handle a voresource.loadlist.cone message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c0bf7cf7fea362c0c82ad7bc3f267c48"></a><!-- doxytag: member="samp.h::samp_resLoadHandler" ref="c0bf7cf7fea362c0c82ad7bc3f267c48" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESLOADHANDLER -- handle a voresource.loadlist.* message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="a0bb33d232fcb52aaa470d1f1b1a89d7"></a><!-- doxytag: member="samp.h::samp_resourceLoad" ref="a0bb33d232fcb52aaa470d1f1b1a89d7" args="(handle_t handle, String recip, String type, String name, Map resMap)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">val samp_resourceLoad </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>resMap</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Exchange a resource list. +<p> +SAMP_RESOURCELOAD -- Exchange a resource list.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Resource type (or NULL) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Descriptive name (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>resMap</em> </td><td>Resource map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8b2300222d7b11f144eb4385412e69a5"></a><!-- doxytag: member="samp.h::samp_resSiapHandler" ref="8b2300222d7b11f144eb4385412e69a5" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resSiapHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESSIAPHANDLER -- Handle a voresource.loadlist.siap message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="866578a01c3b762435823b1b11869c42"></a><!-- doxytag: member="samp.h::samp_resSsapHandler" ref="866578a01c3b762435823b1b11869c42" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resSsapHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESSSAPHANDLER -- Handle a voresource.loadlist.ssap message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ad42ca17cbaf23012ad497559ea45e4c"></a><!-- doxytag: member="samp.h::samp_resTapHandler" ref="ad42ca17cbaf23012ad497559ea45e4c" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resTapHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESTAPHANDLER -- Handle a voresource.loadlist.tap message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fa207ebdc587ba5eeab60fbf79b635d4"></a><!-- doxytag: member="samp.h::samp_resVOSpaceHandler" ref="fa207ebdc587ba5eeab60fbf79b635d4" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_resVOSpaceHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +handle a voresource.loadlist message +<p> +SAMP_RESVOSPACEHANDLER -- Handle a voresource.loadlist.vospace message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="5837826e5b4e86b2dda0892c48b96faf"></a><!-- doxytag: member="samp.h::samp_sendGeneric" ref="5837826e5b4e86b2dda0892c48b96faf" args="(handle_t handle, String recip, String mtype, String args[])" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_sendGeneric </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>args</em>[]</td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send a geenric message. +<p> +SAMP_SENDGENERIC -- Send a generic message.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>Message type </td></tr> + <tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>Argument list </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR</dd></dl> +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. +</div> +</div><p> +<a class="anchor" name="4607721d55904450d4066c360d3dcddd"></a><!-- doxytag: member="samp.h::samp_sendMsg" ref="4607721d55904450d4066c360d3dcddd" args="(handle_t handle, String recip, Map msg)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_sendMsg </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Send the specified message. +<p> +SAMP_SENDMSG -- Send the specified message.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>Message map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6157dc4b47c65323a3015a434cd02e69"></a><!-- doxytag: member="samp.h::samp_serverPort" ref="6157dc4b47c65323a3015a434cd02e69" args="(void)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">port samp_serverPort </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return a unique port number for the server. +<p> +SAMP_SERVERPORT -- Return a unique port number for the server.<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>port number </dd></dl> + +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00448">samp_hubSetXmlrpcCallback()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8fbfdc550ede5d52840300ab33639c49"></a><!-- doxytag: member="samp.h::samp_setAppVersion" ref="8fbfdc550ede5d52840300ab33639c49" args="(handle_t handle, String version)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setAppVersion </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>version</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the application name string. +<p> +Set the application version string.<p> +SAMP_SETAPPNAME -- Set the application name string.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>application name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing</dd></dl> +SAMP_SETAPPVERSION -- Set the application version string.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>application version </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a9aef12dd82bfd38a2382a4ac88c54af"></a><!-- doxytag: member="samp.h::samp_setASyncMode" ref="a9aef12dd82bfd38a2382a4ac88c54af" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setASyncMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the calling mode to use asynchronous messaging. +<p> +SAMP_SETASYNCMODE -- Set the calling mode to use asynchronous messaging.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="d4c1514e94c9ef511cfcd27004c38c4d"></a><!-- doxytag: member="samp.h::samp_setCallByRef" ref="d4c1514e94c9ef511cfcd27004c38c4d" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setCallByRef </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Have interface call user handlers by reference. +<p> +SAMP_SETCALLBYREF -- Have interface call user handlers by reference.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="fc27715ec9a5cb60cf0b5415eb7f9a48"></a><!-- doxytag: member="samp.h::samp_setCallMode" ref="fc27715ec9a5cb60cf0b5415eb7f9a48" args="(handle_t handle, int mode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setCallMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>mode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the default calling mode (synch or asynch). +<p> +SAMP_SETCALLMODE -- Set the default calling mode (synch or asynch)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>call mode (synch or asynch) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3c026895e4d28567eb63c3b9cc16cd40"></a><!-- doxytag: member="samp.h::samp_setErr" ref="3c026895e4d28567eb63c3b9cc16cd40" args="(handle_t handle, Map resp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_setErr </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>resp</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the error response string. +<p> +SAMP_SETERR -- Set the error response string/code.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>resp</em> </td><td>Response map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, and <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="041a551aff57ca03f3ff72a9803e2b58"></a><!-- doxytag: member="samp.h::samp_setFloatInList" ref="041a551aff57ca03f3ff72a9803e2b58" args="(List list, float value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setFloatInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>rval</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Float in a List (append). +<p> +SAMP_SETFLOATINLIST -- Set a Float in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list1</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>rval</em> </td><td>Float value to be appended </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0f07ae542f5b317311b3799bd96a88fd"></a><!-- doxytag: member="samp.h::samp_setFloatInMap" ref="0f07ae542f5b317311b3799bd96a88fd" args="(Map map, char *key, float value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setFloatInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">float </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a string in a Map (append). +<p> +SAMP_SETFLOATINMAP -- Set a Float in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="1cd88b9e964d61403d6aad89dddce591"></a><!-- doxytag: member="samp.h::samp_setHandlerReply" ref="1cd88b9e964d61403d6aad89dddce591" args="(Map resp)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setHandlerReply </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>resp</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the <a class="el" href="structSamp.html">Samp</a> Handler reply map. +<p> +SAMP_SETHANDLERREPLY -- Set the <a class="el" href="structSamp.html">Samp</a> Handler reply map.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>resp</em> </td><td>response map </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2d8a8a26d7284bb211a933895cddd29c"></a><!-- doxytag: member="samp.h::samp_setIntInList" ref="2d8a8a26d7284bb211a933895cddd29c" args="(List list, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setIntInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>ival</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set an Int in a List (append). +<p> +SAMP_SETINTINLIST -- Set an Int in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list1</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>ival</em> </td><td>Integer value to be appended </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c22ec42dbf9a01c9b4e00cf011e7eb9d"></a><!-- doxytag: member="samp.h::samp_setIntInMap" ref="c22ec42dbf9a01c9b4e00cf011e7eb9d" args="(Map map, char *key, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setIntInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Int in a Map (append). +<p> +SAMP_SETINTINMAP -- Set a Int in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0ff97d44e62b7c88a046a29324552400"></a><!-- doxytag: member="samp.h::samp_setListInList" ref="0ff97d44e62b7c88a046a29324552400" args="(List list1, List list2)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setListInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list2</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a List in another List (append). +<p> +SAMP_SETLISTINLIST -- Set a List in another List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list1</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>list2</em> </td><td>List to be appended </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="362c2f670c98dd6a3ef69debd1871604"></a><!-- doxytag: member="samp.h::samp_setListInMap" ref="362c2f670c98dd6a3ef69debd1871604" args="(Map map, char *key, List list)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setListInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a List in a Map (append). +<p> +SAMP_SETLISTINMAP -- Set a List in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>handle to List object to set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ea188bb711f3b5549d11204b0ff2da08"></a><!-- doxytag: member="samp.h::samp_setMapInList" ref="ea188bb711f3b5549d11204b0ff2da08" args="(List list, Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setMapInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Map in a List (append). +<p> +SAMP_SETMAPINLIST -- Set a Map in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>Map object to be set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f102490efe1b92d99b67f244dc498c7b"></a><!-- doxytag: member="samp.h::samp_setMapInMap" ref="f102490efe1b92d99b67f244dc498c7b" args="(Map map1, char *key, Map map2)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setMapInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map2</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a Map in a Map (append). +<p> +SAMP_SETMAPINMAP -- Set a Map in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map1</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>map2</em> </td><td>handle to Map object to set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="samp_8c_source.html#l00942">samp_getOKMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="68b51d70127bbff10fd30396e40a482d"></a><!-- doxytag: member="samp.h::samp_setMsgMode" ref="68b51d70127bbff10fd30396e40a482d" args="(handle_t handle, int mode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setMsgMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>mode</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the message pattern to the specified mode. +<p> +SAMP_SETMSGMODE -- Set the message pattern to the specified mode.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>message mode </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00199">Samp::msgMode</a>.</p> + +</div> +</div><p> +<a class="anchor" name="9056a8601300892f918835259c7fdb3b"></a><!-- doxytag: member="samp.h::samp_setNotifyMode" ref="9056a8601300892f918835259c7fdb3b" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setNotifyMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the calling mode to use notification messaging. +<p> +SAMP_SETNOTIFYMODE -- Set the calling mode to use notification messaging.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a3c0bdb4c512357dbc53b0ad7a7d5b01"></a><!-- doxytag: member="samp.h::samp_setReplyCallback" ref="a3c0bdb4c512357dbc53b0ad7a7d5b01" args="(handle_t handle, int *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setReplyCallback </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func). +<p> +SAMP_SETREPLYCALLBACK -- Set the Reply callback.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback for Reply message </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="3db66f28546459327665f8491ea97f4d"></a><!-- doxytag: member="samp.h::samp_setResponseCallback" ref="3db66f28546459327665f8491ea97f4d" args="(handle_t handle, int *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setResponseCallback </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the Response callback. samp_setResponseCallback (handle_t handle, int *func). +<p> +SAMP_SETRESPONSECALLBACK -- Set the Response callback.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback for message response </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8b83cf8a75c16c45c547be68f0bf9f64"></a><!-- doxytag: member="samp.h::samp_setSampHandler" ref="8b83cf8a75c16c45c547be68f0bf9f64" args="(handle_t handle, String mtype, void *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setSampHandler </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the SAMP interface handler for the mtype. +<p> +SAMP_SETSAMPHANDLER -- Set the SAMP interface handler for the mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00475">samp_Subscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="5b69180b036e58528c98b1cf5a42825a"></a><!-- doxytag: member="samp.h::samp_setStringInList" ref="5b69180b036e58528c98b1cf5a42825a" args="(List list, char *value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setStringInList </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39f9d235896a8fd920f319105eb82791">List</a> </td> + <td class="paramname"> <em>list</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a string in a List (append). +<p> +SAMP_SETSTRINGINLIST -- Set a string in a List (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>List object handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>string value to set </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, and <a class="el" href="sampCommands_8c_source.html#l00323">samp_GetSubscribedClients()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b9b2157de89369eb5cd95bfe804eb89a"></a><!-- doxytag: member="samp.h::samp_setStringInMap" ref="b9b2157de89369eb5cd95bfe804eb89a" args="(Map map, char *key, char *value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setStringInMap </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a string in a Map (append). +<p> +SAMP_SETSTRINGINMAP -- Set a string in a Map (append)<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>handle to Map object </td></tr> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Map key </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Map value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="samp_8c_source.html#l00942">samp_getOKMap()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="1d00dc78292cfbc01262ef65ab055063"></a><!-- doxytag: member="samp.h::samp_setSyncMode" ref="1d00dc78292cfbc01262ef65ab055063" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setSyncMode </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the calling mode to use synchronous messaging. +<p> +SAMP_SETSYNCMODE -- Set the calling mode to use synchronous messaging.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="e11a97c262ab5ab4438eca6c60c0d8cf"></a><!-- doxytag: member="samp.h::samp_setTimeout" ref="e11a97c262ab5ab4438eca6c60c0d8cf" args="(handle_t handle, int timeout)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_setTimeout </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>timeout</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the message timeout value (in seconds). +<p> +SAMP_SETTIMEOUT -- Set the message timeout value (in seconds).<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>application name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b969017f97d850b092bde60a2d445a2b"></a><!-- doxytag: member="samp.h::samp_setUserHandler" ref="b969017f97d850b092bde60a2d445a2b" args="(handle_t handle, String mtype, void *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">samp_setUserHandler </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>func</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the user-interface handler for the mtype. +<p> +SAMP_SETUSERHANDLER -- Set the user-interface handler for the mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00475">samp_Subscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="bc319b97b3dbea29bd79c4f723db5438"></a><!-- doxytag: member="samp.h::samp_specLoadHandler" ref="bc319b97b3dbea29bd79c4f723db5438" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_specLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a spectrum.load.* message. +<p> +SAMP_SPECLOADHANDLER -- Handle a spectrum.load.* message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4869a1bb04a96514f153dc5bfbed8e6e"></a><!-- doxytag: member="samp.h::samp_specLoadSSAGeneric" ref="4869a1bb04a96514f153dc5bfbed8e6e" args="(handle_t handle, String recip, String url, Map meta, String spectrumId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_specLoadSSAGeneric </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>meta</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>spectrumId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Load a generic spectrum from an SSA service. +<p> +SAMP_SPECLOADSSAGENERIC -- Load a generic spectrum from an SSA service.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>name of recipient (or 'all') </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL of spectrum to load </td></tr> + <tr><td valign="top"></td><td valign="top"><em>meta</em> </td><td>Metadata map describing data found at the URL </td></tr> + <tr><td valign="top"></td><td valign="top"><em>spectrumId</em> </td><td>Identifier for spectrum (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name used to label spectrum (optional); </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="dd2bca8fa3bf3b4ebbf449edc6b65d85"></a><!-- doxytag: member="samp.h::samp_specSSAHandler" ref="dd2bca8fa3bf3b4ebbf449edc6b65d85" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_specSSAHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a spectrum.load.ssa-generic message. +<p> +SAMP_SPECSSAHANDLER -- Handle a spectrum.load.ssa-generic message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="2e342b672e77e012cc98a6f5506a44be"></a><!-- doxytag: member="samp.h::samp_StatusHandler" ref="2e342b672e77e012cc98a6f5506a44be" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_StatusHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return status of the task. +<p> +SAMP_STATUSHANDLER -- Return status of the task.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="c6b76655d73825acdacfac8b5a1139ee"></a><!-- doxytag: member="samp.h::samp_Subscribe" ref="c6b76655d73825acdacfac8b5a1139ee" args="(handle_t handle, String mtype, void *func)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_Subscribe </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>userFunc</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Subscribe to a given mtype. +<p> +SAMP_SUBSCRIBE -- Subscribe to a given mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0503d3ee247a6a962a2a8da672261ab7"></a><!-- doxytag: member="samp.h::samp_tableHighlightRow" ref="0503d3ee247a6a962a2a8da672261ab7" args="(handle_t handle, String recip, String tableId, String url, int row)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_tableHighlightRow </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>row</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to highlight a table row. +<p> +SAMP_TABLEHIGHLIGHTROW -- Tell an app to highlight a table row.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID associated with a previously loaded table </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>rows</em> </td><td>List of (zero-based) row indices </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="6b950e53c7fdf481a13c8a2ec353dca1"></a><!-- doxytag: member="samp.h::samp_tableLoadFITS" ref="6b950e53c7fdf481a13c8a2ec353dca1" args="(handle_t handle, String recip, String url, String tableId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_tableLoadFITS </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to load a FITS table. +<p> +SAMP_TABLELOADFITS -- Tell an app to load a FITS table.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID assigned to table (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name assigned to table (optional) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="45c2023312cd2adfa40feb2eb8a3e143"></a><!-- doxytag: member="samp.h::samp_tableLoadVOTable" ref="45c2023312cd2adfa40feb2eb8a3e143" args="(handle_t handle, String recip, String url, String tableId, String name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_tableLoadVOTable </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to load a VOTable. +<p> +SAMP_TABLELOADVOTABLE -- Tell an app to load a VOTable.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID assigned to table (optional) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name assigned to table (optional) </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="a410ef908863f7c5b2c99844ebb73d35"></a><!-- doxytag: member="samp.h::samp_tableSelectRowList" ref="a410ef908863f7c5b2c99844ebb73d35" args="(handle_t handle, String recip, String tableId, String url, int rows[], int nrows)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_tableSelectRowList </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>recip</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>tableId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>url</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>rows</em>[], </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>nrows</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Tell an app to select a list of table rows. +<p> +SAMP_TABLESELECTROWLIST -- Tell an app to select a list of table rows.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>recip</em> </td><td>Message recipient (or "all" for broadcast) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tableId</em> </td><td>ID associated with a previously loaded table </td></tr> + <tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>URL to table to be loaded </td></tr> + <tr><td valign="top"></td><td valign="top"><em>rows</em> </td><td>Array of (zero-based) row indices </td></tr> + <tr><td valign="top"></td><td valign="top"><em>nrows</em> </td><td>Number of rows </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="d9184eb45a5bc93b5205fd5b1c6ef688"></a><!-- doxytag: member="samp.h::samp_tbHighlightHandler" ref="d9184eb45a5bc93b5205fd5b1c6ef688" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbHighlightHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a table.highlight.row message. +<p> +SAMP_TBHIGHLIGHTHANDLER -- Handle a table.highlight.row message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="750c0fee0c7a99e135299c08751f288c"></a><!-- doxytag: member="samp.h::samp_tbLoadFITSHandler" ref="750c0fee0c7a99e135299c08751f288c" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbLoadFITSHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a generic table.load.fits message. +<p> +SAMP_TBLOADFITSHANDLER -- Handle a generic table.load.fits message *<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="26f96dc6cbf72283e2ee9cb8b4619ed3"></a><!-- doxytag: member="samp.h::samp_tbLoadHandler" ref="26f96dc6cbf72283e2ee9cb8b4619ed3" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbLoadHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a generic table.load.* message. +<p> +SAMP_TBLOADHANDLER -- Handle a generic table.load.* message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00621">samp_tbLoadFITSHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00663">samp_tbLoadVOTHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="144ec2329355d91022d5ea38736c0093"></a><!-- doxytag: member="samp.h::samp_tbLoadVOTHandler" ref="144ec2329355d91022d5ea38736c0093" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbLoadVOTHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a generic table.load.votable message. +<p> +SAMP_TBLOADVOTHANDLER -- Handle a generic table.load.votable message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="98d68d7091c0b7790631bb53e0ace656"></a><!-- doxytag: member="samp.h::samp_tbSelectHandler" ref="98d68d7091c0b7790631bb53e0ace656" args="(String sender, String mtype, String msg_id, Map msg_map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int samp_tbSelectHandler </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>msg_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>msg_map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Handle a table.select.rowList message. +<p> +SAMP_TBSELECTHANDLER -- Handle a table.select.rowList message<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>sender</em> </td><td>sender name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype string </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_id</em> </td><td>message id </td></tr> + <tr><td valign="top"></td><td valign="top"><em>msg_map</em> </td><td>message map struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="5e3a44429f332694cc2cedc2e38856ce"></a><!-- doxytag: member="samp.h::samp_UnRegister" ref="5e3a44429f332694cc2cedc2e38856ce" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">stat samp_UnRegister </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Un-Register from the hub. +<p> +SAMP_UNREGISTER -- Un-Register from the hub.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>samp struct handle </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>SAMP_OK or SAMP_ERR </dd></dl> + +</div> +</div><p> +<a class="anchor" name="b3fded97bbbf3751c4916543959f16a5"></a><!-- doxytag: member="samp.h::samp_Unsubscribe" ref="b3fded97bbbf3751c4916543959f16a5" args="(handle_t handle, String mtype)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void samp_Unsubscribe </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>mtype</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Unsubscribe to a given mtype. +<p> +SAMP_UNSUBSCRIBE -- Unsubscribe to a given mtype.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>mtype</em> </td><td>mtype name </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="123413db26ad50a84bd41863af5deae5"></a><!-- doxytag: member="samp.h::sampClose" ref="123413db26ad50a84bd41863af5deae5" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void sampClose </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Close the SAMP interface and free resources. +<p> +SAMP_CLOSE -- Close the SAMP interface.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="124214f79e99619b377d98ed2fd93eb9"></a><!-- doxytag: member="samp.h::sampDebug" ref="124214f79e99619b377d98ed2fd93eb9" args="(handle_t handle, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int sampDebug </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set interface debug level. +<p> +SAMPDEBUG -- Set interface debug level.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>debug value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00203">Samp::debug</a>, and <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +</div> +</div><p> +<a class="anchor" name="30f39c72c3783055faa82ad3860f3d1d"></a><!-- doxytag: member="samp.h::sampInit" ref="30f39c72c3783055faa82ad3860f3d1d" args="(String appName, String description)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t sampInit </td> + <td>(</td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>appName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> </td> + <td class="paramname"> <em>description</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Initialize the SAMP interface. +<p> +Prototype declarations.<p> +SAMP_INIT -- Initialize the SAMP interface.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>appName</em> </td><td>application name </td></tr> + <tr><td valign="top"></td><td valign="top"><em>description</em> </td><td>description of application </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>samp handle </dd></dl> + +</div> +</div><p> +<a class="anchor" name="329a8a5f83162ed49baa28f008131d45"></a><!-- doxytag: member="samp.h::sampLog" ref="329a8a5f83162ed49baa28f008131d45" args="(handle_t handle, char *format,...)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sampLog </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>format</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"> <em>...</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP message logger. +<p> +SAMPLOG -- SAMP message logger.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>SAMP handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>message format string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="65908d088c8b917d10db38c147590ad9"></a><!-- doxytag: member="samp.h::sampShutdown" ref="65908d088c8b917d10db38c147590ad9" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int sampShutdown </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Shut down the active SAMP interface. +<p> +SAMP_SHUTDOWN -- Shut down the active SAMP interface.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="8e18ae12df031094ace47863f93b3634"></a><!-- doxytag: member="samp.h::sampStartup" ref="8e18ae12df031094ace47863f93b3634" args="(handle_t handle)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int sampStartup </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Startup the SAMP interface to send/receive messages. +<p> +SAMP_STARTUP -- Startup the SAMP interface to send/receive messages.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +</div> +</div><p> +<a class="anchor" name="65e3987c9b510018dcdd91203b437e40"></a><!-- doxytag: member="samp.h::sampTrace" ref="65e3987c9b510018dcdd91203b437e40" args="(handle_t handle, char *format,...)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sampTrace </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>format</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"> </td> + <td class="paramname"> <em>...</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +SAMP tracer. +<p> +SAMPTRACE -- SAMP tracer.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>SAMP handle </td></tr> + <tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>message format string </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>Referenced by <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, <a class="el" href="samp_8c_source.html#l00145">sampClose()</a>, and <a class="el" href="samp_8c_source.html#l00079">sampInit()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c0c812e5d3f2c9ee6c54067e4c81b3dd"></a><!-- doxytag: member="samp.h::sampVerbose" ref="c0c812e5d3f2c9ee6c54067e4c81b3dd" args="(handle_t handle, int value)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int sampVerbose </td> + <td>(</td> + <td class="paramtype">handle_t </td> + <td class="paramname"> <em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"> <em>value</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set interface debug level. +<p> +SAMPVERBOSE -- Set interface verbose level.<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>user handle to samp struct </td></tr> + <tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>verbose value </td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>nothing </dd></dl> + +<p>References <a class="el" href="samp_8h_source.html#l00204">Samp::verbose</a>.</p> + +</div> +</div><p> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/samp_8h_source.html b/vendor/voclient/libsamp/doc/html/samp_8h_source.html new file mode 100644 index 00000000..9474ec50 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/samp_8h_source.html @@ -0,0 +1,481 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: samp.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +<h1>samp.h</h1><a href="samp_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 +<a name="l00011"></a>00011 <span class="preprocessor">#include <xmlrpc-c/base.h></span> <span class="comment">/* XMLRPC-C interface */</span> +<a name="l00012"></a>00012 <span class="preprocessor">#include <xmlrpc-c/client.h></span> +<a name="l00013"></a>00013 <span class="preprocessor">#include <xmlrpc-c/server.h></span> +<a name="l00014"></a>00014 <span class="preprocessor">#include <xmlrpc-c/server_abyss.h></span> +<a name="l00015"></a>00015 <span class="preprocessor">#include <sys/types.h></span> <span class="comment">/* for struct stat */</span> +<a name="l00016"></a>00016 <span class="preprocessor">#include <sys/stat.h></span> +<a name="l00017"></a>00017 <span class="preprocessor">#include <unistd.h></span> +<a name="l00018"></a>00018 +<a name="l00019"></a>00019 <span class="preprocessor">#include "xrpc.h"</span> <span class="comment">/* XRPC Wrapper Definitions */</span> +<a name="l00020"></a>00020 +<a name="l00021"></a>00021 <span class="preprocessor">#ifndef SZ_NAME</span> +<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define SZ_NAME 256 </span> +<a name="l00023"></a>00023 <span class="preprocessor">#endif</span> +<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#ifndef SZ_LINE</span> +<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define SZ_LINE 256 </span> +<a name="l00026"></a>00026 <span class="preprocessor">#endif</span> +<a name="l00027"></a>00027 <span class="preprocessor"></span> +<a name="l00028"></a>00028 <span class="preprocessor">#define SZ_SECRET 64 </span> +<a name="l00029"></a>00029 <span class="preprocessor">#define SZ_DESC 8192 </span> +<a name="l00030"></a>00030 <span class="preprocessor">#define SZ_URL 1024 </span> +<a name="l00031"></a>00031 <span class="preprocessor">#define SZ_CMD 1024 </span> +<a name="l00032"></a>00032 <span class="preprocessor">#define SZ_SBUF 65536 </span> +<a name="l00033"></a>00033 <span class="preprocessor">#define SZ_RESSTR 1024 </span> +<a name="l00035"></a>00035 <span class="preprocessor">#define DEF_PORT 9876 </span> +<a name="l00036"></a>00036 <span class="preprocessor">#define DEF_TIMEOUT "15" </span> +<a name="l00038"></a>00038 <span class="preprocessor">#define MAX_SAMPS 16 </span> +<a name="l00039"></a>00039 <span class="preprocessor">#define MAX_HUBS 16 </span> +<a name="l00040"></a>00040 <span class="preprocessor">#define MAX_MDATTRS 32 </span> +<a name="l00041"></a>00041 <span class="preprocessor">#define MAX_SUBS 256 </span> +<a name="l00042"></a>00042 <span class="preprocessor">#define MAX_CLIENTS 32 </span> +<a name="l00043"></a>00043 <span class="preprocessor">#define MAX_ROWS 256 </span> +<a name="l00045"></a>00045 <span class="preprocessor">#define SAMP_ERR -1 </span> +<a name="l00046"></a>00046 <span class="preprocessor">#define SAMP_PENDING 0 </span> +<a name="l00047"></a>00047 <span class="preprocessor">#define SAMP_OK 1 </span> +<a name="l00049"></a>00049 <span class="preprocessor">#define SAMP_CBR 0 </span> +<a name="l00050"></a>00050 <span class="preprocessor">#define SAMP_CBV 1 </span> +<a name="l00052"></a>00052 <span class="preprocessor">#define SAMP_SYNCH 0 </span> +<a name="l00053"></a>00053 <span class="preprocessor">#define SAMP_ASYNCH 1 </span> +<a name="l00054"></a>00054 <span class="preprocessor">#define SAMP_NOTIFY 2 </span> +<a name="l00056"></a>00056 <span class="preprocessor">#define SAMP_INT TY_INT </span><span class="comment">/* values from xrpcP.h */</span> +<a name="l00057"></a>00057 <span class="preprocessor">#define SAMP_DOUBLE TY_DOUBLE</span> +<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="preprocessor">#define SAMP_BOOL TY_BOOL</span> +<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="preprocessor">#define SAMP_STRING TY_STRING</span> +<a name="l00060"></a>00060 <span class="preprocessor"></span><span class="preprocessor">#define SAMP_DATETIME TY_DATETIME</span> +<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor">#define SAMP_SAMPRUCT TY_STRUCT</span> +<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor">#define SAMP_ARRAY TY_ARRAY</span> +<a name="l00063"></a>00063 <span class="preprocessor"></span> +<a name="l00064"></a>00064 <span class="preprocessor">#define SAMP_TRACE 0 </span> +<a name="l00070"></a><a class="code" href="samp_8h.html#fc367e0d449c3afa2d429eedc85407aa">00070</a> <span class="preprocessor">#define HUB_SHUTDOWN 0 </span> +<a name="l00071"></a>00071 <span class="preprocessor">#define HUB_REGISTER 1 </span> +<a name="l00072"></a>00072 <span class="preprocessor">#define HUB_UNREGISTER 2 </span> +<a name="l00073"></a>00073 <span class="preprocessor">#define HUB_SUBSCRIPTIONS 3 </span> +<a name="l00074"></a>00074 <span class="preprocessor">#define HUB_METADATA 4 </span> +<a name="l00075"></a>00075 <span class="preprocessor">#define HUB_DISCONNECT 5 </span> +<a name="l00078"></a>00078 <span class="preprocessor">#define LEN_DESC 32768 </span> +<a name="l00080"></a>00080 <span class="preprocessor">#ifdef min</span> +<a name="l00081"></a>00081 <span class="preprocessor"></span><span class="preprocessor">#undef min</span> +<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="preprocessor">#endif</span> +<a name="l00083"></a>00083 <span class="preprocessor"></span><span class="preprocessor">#ifdef max</span> +<a name="l00084"></a>00084 <span class="preprocessor"></span><span class="preprocessor">#undef max</span> +<a name="l00085"></a>00085 <span class="preprocessor"></span><span class="preprocessor">#endif</span> +<a name="l00086"></a>00086 <span class="preprocessor"></span> +<a name="l00087"></a>00087 <span class="preprocessor">#define min(a,b) (a<b?a:b)</span> +<a name="l00088"></a>00088 <span class="preprocessor"></span><span class="preprocessor">#define max(a,b) (a>b?a:b)</span> +<a name="l00089"></a>00089 <span class="preprocessor"></span> +<a name="l00090"></a>00090 +<a name="l00091"></a>00091 <span class="keyword">typedef</span> <span class="keywordtype">long</span> handle_t; +<a name="l00092"></a><a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">00092</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a>; +<a name="l00093"></a><a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">00093</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a>; +<a name="l00094"></a><a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">00094</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a>; +<a name="l00095"></a><a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">00095</a> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a>; +<a name="l00096"></a><a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">00096</a> <span class="keyword">typedef</span> <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a>; +<a name="l00102"></a><a class="code" href="structappMD.html">00102</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00103"></a>00103 <span class="keywordtype">char</span> name[SZ_LINE]; +<a name="l00104"></a><a class="code" href="structappMD.html#fe527cb05f296f8e8b8144bf444beffd">00104</a> <span class="keywordtype">char</span> desc[SZ_DESC]; +<a name="l00105"></a><a class="code" href="structappMD.html#8ff19215559267a838fe300ca4f743a7">00105</a> <span class="keywordtype">char</span> iconURL[SZ_URL]; +<a name="l00106"></a><a class="code" href="structappMD.html#53945cba18e159fcdd4fb627b1d1d312">00106</a> <span class="keywordtype">char</span> docURL[SZ_URL]; +<a name="l00108"></a><a class="code" href="structappMD.html#652f4b568b3de167fa0886613c8c6656">00108</a> <span class="keywordtype">char</span> *descHTML; +<a name="l00110"></a><a class="code" href="structappMD.html#4b9f5ebb7d20beb53a7bfe192009e89a">00110</a> <span class="keywordtype">int</span> nkeys; +<a name="l00111"></a><a class="code" href="structappMD.html#cf4d62dbfeb28cb8c503d6a4d1598a8d">00111</a> <span class="keywordtype">char</span> *aKey[MAX_MDATTRS]; +<a name="l00112"></a><a class="code" href="structappMD.html#13ae9876a351aee3fe5b861733aff77a">00112</a> <span class="keywordtype">char</span> *aVal[MAX_MDATTRS]; +<a name="l00113"></a>00113 } <a class="code" href="structappMD.html">appMD</a>, *<a class="code" href="structappMD.html">appMDP</a>; +<a name="l00114"></a>00114 +<a name="l00115"></a>00115 +<a name="l00116"></a>00116 +<a name="l00120"></a><a class="code" href="structSubs.html">00120</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00121"></a>00121 <span class="keywordtype">char</span> mtype[SZ_LINE]; +<a name="l00122"></a>00122 int (*userFunc)(<span class="keywordtype">void</span> *p); +<a name="l00124"></a>00124 int (*sampFunc)(<span class="keywordtype">char</span> *sid, <span class="keywordtype">char</span> *sender, <span class="keywordtype">char</span> *msgid, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00125"></a>00125 } <a class="code" href="structSubs.html">Subs</a>, *<a class="code" href="structSubs.html">SubsP</a>; +<a name="l00126"></a>00126 +<a name="l00127"></a>00127 +<a name="l00128"></a>00128 +<a name="l00132"></a><a class="code" href="structClient.html">00132</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00133"></a>00133 <span class="keywordtype">char</span> pubId[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00134"></a><a class="code" href="structClient.html#67f4b49f5eda3f6cf1ff33a6fe883bf6">00134</a> <span class="keywordtype">char</span> name[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00135"></a>00135 } <a class="code" href="structClient.html">Client</a>, *<a class="code" href="structClient.html">ClientP</a>; +<a name="l00136"></a>00136 +<a name="l00137"></a>00137 +<a name="l00142"></a><a class="code" href="structHub.html">00142</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00143"></a>00143 <span class="keywordtype">char</span> appName[SZ_LINE]; +<a name="l00144"></a><a class="code" href="structHub.html#b6cbad1270ab46610f03837d4a01648f">00144</a> <span class="keywordtype">char</span> appVer[SZ_LINE]; +<a name="l00145"></a><a class="code" href="structHub.html#d96b607b83480697b7147f95f84132fb">00145</a> <span class="keywordtype">char</span> description[SZ_LINE]; +<a name="l00147"></a><a class="code" href="structHub.html#cfe9051f3f0d6fd908ddf394283d1262">00147</a> <a class="code" href="structappMD.html">appMD</a> meta; +<a name="l00149"></a><a class="code" href="structHub.html#52a6b65f54e98c4f3b7441808e30fa6c">00149</a> <span class="keywordtype">char</span> secret[SZ_SECRET]; +<a name="l00150"></a><a class="code" href="structHub.html#81adb6d0cab27f61c0aaebbb7b7685e4">00150</a> <span class="keywordtype">char</span> url[SZ_URL]; +<a name="l00151"></a><a class="code" href="structHub.html#0e07ef26e39ed1282042364297591df5">00151</a> <span class="keywordtype">char</span> version[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00153"></a><a class="code" href="structHub.html#3546ac45740591096b9bdc4c37b8d5f5">00153</a> <span class="keywordtype">int</span> id; +<a name="l00155"></a><a class="code" href="structHub.html#83ae1eed61525e4dd8795d7076b9a844">00155</a> <span class="keywordtype">char</span> appId[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00156"></a><a class="code" href="structHub.html#53b0a5acf4419ffff98c6510e84a9f62">00156</a> <span class="keywordtype">char</span> privateKey[SZ_LINE]; +<a name="l00157"></a><a class="code" href="structHub.html#c5ecb8cd6b3d61ab9e0fddfb643c65c3">00157</a> <span class="keywordtype">char</span> hubId[SZ_LINE]; +<a name="l00158"></a><a class="code" href="structHub.html#ce254c7adba1a20deb1dff7e112dd2a8">00158</a> <span class="keywordtype">char</span> selfId[SZ_LINE]; +<a name="l00159"></a><a class="code" href="structHub.html#b69adb014b0cef61d6632e60fb2dff5b">00159</a> <span class="keywordtype">char</span> timeout[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00161"></a><a class="code" href="structHub.html#cfd1b13e1f462d6595ce4e0b5ab08cb9">00161</a> <span class="keywordtype">void</span> *samp; +<a name="l00162"></a>00162 } <a class="code" href="structHub.html">Hub</a>, *<a class="code" href="structHub.html">HubP</a>; +<a name="l00163"></a>00163 +<a name="l00164"></a>00164 +<a name="l00170"></a><a class="code" href="structSamp.html">00170</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00171"></a>00171 <span class="keywordtype">char</span> appName[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00172"></a><a class="code" href="structSamp.html#df7c497b6dbffc08e8ef5d7edd4ee97e">00172</a> <span class="keywordtype">char</span> appVer[SZ_LINE]; +<a name="l00173"></a><a class="code" href="structSamp.html#d672d7d425e8180b93c7ca2229d1acd8">00173</a> <span class="keywordtype">char</span> description[<a class="code" href="sampDecl_8h.html#6fc88d7dbc85d8d10379f58c910ce847">SZ_NAME</a>]; +<a name="l00175"></a><a class="code" href="structSamp.html#62629ad2155a2a1a7676e32ef9fb9ffd">00175</a> <span class="keywordtype">char</span> errortxt[SZ_LINE]; +<a name="l00177"></a><a class="code" href="structSamp.html#0884021074d1ed14342187005e0b78e7">00177</a> <a class="code" href="structappMD.html">appMD</a> meta; +<a name="l00179"></a><a class="code" href="structSamp.html#e7db0cac0c4ad61c9ed7f3d344b623cf">00179</a> pthread_t svrThread; +<a name="l00182"></a>00182 int (*defaultUserFunc)(<span class="keywordtype">char</span> *sender, <span class="keywordtype">char</span> *msgid, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00183"></a>00183 +<a name="l00184"></a>00184 <a class="code" href="structSubs.html">Subs</a> subs[MAX_SUBS]; +<a name="l00185"></a><a class="code" href="structSamp.html#36f4cfae3407b8961e57a77abca7d599">00185</a> <span class="keywordtype">int</span> nsubs; +<a name="l00187"></a><a class="code" href="structSamp.html#2cc1f00b9e4bae456e0e72b90147df7b">00187</a> <a class="code" href="structClient.html">Client</a> clients[MAX_CLIENTS]; +<a name="l00188"></a><a class="code" href="structSamp.html#97ef8ad57159f4b6c4fcd93a12853b69">00188</a> <span class="keywordtype">int</span> nclients; +<a name="l00190"></a><a class="code" href="structSamp.html#69b05b2fa1ab19729d81659ad64387a0">00190</a> <span class="keywordtype">int</span> serverTid; +<a name="l00191"></a><a class="code" href="structSamp.html#8849cb13cbedae805b4e35327bc449e2">00191</a> <span class="keywordtype">int</span> serverPort; +<a name="l00193"></a><a class="code" href="structSamp.html#14811ec2253a6e2e75a8ec863c4150b0">00193</a> <a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>; +<a name="l00194"></a><a class="code" href="structSamp.html#03918136809ece7e60de4e30c64b6224">00194</a> handle_t hubHandle; +<a name="l00195"></a><a class="code" href="structSamp.html#723b2538cfd65122c49783b36a7d30b5">00195</a> <span class="keywordtype">int</span> hubThreadID; +<a name="l00197"></a><a class="code" href="structSamp.html#32402da48b11693c13252edbdca7673c">00197</a> <span class="keywordtype">int</span> active; +<a name="l00198"></a><a class="code" href="structSamp.html#c8eee2b56f226f59d814fd1baa751b77">00198</a> <span class="keywordtype">int</span> mapClients; +<a name="l00199"></a><a class="code" href="structSamp.html#30ca22535582e7bf6416627d1cd46525">00199</a> <span class="keywordtype">int</span> msgMode; +<a name="l00200"></a><a class="code" href="structSamp.html#14f6ed59a947504d37bd8cdd1f2f8e8d">00200</a> <span class="keywordtype">int</span> handlerMode; +<a name="l00202"></a><a class="code" href="structSamp.html#79f2ee1f48cb40edaf9b63ccdbb6942f">00202</a> FILE *logfd; +<a name="l00203"></a><a class="code" href="structSamp.html#d8469d2447cd872101fb83d92f85049e">00203</a> <span class="keywordtype">int</span> debug; +<a name="l00204"></a><a class="code" href="structSamp.html#981b01bd09deddb039db3567825bd653">00204</a> <span class="keywordtype">int</span> verbose; +<a name="l00205"></a><a class="code" href="structSamp.html#25ddaf846639c7c67ea651a578b804ad">00205</a> <span class="keywordtype">int</span> trace; +<a name="l00206"></a>00206 } <a class="code" href="structSamp.html">Samp</a>, *<a class="code" href="structSamp.html">SampP</a>; +<a name="l00207"></a>00207 +<a name="l00208"></a>00208 +<a name="l00209"></a>00209 <span class="preprocessor">#define MSG_SYNC 0</span> +<a name="l00210"></a>00210 <span class="preprocessor"></span><span class="preprocessor">#define MSG_ASYNC 1</span> +<a name="l00211"></a>00211 <span class="preprocessor"></span><span class="preprocessor">#define MSG_NOTIFY 2</span> +<a name="l00212"></a>00212 <span class="preprocessor"></span><span class="preprocessor">#define DEF_CALLMODE MSG_ASYNC</span> +<a name="l00213"></a>00213 <span class="preprocessor"></span> +<a name="l00214"></a>00214 +<a name="l00215"></a>00215 +<a name="l00220"></a>00220 <span class="comment">/******************************************************************************</span> +<a name="l00221"></a>00221 <span class="comment"> ** Public Interface Methods</span> +<a name="l00222"></a>00222 <span class="comment"> *****************************************************************************/</span> +<a name="l00223"></a>00223 +<a name="l00224"></a>00224 <span class="comment">/* samp.c -- Methods called by user apps to initialize the interface.</span> +<a name="l00225"></a>00225 <span class="comment"> */</span> +<a name="l00226"></a>00226 handle_t <a class="code" href="samp_8c.html#db03c60f2933ed9785bfb4457c359af2" title="Initialize the SAMP interface.">sampInit</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> description); +<a name="l00227"></a>00227 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#1428f653b9502c6e6d540f873de2b24f" title="Set a metadata field value for the application.">samp_Metadata</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> field, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value); +<a name="l00228"></a>00228 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#ed050606c5076a4a34eb8f0f982a25d4" title="Subscribe to a given mtype.">samp_Subscribe</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <span class="keywordtype">void</span> *func); +<a name="l00229"></a>00229 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#dc0e418fbaee507e661260c4480ecfcd" title="Unsubscribe to a given mtype.">samp_Unsubscribe</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00230"></a>00230 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#1f6d544576fec785be1acfeaf3f2cf63" title="Startup the SAMP interface to send/receive messages.">sampStartup</a> (handle_t handle); +<a name="l00231"></a>00231 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#d634392fbb12cf4e1b2eb05da34759c5" title="Shut down the active SAMP interface.">sampShutdown</a> (handle_t handle); +<a name="l00232"></a>00232 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#6bfd947988e5dbc846af7f99bcd99ee7" title="Set interface debug level.">sampDebug</a> (handle_t handle, <span class="keywordtype">int</span> value); +<a name="l00233"></a>00233 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#e3a6e918b3fe22db2fe014da16f81aad" title="Set interface debug level.">sampVerbose</a> (handle_t handle, <span class="keywordtype">int</span> value); +<a name="l00234"></a>00234 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#f861f637942c5f971bab824708581f82" title="Close the SAMP interface and free resources.">sampClose</a> (handle_t handle); +<a name="l00235"></a>00235 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#b2f9c71819e1956e1c29e969968f453c" title="Determine if the Hub is active (i.e. connected).">samp_hubActive</a> (handle_t handle); +<a name="l00236"></a>00236 <span class="keywordtype">int</span> samp_setOpt (handle_t handle, <span class="keywordtype">char</span> *opt, <span class="keywordtype">int</span> value); +<a name="l00237"></a>00237 +<a name="l00238"></a>00238 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#d636ae12dd05df43a077f91882a197ec" title="Set the calling mode to use synchronous messaging.">samp_setSyncMode</a> (handle_t handle); +<a name="l00239"></a>00239 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#9b2292b819e590b1f7c63bbdfaa09e31" title="Set the calling mode to use asynchronous messaging.">samp_setASyncMode</a> (handle_t handle); +<a name="l00240"></a>00240 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#7bfbc2e767fe234f83c13b8316a09ecd" title="Set the calling mode to use notification messaging.">samp_setNotifyMode</a> (handle_t handle); +<a name="l00241"></a>00241 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#01721eabf3e664bae3bea0c2b72268e2" title="Set the message pattern to the specified mode.">samp_setMsgMode</a> (handle_t handle, <span class="keywordtype">int</span> mode); +<a name="l00242"></a>00242 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#b6b49029386c3efd0520daa93a4ab3eb" title="Have interface call user handlers by reference.">samp_setCallByRef</a> (handle_t handle); +<a name="l00243"></a>00243 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#3e01437224c73b91e49c6428cb69735d" title="Set the default calling mode (synch or asynch).">samp_setCallMode</a> (handle_t handle, <span class="keywordtype">int</span> mode); +<a name="l00244"></a>00244 +<a name="l00245"></a>00245 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#a3c0bdb4c512357dbc53b0ad7a7d5b01" title="Set the Reply callback. samp_setReplyCallback (handle_t handle, int *func).">samp_setReplyCallback</a> (handle_t handle, <span class="keywordtype">int</span> *func); +<a name="l00246"></a>00246 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#3db66f28546459327665f8491ea97f4d" title="Set the Response callback. samp_setResponseCallback (handle_t handle, int *func)...">samp_setResponseCallback</a> (handle_t handle, <span class="keywordtype">int</span> *func); +<a name="l00247"></a>00247 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#c057d32437a96a527c63f938757099af" title="Set the message timeout value (in seconds).">samp_setTimeout</a> (handle_t handle, <span class="keywordtype">int</span> timeout); +<a name="l00248"></a>00248 <span class="keywordtype">void</span> samp_setAppName (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00249"></a>00249 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#0f50f8dbae701aa6b19912fc99f6475a" title="Set the application name string.">samp_setAppVersion</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> version); +<a name="l00250"></a>00250 +<a name="l00251"></a>00251 <span class="keywordtype">void</span> <a class="code" href="samp_8c.html#114bf9fb0d3e6eabd8bb93f3c87f5233" title="The interface&#39;s default Reply handler.">samp_defaultReplyHandler</a> (handle_t handle); +<a name="l00252"></a>00252 <span class="keywordtype">void</span> samp_deaultfResponseHandler (handle_t handle); +<a name="l00253"></a>00253 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#985afa0baeb135c9ee72d09394314ff1" title="Reply with the status of the last message sent.">samp_replyStatus</a> (handle_t handle); +<a name="l00254"></a>00254 +<a name="l00255"></a>00255 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#ff4d125fc9594be25984989fad2fd3c8">samp_mapClients</a> (handle_t handle); +<a name="l00256"></a>00256 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#1e494e73abe2ddfd946fb39e84da42a9">samp_listClients</a> (handle_t handle); +<a name="l00257"></a>00257 <span class="keywordtype">char</span> *samp_getClients (handle_t handle); +<a name="l00258"></a>00258 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#8a2111bbe4c88cef635e3bf67e899563">samp_addClient</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <span class="keywordtype">id</span>); +<a name="l00259"></a>00259 <span class="keywordtype">int</span> <a class="code" href="samp_8c.html#e30e492f306a40f853a454faf60ab479">samp_removeClient</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <span class="keywordtype">id</span>); +<a name="l00260"></a>00260 +<a name="l00261"></a>00261 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8c.html#f299ea13607279f60f16b8639a00658f">samp_getOKMap</a> (<span class="keywordtype">void</span>); +<a name="l00262"></a>00262 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8c.html#6bb8b1f5c6268ad8c7f165733d4af86d">samp_getNullMap</a> (<span class="keywordtype">void</span>); +<a name="l00263"></a>00263 +<a name="l00264"></a>00264 +<a name="l00265"></a>00265 <span class="comment">/* sampCommands.c -- Methods called to send messages to the Hub.</span> +<a name="l00266"></a>00266 <span class="comment"> */</span> +<a name="l00267"></a>00267 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#aef9c2f86c7e4f49fe3df343ef06f3ba" title="Register with the Hub using the currently stored metadata.">samp_Register</a> (handle_t handle); +<a name="l00268"></a>00268 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#5e3a44429f332694cc2cedc2e38856ce" title="Un-Register from the hub.">samp_UnRegister</a> (handle_t handle); +<a name="l00269"></a>00269 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#94cdccbcfa524fa515de77544b6c6eaa" title="(Re)Declare all of our metadata.">samp_DeclareMetadata</a> (handle_t handle); +<a name="l00270"></a>00270 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#7688cbf8ef852483c077be96151763a6" title="Ping the hub/app to see if it is alive (returns &gt;0).">samp_Ping</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> appName); +<a name="l00271"></a>00271 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8h.html#636e11796b78ae9881e7c61df8516d2a" title="Get the metadata for a specified app.">samp_GetMetadata</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId); +<a name="l00272"></a>00272 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#ef695801c121c6191d3af4574569ab8c" title="Declare the messages we&#39;re interested in.">samp_DeclareSubscriptions</a> (handle_t handle); +<a name="l00273"></a>00273 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> samp_GetSubscriptions (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId); +<a name="l00274"></a>00274 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#2c532e076dd6446f079691ed02197a57" title="Get public-ids of the registered clients.">samp_GetRegisteredClients</a> (handle_t handle); +<a name="l00275"></a>00275 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#d28a9085ab8cacbe978e300ac99f6ae5" title="Get clients matching the mtype subscription.">samp_GetSubscribedClients</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00276"></a>00276 +<a name="l00277"></a>00277 +<a name="l00278"></a>00278 <span class="comment">/* sampMType.c -- Methods called to send messages to other apps.</span> +<a name="l00279"></a>00279 <span class="comment"> */</span> +<a name="l00280"></a>00280 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#45c2023312cd2adfa40feb2eb8a3e143" title="Tell an app to load a VOTable.">samp_tableLoadVOTable</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, +<a name="l00281"></a>00281 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00282"></a>00282 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#6b950e53c7fdf481a13c8a2ec353dca1" title="Tell an app to load a FITS table.">samp_tableLoadFITS</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, +<a name="l00283"></a>00283 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00284"></a>00284 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#2ec386ef5bd7dee20ffa1fead0b0210a" title="Tell an app to load a FITS image.">samp_imageLoadFITS</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, +<a name="l00285"></a>00285 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> imageId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00286"></a>00286 +<a name="l00287"></a>00287 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#0503d3ee247a6a962a2a8da672261ab7" title="Tell an app to highlight a table row.">samp_tableHighlightRow</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, +<a name="l00288"></a>00288 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <span class="keywordtype">int</span> row); +<a name="l00289"></a>00289 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#a410ef908863f7c5b2c99844ebb73d35" title="Tell an app to select a list of table rows.">samp_tableSelectRowList</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tableId, +<a name="l00290"></a>00290 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, <span class="keywordtype">int</span> rows[], <span class="keywordtype">int</span> nrows); +<a name="l00291"></a>00291 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#0651eec8ddc8707bb8fbc4dfdcfff5e2" title="Tell an app to point at an RA/Dec coordinate.">samp_coordPointAtSky</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, +<a name="l00292"></a>00292 <span class="keywordtype">float</span> ra, <span class="keywordtype">float</span> dec); +<a name="l00293"></a>00293 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#4869a1bb04a96514f153dc5bfbed8e6e" title="Load a generic spectrum from an SSA service.">samp_specLoadSSAGeneric</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> url, +<a name="l00294"></a>00294 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> meta, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> spectrumId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00295"></a>00295 +<a name="l00296"></a>00296 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#be012673358bfd254e2c6ad9f6e92240" title="Execute a command in a remote application.">samp_cmdExec</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> cmd); +<a name="l00297"></a>00297 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#ba313c7608a7658c673065c83113ec5b" title="Get an environment variable in a remote application.">samp_envGet</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00298"></a>00298 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#e842347910a3cfd746def74b0fd564aa" title="Set an environment variable in a remote application.">samp_envSet</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value); +<a name="l00299"></a>00299 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#4c75de6ddcffde6e3dde7beea68de81c" title="Get a parameter variable in a remote application.">samp_paramGet</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00300"></a>00300 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#7a5c9f092b57dfb3206c8decc8558fd3" title="Set an parameter variable in a remote application.">samp_paramSet</a>(handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> value); +<a name="l00301"></a>00301 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#abeaa1ac9d09a666a9fa34a7d274483d" title="Exchange a bibcode.">samp_bibLoad</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> bibcode); +<a name="l00302"></a>00302 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#a0bb33d232fcb52aaa470d1f1b1a89d7" title="Exchange a resource list.">samp_resourceLoad</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> type, +<a name="l00303"></a>00303 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resMap); +<a name="l00304"></a>00304 +<a name="l00305"></a>00305 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#5837826e5b4e86b2dda0892c48b96faf" title="Send a geenric message.">samp_sendGeneric</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, +<a name="l00306"></a>00306 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> args[]); +<a name="l00307"></a>00307 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#4607721d55904450d4066c360d3dcddd" title="Send the specified message.">samp_sendMsg</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recip, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00308"></a>00308 +<a name="l00309"></a>00309 +<a name="l00310"></a>00310 +<a name="l00311"></a>00311 <span class="comment">/* sampClient.c -- Low-level methods to send messages.</span> +<a name="l00312"></a>00312 <span class="comment"> */</span> +<a name="l00313"></a>00313 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#c73788ae17493c4042948f6b861ddd74" title="Make a notify() call to the Hub.">samp_notify</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00314"></a>00314 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#a046d61f43fce831a71621f98b6d9741" title="Make a notifyAll() call to the Hub.">samp_notifyAll</a> (handle_t handle, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00315"></a>00315 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <a class="code" href="samp_8h.html#919cca4cfc557e0c05914b805401fbd3" title="Make a call() call to the Hub.">samp_call</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> tag, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00316"></a>00316 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#2cbf26c662884a4ae9587f7b9f4113a6" title="Make a callAll() call to the Hub.">samp_callAll</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00317"></a>00317 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#c69c39e8ee091c006289b486dee10711" title="Make a callAndWait() call to the Hub.">samp_callAndWait</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> recipId, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_tag, +<a name="l00318"></a>00318 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg); +<a name="l00319"></a>00319 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#89fc488147fe2e08b4f3c044c7079962" title="Reply to a message.">samp_Reply</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp); +<a name="l00320"></a>00320 +<a name="l00321"></a>00321 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <a class="code" href="samp_8h.html#0a61726448d9b1a026b20ff6beead44e" title="Get the Client name from a pubic-id.">samp_clientName</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> pubId); +<a name="l00322"></a>00322 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#3c026895e4d28567eb63c3b9cc16cd40" title="Set the error response string.">samp_setErr</a> (handle_t handle, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp); +<a name="l00323"></a>00323 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> <a class="code" href="samp_8h.html#fd8a4da020cd2fedaf70ae8af0b6a1c8" title="Get the error response string.">samp_getErr</a> (handle_t handle); +<a name="l00324"></a>00324 +<a name="l00325"></a>00325 +<a name="l00326"></a>00326 <span class="comment">/* sampMethods.c -- SAMP methods implemented by a callable client.</span> +<a name="l00327"></a>00327 <span class="comment"> */</span> +<a name="l00328"></a>00328 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#59f85e0fce4c9ae7121c98e137d3f743" title="test.echo method">samp_receiveCall</a> (<span class="keywordtype">void</span> *data); +<a name="l00329"></a>00329 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#03be7cc9e154a6ccdd499286df640936" title="receiveNotification () client method.">samp_receiveNotification</a> (<span class="keywordtype">void</span> *data); +<a name="l00330"></a>00330 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#754b50ad59145c7fd1e4c8f4277f11e4" title="receiveResponse () client method.">samp_receiveResponse</a> (<span class="keywordtype">void</span> *data); +<a name="l00331"></a>00331 +<a name="l00332"></a>00332 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#1cd88b9e964d61403d6aad89dddce591" title="Set the Samp Handler reply map.">samp_setHandlerReply</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> resp); +<a name="l00333"></a>00333 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8h.html#0a0d9e41bebb554869f099dcf142a7bf" title="Get the Samp Handler reply map.">samp_getHandlerReply</a> (<span class="keywordtype">void</span>); +<a name="l00334"></a>00334 +<a name="l00335"></a>00335 +<a name="l00336"></a>00336 <span class="comment">/* sampHandlers.c -- Handlers to responses from the message.</span> +<a name="l00337"></a>00337 <span class="comment"> */</span> +<a name="l00338"></a>00338 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#b969017f97d850b092bde60a2d445a2b" title="Set the user-interface handler for the mtype.">samp_setUserHandler</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <span class="keywordtype">void</span> *func); +<a name="l00339"></a>00339 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#8b83cf8a75c16c45c547be68f0bf9f64" title="Set the SAMP interface handler for the mtype.">samp_setSampHandler</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <span class="keywordtype">void</span> *func); +<a name="l00340"></a>00340 <span class="keywordtype">void</span> *<a class="code" href="samp_8h.html#ce2ea31b9bd82db4c5040ffd0511bd8b" title="Get the User handler for the named mtype.">samp_getUserHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00341"></a>00341 <span class="keywordtype">void</span> *<a class="code" href="samp_8h.html#f295f9e7746644f834ac54b1deb95b4c" title="Get the Samphandler for the named mtype.">samp_getSampHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00342"></a>00342 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#e09217f0e615e01dfcffbdebda2516e8" title="Execute the user-defined handler for the mtype.">samp_execUserHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, +<a name="l00343"></a>00343 <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params); +<a name="l00344"></a>00344 +<a name="l00345"></a>00345 <span class="keywordtype">int</span> samp_genericMsgHandler (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00346"></a>00346 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00347"></a>00347 +<a name="l00348"></a>00348 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#16d8b8822d169107b8702ae753797923" title="Is app alive and responding to messages?">samp_PingHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00349"></a>00349 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00350"></a>00350 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#2e342b672e77e012cc98a6f5506a44be" title="Return status of the task.">samp_StatusHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00351"></a>00351 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00352"></a>00352 +<a name="l00353"></a>00353 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#9bd8036dd65dc4f874f39568b691a123" title="Handle an image.load.fits message.">samp_imLoadHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00354"></a>00354 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00355"></a>00355 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#26f96dc6cbf72283e2ee9cb8b4619ed3" title="Handle a generic table.load.* message.">samp_tbLoadHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00356"></a>00356 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00357"></a>00357 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#750c0fee0c7a99e135299c08751f288c" title="Handle a generic table.load.fits message.">samp_tbLoadFITSHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00358"></a>00358 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00359"></a>00359 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#144ec2329355d91022d5ea38736c0093" title="Handle a generic table.load.votable message.">samp_tbLoadVOTHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00360"></a>00360 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00361"></a>00361 +<a name="l00362"></a>00362 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#d9184eb45a5bc93b5205fd5b1c6ef688" title="Handle a table.highlight.row message.">samp_tbHighlightHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00363"></a>00363 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00364"></a>00364 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#98d68d7091c0b7790631bb53e0ace656" title="Handle a table.select.rowList message.">samp_tbSelectHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00365"></a>00365 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00366"></a>00366 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#3f5632858a2b09759ffe98cd2e183cfb" title="Handle a coord.pointAt.sky message.">samp_pointAtHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00367"></a>00367 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00368"></a>00368 +<a name="l00369"></a>00369 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#bc319b97b3dbea29bd79c4f723db5438" title="Handle a spectrum.load.* message.">samp_specLoadHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00370"></a>00370 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00371"></a>00371 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#dd2bca8fa3bf3b4ebbf449edc6b65d85" title="Handle a spectrum.load.ssa-generic message.">samp_specSSAHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00372"></a>00372 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00373"></a>00373 +<a name="l00374"></a>00374 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#c57d19afc6fa0b4bc9c7a0fd50d0f54b" title="Handle a client.cmd.exec message.">samp_cmdExecHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00375"></a>00375 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00376"></a>00376 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#e25a92f57babd71d43653d7fcb81025c" title="Handle a client.env.set message.">samp_envGetHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00377"></a>00377 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00378"></a>00378 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#0910e6b9d11cdd3111c1f18450de394a" title="Handle a client.env.set message.">samp_envSetHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00379"></a>00379 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00380"></a>00380 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#659c272ce881662c1826a04728dc06f6" title="Handle a client.param.set message.">samp_paramGetHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00381"></a>00381 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00382"></a>00382 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#071aa9e32f2e94d5b667e87cf65d2bdf" title="Handle a client.param.set message.">samp_paramSetHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00383"></a>00383 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00384"></a>00384 +<a name="l00385"></a>00385 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#262bf09278c61b60b5189fef7f26d26b" title="Handle a bibcode.load message.">samp_bibcodeHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00386"></a>00386 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00387"></a>00387 +<a name="l00388"></a>00388 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#c0bf7cf7fea362c0c82ad7bc3f267c48" title="handle a voresource.loadlist message">samp_resLoadHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00389"></a>00389 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00390"></a>00390 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#287569451dc1bf59d1f9f6d13b56716d" title="handle a voresource.loadlist message">samp_resConeHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00391"></a>00391 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00392"></a>00392 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#8b2300222d7b11f144eb4385412e69a5" title="handle a voresource.loadlist message">samp_resSiapHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00393"></a>00393 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00394"></a>00394 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#866578a01c3b762435823b1b11869c42" title="handle a voresource.loadlist message">samp_resSsapHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00395"></a>00395 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00396"></a>00396 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#ad42ca17cbaf23012ad497559ea45e4c" title="handle a voresource.loadlist message">samp_resTapHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00397"></a>00397 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00398"></a>00398 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#fa207ebdc587ba5eeab60fbf79b635d4" title="handle a voresource.loadlist message">samp_resVOSpaceHandler</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00399"></a>00399 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> msg_map); +<a name="l00400"></a>00400 +<a name="l00401"></a>00401 <span class="keywordtype">void</span> samp_printMessage (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> sender, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> msg_id, +<a name="l00402"></a>00402 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params); +<a name="l00403"></a>00403 +<a name="l00404"></a>00404 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#a8a947c24f2c9333adf4e5d7fa11d134">samp_printMap</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00405"></a>00405 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#5361571754505eaefdf5739cd3e9519e">samp_nullResponse</a> (<span class="keywordtype">void</span> *data); +<a name="l00406"></a>00406 <span class="keywordtype">int</span> samp_testEcho (<span class="keywordtype">void</span> *data); +<a name="l00407"></a>00407 +<a name="l00408"></a>00408 +<a name="l00409"></a>00409 +<a name="l00410"></a>00410 <span class="comment">/******************************************************************************</span> +<a name="l00411"></a>00411 <span class="comment"> ** Internal Interface Methods</span> +<a name="l00412"></a>00412 <span class="comment"> *****************************************************************************/</span> +<a name="l00413"></a>00413 +<a name="l00414"></a>00414 <span class="comment">/* sampHub.c</span> +<a name="l00415"></a>00415 <span class="comment"> */</span> +<a name="l00416"></a>00416 handle_t <a class="code" href="samp_8h.html#ef92557afa5ed6731ac0a0a1ba6dfd7c" title="Discover and open a connection to the SAMP Hub.">samp_hubOpen</a> (<a class="code" href="structSamp.html">Samp</a> *samp); +<a name="l00417"></a>00417 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#39a580ced499e50d39d327f7709834e7" title="Close a connection to the Hub.">samp_hubClose</a> (handle_t handle); +<a name="l00418"></a>00418 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#d0343ad884d5a958d7d91928ad06a369" title="Get a list of available Hubs.">samp_getAvailableHubs</a> (handle_t handle); +<a name="l00419"></a>00419 <span class="keywordtype">char</span> *samp_getActiveHubName (handle_t handle); +<a name="l00420"></a>00420 <span class="keywordtype">int</span> samp_getActiveHub (handle_t handle); +<a name="l00421"></a>00421 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#a927eb8dcb67e245aeb5a8a4feeb6230">samp_hubRunning</a> (<span class="keywordtype">void</span>); +<a name="l00422"></a>00422 <span class="keywordtype">int</span> samp_hubInit (handle_t samp, <span class="keywordtype">char</span> *appName, <span class="keywordtype">char</span> *descr); +<a name="l00423"></a>00423 +<a name="l00424"></a>00424 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#265b5d07cce485a6979fe5f4a2217624" title="Determine the type of Hub event mtype.">samp_processHubEvent</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> params); +<a name="l00425"></a>00425 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#a48b9a99f22537127df46a94dfa9ae4a" title="Determine the type of Hub event mtype.">samp_hubEvent</a> (<a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00426"></a>00426 +<a name="l00427"></a>00427 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#77a14721e2373c805b58f69a018ea69c" title="Send a Register message to the Hub.">samp_hubRegister</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00428"></a>00428 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#b0c37311ca30e1fdadfdd1fd16ff3ab4" title="Send a UnRegister message to the Hub.">samp_hubUnRegister</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00429"></a>00429 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#6c7b8a8ff1f3c2435d153bc08da87dce" title="Send a samp.app.event.shutdown message to the Hub.">samp_hubSendShutdown</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00430"></a>00430 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#fc0bfbd699ab2cbce2f755a0506ca6dc" title="Set the client callback and send to Hub.">samp_hubSetXmlrpcCallback</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00431"></a>00431 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#155739318fa72883a3e32fccf8a6d5c9" title="Ping the Hub to see if it is alive.">samp_hubPing</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00432"></a>00432 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#bf1ae8a1c9c8cf520a22e6ea4d815712" title="Declare &quot;standard&quot; metadata to the Hub.">samp_hubDeclareMetadata</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00433"></a>00433 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#a6c0f67a76bd1f27898a66fe26b53fdd" title="Declare mtype subscriptions to the Hub.">samp_hubDeclareSubscriptions</a> (<a class="code" href="structHub.html">Hub</a> *<a class="code" href="samp_8c.html#d702b07240de0e0cf9e4b781a38317ad">hub</a>); +<a name="l00434"></a>00434 +<a name="l00435"></a>00435 +<a name="l00436"></a>00436 <span class="comment">/* sampList.c</span> +<a name="l00437"></a>00437 <span class="comment">*/</span> +<a name="l00438"></a>00438 handle_t <a class="code" href="samp_8h.html#cdc925da798ee7a1ce30427d47812bd2" title="Create a new List object.">samp_newList</a> (); +<a name="l00439"></a>00439 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#b162ae9b9f98da80f6bb5c34b5cbcbf6" title="Free the given List object.">samp_freeList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list); +<a name="l00440"></a>00440 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#c260afb0cbf19b427e3eba96a2341e52" title="Get number of elements in a List.">samp_listLen</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list); +<a name="l00441"></a>00441 +<a name="l00442"></a>00442 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#5b69180b036e58528c98b1cf5a42825a" title="Set a string in a List (append).">samp_setStringInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">char</span> *value); +<a name="l00443"></a>00443 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#ea188bb711f3b5549d11204b0ff2da08" title="Set a Map in a List (append).">samp_setMapInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00444"></a>00444 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#0ff97d44e62b7c88a046a29324552400" title="Set a List in another List (append).">samp_setListInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list1, <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list2); +<a name="l00445"></a>00445 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#2d8a8a26d7284bb211a933895cddd29c" title="Set an Int in a List (append).">samp_setIntInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> value); +<a name="l00446"></a>00446 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#041a551aff57ca03f3ff72a9803e2b58" title="Set a Float in a List (append).">samp_setFloatInList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">float</span> value); +<a name="l00447"></a>00447 +<a name="l00448"></a>00448 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#b101c5b1175490474e41ac9060bdaabf" title="Get a string from the List.">samp_getStringFromList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00449"></a>00449 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8h.html#33ca96ee3a8e7d26356c7b66f469da74" title="Get a Map from the List.">samp_getMapFromList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00450"></a>00450 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#b74e90fdfe79b1c4f7668fdb28d041a1" title="Get a List from the List.">samp_getListFromList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00451"></a>00451 <span class="keywordtype">int</span> samp_getIntFromList (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00452"></a>00452 <span class="keywordtype">float</span> <a class="code" href="samp_8h.html#cf9b570dd76203d2299ed7bdba048bb9" title="Get a Float from the List.">samp_getFloatFromList</a> (<a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list, <span class="keywordtype">int</span> index); +<a name="l00453"></a>00453 +<a name="l00454"></a>00454 +<a name="l00455"></a>00455 <span class="comment">/* sampMap.c</span> +<a name="l00456"></a>00456 <span class="comment">*/</span> +<a name="l00457"></a>00457 handle_t <a class="code" href="samp_8h.html#d88b5d5e9014deba8071f7defd220dbb" title="Create a new Map object.">samp_newMap</a> (<span class="keywordtype">void</span>); +<a name="l00458"></a>00458 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#fe80438de542c6657d623993360b37d1" title="Free the given Map object.">samp_freeMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00459"></a>00459 +<a name="l00460"></a>00460 <span class="keywordtype">int</span> samp_getMapSize (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map); +<a name="l00461"></a>00461 <span class="keywordtype">char</span> *samp_getMapKey (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">int</span> index); +<a name="l00462"></a>00462 <span class="keywordtype">char</span> *samp_getMapVal (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">int</span> index); +<a name="l00463"></a>00463 +<a name="l00464"></a>00464 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#b9b2157de89369eb5cd95bfe804eb89a" title="Set a string in a Map (append).">samp_setStringInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key, <span class="keywordtype">char</span> *value); +<a name="l00465"></a>00465 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#f102490efe1b92d99b67f244dc498c7b" title="Set a Map in a Map (append).">samp_setMapInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map1, <span class="keywordtype">char</span> *key, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map2); +<a name="l00466"></a>00466 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#362c2f670c98dd6a3ef69debd1871604" title="Set a List in a Map (append).">samp_setListInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key, <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> list); +<a name="l00467"></a>00467 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#c22ec42dbf9a01c9b4e00cf011e7eb9d" title="Set a Int in a Map (append).">samp_setIntInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key, <span class="keywordtype">int</span> value); +<a name="l00468"></a>00468 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#0f07ae542f5b317311b3799bd96a88fd" title="Set a string in a Map (append).">samp_setFloatInMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key, <span class="keywordtype">float</span> value); +<a name="l00469"></a>00469 +<a name="l00470"></a>00470 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#e615ad9482fa88705b2488a37c987c2a" title="Get a string from the Map.">samp_getStringFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00471"></a>00471 <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> <a class="code" href="samp_8h.html#525e8ffdfa32867f392f2c1340215453" title="Get a Map from the Map.">samp_getMapFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00472"></a>00472 <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> <a class="code" href="samp_8h.html#31ddb90cf2184ae0151b9e7ec8c1a51f" title="Get a LIST from the Map.">samp_getListFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00473"></a>00473 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#594a51772e9b0693a3c77006eb88c96a" title="Get a integer from the Map.">samp_getIntFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00474"></a>00474 <span class="keywordtype">float</span> <a class="code" href="samp_8h.html#89c38f762afd50c85f6ff659bdf0a923" title="Get a float from the Map.">samp_getFloatFromMap</a> (<a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map, <span class="keywordtype">char</span> *key); +<a name="l00475"></a>00475 +<a name="l00476"></a>00476 +<a name="l00477"></a>00477 <span class="comment">/* sampMsg.c</span> +<a name="l00478"></a>00478 <span class="comment"> */</span> +<a name="l00479"></a>00479 <a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> <a class="code" href="samp_8h.html#d343c08e241ff4e17a0eb8fa3d9f4781" title="Create a new Msg object.">samp_newMsg</a> (<span class="keywordtype">void</span>); +<a name="l00480"></a>00480 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#adf2979a5fad0c9a855740330b7fd9ce" title="Free the given Msg object.">samp_freeMsg</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg); +<a name="l00481"></a>00481 <span class="keywordtype">void</span> samp_msgMType (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> mtype); +<a name="l00482"></a>00482 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#281c8f7f8b21a74704dd200d5aaed481" title="Add a parameter to the Msg.">samp_msgParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param); +<a name="l00483"></a>00483 <span class="keywordtype">char</span> *samp_msgTag (<span class="keywordtype">void</span>); +<a name="l00484"></a>00484 +<a name="l00485"></a>00485 +<a name="l00486"></a>00486 <span class="comment">/* sampParam.c</span> +<a name="l00487"></a>00487 <span class="comment"> */</span> +<a name="l00488"></a>00488 <a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> <a class="code" href="samp_8h.html#3e2fe98bee9ac2b0c882de78e9b5085f" title="Create a new Param object.">samp_newParam</a> (<span class="keywordtype">void</span>); +<a name="l00489"></a>00489 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#5a6fbf3ac37164268afae80c35666c5e" title="Free the given Msg object.">samp_freeParam</a> (<a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> param); +<a name="l00490"></a>00490 <a class="code" href="samp_8h.html#4c5a7aff173725461e76e5f0183d7ed8">Param</a> <a class="code" href="samp_8h.html#f2953eb691b695482ffbbea71948374f" title="Get number of Params.">samp_paramInit</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg); +<a name="l00491"></a>00491 <span class="keywordtype">void</span> samp_addStringParam (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> val); +<a name="l00492"></a>00492 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#e3e90c84dd6b1a08d8af18ca9e168b37" title="Add a parameter to the Param.">samp_addMapParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <a class="code" href="samp_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> val); +<a name="l00493"></a>00493 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#24f72c4ed033ed2f219b420e491b3c0f" title="Add a parameter to the Param.">samp_addListParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <a class="code" href="samp_8h.html#39f9d235896a8fd920f319105eb82791">List</a> val); +<a name="l00494"></a>00494 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#6897da75444209fc1819042bde906aa6" title="Add a &lt;SAMP int&gt;=&quot;&quot;&gt; parameter to the Param.">samp_addIntParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <span class="keywordtype">int</span> val); +<a name="l00495"></a>00495 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#d297770f4ab1338697d69b2705d6c1d9" title="Add a &lt;SAMP float&gt;=&quot;&quot;&gt; parameter to the Param.">samp_addFloatParam</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg, <span class="keywordtype">char</span> *keyw, <span class="keywordtype">float</span> val); +<a name="l00496"></a>00496 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#5a44618b7681acff67b3883341494d2d" title="Get number of Params.">samp_paramLen</a> (<a class="code" href="samp_8h.html#eb3d03dd240212c044285bdd522e3b2b">Msg</a> msg); +<a name="l00497"></a>00497 +<a name="l00498"></a>00498 +<a name="l00499"></a>00499 <span class="comment">/* sampLog.c</span> +<a name="l00500"></a>00500 <span class="comment">*/</span> +<a name="l00501"></a>00501 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#329a8a5f83162ed49baa28f008131d45" title="SAMP message logger.">sampLog</a> (handle_t handle, <span class="keywordtype">char</span> *format, ...); +<a name="l00502"></a>00502 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#65e3987c9b510018dcdd91203b437e40" title="SAMP tracer.">sampTrace</a> (handle_t handle, <span class="keywordtype">char</span> *format, ...); +<a name="l00503"></a>00503 +<a name="l00504"></a>00504 +<a name="l00505"></a>00505 <span class="comment">/* sampUtil.c</span> +<a name="l00506"></a>00506 <span class="comment"> */</span> +<a name="l00507"></a>00507 handle_t <a class="code" href="samp_8h.html#711aa545f55e9307f662062deefd5903" title="Get an unused object handle.">samp_newHandle</a> (<span class="keywordtype">void</span> *ptr); +<a name="l00508"></a>00508 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#f02a7c646a9ed56e545d8bf33434c207" title="Free the handle for later re-use.">samp_freeHandle</a> (handle_t handle); +<a name="l00509"></a>00509 +<a name="l00510"></a>00510 handle_t <a class="code" href="samp_8h.html#4d0aef2f09b9cce38d4ea8024831c6e5" title="Convert a pointer to a handle.">samp_P2H</a> (<span class="keywordtype">void</span> *ptr); +<a name="l00511"></a>00511 <span class="keywordtype">void</span> *samp_H2P (handle_t handle); +<a name="l00512"></a>00512 +<a name="l00513"></a>00513 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#5e555288172e59ccf28c901c6bc10793" title="Convert an application name to a public-ID.">samp_app2id</a> (handle_t handle, <span class="keywordtype">char</span> *appName); +<a name="l00514"></a>00514 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#343e25bf33431d973d9f81bc25eddcf7" title="Convert a public-ID to the application name.">samp_id2app</a> (handle_t handle, <span class="keywordtype">char</span> *pubId); +<a name="l00515"></a>00515 +<a name="l00516"></a>00516 <span class="keywordtype">int</span> <a class="code" href="samp_8h.html#6157dc4b47c65323a3015a434cd02e69" title="Return a unique port number for the server.">samp_serverPort</a> (<span class="keywordtype">void</span>); +<a name="l00517"></a>00517 <span class="keywordtype">void</span> <a class="code" href="samp_8h.html#5b2ef060b3adb18aea7a5a6099c4d0d0" title="Print the metadata for the application.">samp_printMetadata</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00518"></a>00518 <span class="keywordtype">char</span> *<a class="code" href="samp_8h.html#def0598aa30c5c1a2276cdddf705de69" title="Get the metadata item for the application.">samp_getMetadata</a> (handle_t handle, <a class="code" href="samp_8h.html#2efe6d463d80744789f228f5dc4baa39">String</a> name); +<a name="l00519"></a>00519 +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/structClient.html b/vendor/voclient/libsamp/doc/html/structClient.html new file mode 100644 index 00000000..5972b803 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/structClient.html @@ -0,0 +1,61 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Client Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Client Struct Reference</h1><!-- doxytag: class="Client" --><code>#include <<a class="el" href="samp_8h_source.html">samp.h</a>></code> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69ad045aad8793b0aa0984e245e549eb"></a><!-- doxytag: member="Client::pubId" ref="69ad045aad8793b0aa0984e245e549eb" args="[SZ_NAME]" --> +char </td><td class="memItemRight" valign="bottom"><b>pubId</b> [SZ_NAME]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structClient.html#67f4b49f5eda3f6cf1ff33a6fe883bf6">name</a> [SZ_NAME]</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Registered <a class="el" href="structClient.html">Client</a> name mappings. <hr><h2>Field Documentation</h2> +<a class="anchor" name="67f4b49f5eda3f6cf1ff33a6fe883bf6"></a><!-- doxytag: member="Client::name" ref="67f4b49f5eda3f6cf1ff33a6fe883bf6" args="[SZ_NAME]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structClient.html#67f4b49f5eda3f6cf1ff33a6fe883bf6">Client::name</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +public name +<p>Referenced by <a class="el" href="samp_8c_source.html#l00834">samp_addClient()</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampUtil_8c_source.html#l00172">samp_id2app()</a>, <a class="el" href="samp_8c_source.html#l00864">samp_listClients()</a>, <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="samp_8c_source.html#l00908">samp_removeClient()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this struct was generated from the following files:<ul> +<li><a class="el" href="samp_8h_source.html">samp.h</a><li><a class="el" href="sampDecl_8h_source.html">sampDecl.h</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/structHub.html b/vendor/voclient/libsamp/doc/html/structHub.html new file mode 100644 index 00000000..b1679a81 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/structHub.html @@ -0,0 +1,287 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Hub Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Hub Struct Reference</h1><!-- doxytag: class="Hub" --><code>#include <<a class="el" href="samp_8h_source.html">samp.h</a>></code> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2afdf379c978a0a93b1213d1469f5bd5"></a><!-- doxytag: member="Hub::appName" ref="2afdf379c978a0a93b1213d1469f5bd5" args="[SZ_LINE]" --> +char </td><td class="memItemRight" valign="bottom"><b>appName</b> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#b6cbad1270ab46610f03837d4a01648f">appVer</a> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#d96b607b83480697b7147f95f84132fb">description</a> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structappMD.html">appMD</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#cfe9051f3f0d6fd908ddf394283d1262">meta</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#52a6b65f54e98c4f3b7441808e30fa6c">secret</a> [SZ_SECRET]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#81adb6d0cab27f61c0aaebbb7b7685e4">url</a> [SZ_URL]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#0e07ef26e39ed1282042364297591df5">version</a> [SZ_NAME]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#3546ac45740591096b9bdc4c37b8d5f5">id</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#83ae1eed61525e4dd8795d7076b9a844">appId</a> [SZ_NAME]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#53b0a5acf4419ffff98c6510e84a9f62">privateKey</a> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#c5ecb8cd6b3d61ab9e0fddfb643c65c3">hubId</a> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#ce254c7adba1a20deb1dff7e112dd2a8">selfId</a> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#b69adb014b0cef61d6632e60fb2dff5b">timeout</a> [SZ_NAME]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structHub.html#cfd1b13e1f462d6595ce4e0b5ab08cb9">samp</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<a class="el" href="structHub.html">Hub</a> description. Our application connects to this hub by default, but the structure will be valid for any <a class="el" href="structHub.html">Hub</a>. <hr><h2>Field Documentation</h2> +<a class="anchor" name="83ae1eed61525e4dd8795d7076b9a844"></a><!-- doxytag: member="Hub::appId" ref="83ae1eed61525e4dd8795d7076b9a844" args="[SZ_NAME]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#83ae1eed61525e4dd8795d7076b9a844">Hub::appId</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="structHub.html">Hub</a> XML-RPC connection +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b6cbad1270ab46610f03837d4a01648f"></a><!-- doxytag: member="Hub::appVer" ref="b6cbad1270ab46610f03837d4a01648f" args="[SZ_LINE]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#b6cbad1270ab46610f03837d4a01648f">Hub::appVer</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +application name +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, and <a class="el" href="samp_8c_source.html#l00783">samp_setAppVersion()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d96b607b83480697b7147f95f84132fb"></a><!-- doxytag: member="Hub::description" ref="d96b607b83480697b7147f95f84132fb" args="[SZ_LINE]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#d96b607b83480697b7147f95f84132fb">Hub::description</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +application version +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, and <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c5ecb8cd6b3d61ab9e0fddfb643c65c3"></a><!-- doxytag: member="Hub::hubId" ref="c5ecb8cd6b3d61ab9e0fddfb643c65c3" args="[SZ_LINE]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#c5ecb8cd6b3d61ab9e0fddfb643c65c3">Hub::hubId</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +client key value +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00354">samp_hubRegister()</a>, and <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3546ac45740591096b9bdc4c37b8d5f5"></a><!-- doxytag: member="Hub::id" ref="3546ac45740591096b9bdc4c37b8d5f5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structHub.html#3546ac45740591096b9bdc4c37b8d5f5">Hub::id</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="structHub.html">Hub</a> version string +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampCommands_8c_source.html#l00188">samp_GetMetadata()</a>, <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, <a class="el" href="sampCommands_8c_source.html#l00323">samp_GetSubscribedClients()</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, <a class="el" href="sampHub_8c_source.html#l00483">samp_hubPing()</a>, <a class="el" href="sampHub_8c_source.html#l00354">samp_hubRegister()</a>, <a class="el" href="sampHub_8c_source.html#l00422">samp_hubSendShutdown()</a>, <a class="el" href="sampHub_8c_source.html#l00448">samp_hubSetXmlrpcCallback()</a>, <a class="el" href="sampHub_8c_source.html#l00395">samp_hubUnRegister()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>, <a class="el" href="sampClient_8c_source.html#l00278">samp_Reply()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="cfe9051f3f0d6fd908ddf394283d1262"></a><!-- doxytag: member="Hub::meta" ref="cfe9051f3f0d6fd908ddf394283d1262" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structappMD.html">appMD</a> <a class="el" href="structHub.html#cfe9051f3f0d6fd908ddf394283d1262">Hub::meta</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +descriptive text +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, and <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="53b0a5acf4419ffff98c6510e84a9f62"></a><!-- doxytag: member="Hub::privateKey" ref="53b0a5acf4419ffff98c6510e84a9f62" args="[SZ_LINE]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#53b0a5acf4419ffff98c6510e84a9f62">Hub::privateKey</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +client key +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampCommands_8c_source.html#l00188">samp_GetMetadata()</a>, <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, <a class="el" href="sampCommands_8c_source.html#l00323">samp_GetSubscribedClients()</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, <a class="el" href="sampHub_8c_source.html#l00483">samp_hubPing()</a>, <a class="el" href="sampHub_8c_source.html#l00354">samp_hubRegister()</a>, <a class="el" href="sampHub_8c_source.html#l00422">samp_hubSendShutdown()</a>, <a class="el" href="sampHub_8c_source.html#l00448">samp_hubSetXmlrpcCallback()</a>, <a class="el" href="sampHub_8c_source.html#l00395">samp_hubUnRegister()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>, and <a class="el" href="sampClient_8c_source.html#l00278">samp_Reply()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="cfd1b13e1f462d6595ce4e0b5ab08cb9"></a><!-- doxytag: member="Hub::samp" ref="cfd1b13e1f462d6595ce4e0b5ab08cb9" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void * <a class="el" href="structHub.html#cfd1b13e1f462d6595ce4e0b5ab08cb9">Hub::samp</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sync msg timeout (str) +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, and <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="52a6b65f54e98c4f3b7441808e30fa6c"></a><!-- doxytag: member="Hub::secret" ref="52a6b65f54e98c4f3b7441808e30fa6c" args="[SZ_SECRET]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#52a6b65f54e98c4f3b7441808e30fa6c">Hub::secret</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +metadata +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00354">samp_hubRegister()</a>, and <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ce254c7adba1a20deb1dff7e112dd2a8"></a><!-- doxytag: member="Hub::selfId" ref="ce254c7adba1a20deb1dff7e112dd2a8" args="[SZ_LINE]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#ce254c7adba1a20deb1dff7e112dd2a8">Hub::selfId</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="structHub.html">Hub</a> id value +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00354">samp_hubRegister()</a>, and <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b69adb014b0cef61d6632e60fb2dff5b"></a><!-- doxytag: member="Hub::timeout" ref="b69adb014b0cef61d6632e60fb2dff5b" args="[SZ_NAME]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#b69adb014b0cef61d6632e60fb2dff5b">Hub::timeout</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="structClient.html">Client</a> id value +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, and <a class="el" href="samp_8c_source.html#l00740">samp_setTimeout()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="81adb6d0cab27f61c0aaebbb7b7685e4"></a><!-- doxytag: member="Hub::url" ref="81adb6d0cab27f61c0aaebbb7b7685e4" args="[SZ_URL]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#81adb6d0cab27f61c0aaebbb7b7685e4">Hub::url</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +registration string +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0e07ef26e39ed1282042364297591df5"></a><!-- doxytag: member="Hub::version" ref="0e07ef26e39ed1282042364297591df5" args="[SZ_NAME]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structHub.html#0e07ef26e39ed1282042364297591df5">Hub::version</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="structHub.html">Hub</a> service endpoint +</div> +</div><p> +<hr>The documentation for this struct was generated from the following files:<ul> +<li><a class="el" href="samp_8h_source.html">samp.h</a><li><a class="el" href="sampDecl_8h_source.html">sampDecl.h</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/structSamp.html b/vendor/voclient/libsamp/doc/html/structSamp.html new file mode 100644 index 00000000..a7a13c2f --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/structSamp.html @@ -0,0 +1,479 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Samp Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Samp Struct Reference</h1><!-- doxytag: class="Samp" --><code>#include <<a class="el" href="samp_8h_source.html">samp.h</a>></code> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f372ba3fd5ff2d8c8ec06bd33403ca9e"></a><!-- doxytag: member="Samp::appName" ref="f372ba3fd5ff2d8c8ec06bd33403ca9e" args="[SZ_NAME]" --> +char </td><td class="memItemRight" valign="bottom"><b>appName</b> [SZ_NAME]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#df7c497b6dbffc08e8ef5d7edd4ee97e">appVer</a> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#d672d7d425e8180b93c7ca2229d1acd8">description</a> [SZ_NAME]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#62629ad2155a2a1a7676e32ef9fb9ffd">errortxt</a> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structappMD.html">appMD</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#0884021074d1ed14342187005e0b78e7">meta</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">pthread_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#e7db0cac0c4ad61c9ed7f3d344b623cf">svrThread</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">defaultUserFunc</a> )(char *sender, char *msgid, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="60d87008915bca91796cbdf77537e5f0"></a><!-- doxytag: member="Samp::subs" ref="60d87008915bca91796cbdf77537e5f0" args="[MAX_SUBS]" --> +<a class="el" href="structSubs.html">Subs</a> </td><td class="memItemRight" valign="bottom"><b>subs</b> [MAX_SUBS]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#36f4cfae3407b8961e57a77abca7d599">nsubs</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structClient.html">Client</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#2cc1f00b9e4bae456e0e72b90147df7b">clients</a> [MAX_CLIENTS]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#97ef8ad57159f4b6c4fcd93a12853b69">nclients</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#69b05b2fa1ab19729d81659ad64387a0">serverTid</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#8849cb13cbedae805b4e35327bc449e2">serverPort</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structHub.html">Hub</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#14811ec2253a6e2e75a8ec863c4150b0">hub</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">handle_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#03918136809ece7e60de4e30c64b6224">hubHandle</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#723b2538cfd65122c49783b36a7d30b5">hubThreadID</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#32402da48b11693c13252edbdca7673c">active</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#c8eee2b56f226f59d814fd1baa751b77">mapClients</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#30ca22535582e7bf6416627d1cd46525">msgMode</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#14f6ed59a947504d37bd8cdd1f2f8e8d">handlerMode</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#79f2ee1f48cb40edaf9b63ccdbb6942f">logfd</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#d8469d2447cd872101fb83d92f85049e">debug</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#981b01bd09deddb039db3567825bd653">verbose</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structSamp.html#25ddaf846639c7c67ea651a578b804ad">trace</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +SAMP application description. By default this describes our app by may be used to store information about other apps in the network as well. <hr><h2>Field Documentation</h2> +<a class="anchor" name="32402da48b11693c13252edbdca7673c"></a><!-- doxytag: member="Samp::active" ref="32402da48b11693c13252edbdca7673c" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#32402da48b11693c13252edbdca7673c">Samp::active</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="structHub.html">Hub</a> thread id +<p>Referenced by <a class="el" href="samp_8c_source.html#l00360">samp_hubActive()</a>, <a class="el" href="samp_8c_source.html#l00323">sampShutdown()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="df7c497b6dbffc08e8ef5d7edd4ee97e"></a><!-- doxytag: member="Samp::appVer" ref="df7c497b6dbffc08e8ef5d7edd4ee97e" args="[SZ_LINE]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structSamp.html#df7c497b6dbffc08e8ef5d7edd4ee97e">Samp::appVer</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +application name +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, and <a class="el" href="samp_8c_source.html#l00783">samp_setAppVersion()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2cc1f00b9e4bae456e0e72b90147df7b"></a><!-- doxytag: member="Samp::clients" ref="2cc1f00b9e4bae456e0e72b90147df7b" args="[MAX_CLIENTS]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structClient.html">Client</a> <a class="el" href="structSamp.html#2cc1f00b9e4bae456e0e72b90147df7b">Samp::clients</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +number of subscriptions +<p>Referenced by <a class="el" href="samp_8c_source.html#l00834">samp_addClient()</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampUtil_8c_source.html#l00172">samp_id2app()</a>, <a class="el" href="samp_8c_source.html#l00864">samp_listClients()</a>, <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="samp_8c_source.html#l00908">samp_removeClient()</a>, <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d8469d2447cd872101fb83d92f85049e"></a><!-- doxytag: member="Samp::debug" ref="d8469d2447cd872101fb83d92f85049e" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#d8469d2447cd872101fb83d92f85049e">Samp::debug</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +log file descriptor +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, <a class="el" href="samp_8c_source.html#l00188">sampDebug()</a>, and <a class="el" href="sampLog_8c_source.html#l00053">sampLog()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="eb399d3fb381bee752b5747ff4cb9a9b"></a><!-- doxytag: member="Samp::defaultUserFunc" ref="eb399d3fb381bee752b5747ff4cb9a9b" args=")(char *sender, char *msgid, Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int(* <a class="el" href="structSamp.html#eb399d3fb381bee752b5747ff4cb9a9b">Samp::defaultUserFunc</a>)(char *sender, char *msgid, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map) </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>msgid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +server thread number default user handler +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>, <a class="el" href="sampMethods_8c_source.html#l00189">samp_receiveResponse()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00046">samp_setUserHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="d672d7d425e8180b93c7ca2229d1acd8"></a><!-- doxytag: member="Samp::description" ref="d672d7d425e8180b93c7ca2229d1acd8" args="[SZ_NAME]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structSamp.html#d672d7d425e8180b93c7ca2229d1acd8">Samp::description</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +application version +<p>Referenced by <a class="el" href="sampUtil_8c_source.html#l00257">samp_getMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, and <a class="el" href="sampUtil_8c_source.html#l00215">samp_printMetadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="62629ad2155a2a1a7676e32ef9fb9ffd"></a><!-- doxytag: member="Samp::errortxt" ref="62629ad2155a2a1a7676e32ef9fb9ffd" args="[SZ_LINE]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structSamp.html#62629ad2155a2a1a7676e32ef9fb9ffd">Samp::errortxt</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +application description +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampClient_8c_source.html#l00414">samp_getErr()</a>, <a class="el" href="sampCommands_8c_source.html#l00188">samp_GetMetadata()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, and <a class="el" href="sampClient_8c_source.html#l00360">samp_setErr()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="14f6ed59a947504d37bd8cdd1f2f8e8d"></a><!-- doxytag: member="Samp::handlerMode" ref="14f6ed59a947504d37bd8cdd1f2f8e8d" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#14f6ed59a947504d37bd8cdd1f2f8e8d">Samp::handlerMode</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +(a)synch message mode +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l01118">samp_bibcodeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00906">samp_cmdExecHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00941">samp_envGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00994">samp_envSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00191">samp_execUserHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00547">samp_imLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01030">samp_paramGetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01082">samp_paramSetHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00451">samp_PingHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00786">samp_pointAtHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01190">samp_resConeHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01153">samp_resLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01231">samp_resSiapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01272">samp_resSsapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01313">samp_resTapHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l01354">samp_resVOSpaceHandler()</a>, <a class="el" href="samp_8c_source.html#l00641">samp_setCallByRef()</a>, <a class="el" href="sampHandlers_8c_source.html#l00822">samp_specLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00862">samp_specSSAHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00482">samp_StatusHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00705">samp_tbHighlightHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00621">samp_tbLoadFITSHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00584">samp_tbLoadHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00663">samp_tbLoadVOTHandler()</a>, and <a class="el" href="sampHandlers_8c_source.html#l00743">samp_tbSelectHandler()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="14811ec2253a6e2e75a8ec863c4150b0"></a><!-- doxytag: member="Samp::hub" ref="14811ec2253a6e2e75a8ec863c4150b0" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structHub.html">Hub</a> * <a class="el" href="structSamp.html#14811ec2253a6e2e75a8ec863c4150b0">Samp::hub</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +samp server port +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00794">samp_bibLoad()</a>, <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampMTypes_8c_source.html#l00459">samp_cmdExec()</a>, <a class="el" href="sampMTypes_8c_source.html#l00367">samp_coordPointAtSky()</a>, <a class="el" href="sampCommands_8c_source.html#l00121">samp_DeclareMetadata()</a>, <a class="el" href="sampCommands_8c_source.html#l00227">samp_DeclareSubscriptions()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00604">samp_envSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00188">samp_GetMetadata()</a>, <a class="el" href="sampCommands_8c_source.html#l00279">samp_GetRegisteredClients()</a>, <a class="el" href="sampCommands_8c_source.html#l00323">samp_GetSubscribedClients()</a>, <a class="el" href="sampMTypes_8c_source.html#l00320">samp_imageLoadFITS()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, <a class="el" href="sampClient_8c_source.html#l00045">samp_notify()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="sampMTypes_8c_source.html#l00751">samp_paramSet()</a>, <a class="el" href="sampCommands_8c_source.html#l00141">samp_Ping()</a>, <a class="el" href="sampCommands_8c_source.html#l00047">samp_Register()</a>, <a class="el" href="sampClient_8c_source.html#l00278">samp_Reply()</a>, <a class="el" href="sampMTypes_8c_source.html#l00839">samp_resourceLoad()</a>, <a class="el" href="sampMTypes_8c_source.html#l00898">samp_sendGeneric()</a>, <a class="el" href="samp_8c_source.html#l00783">samp_setAppVersion()</a>, <a class="el" href="samp_8c_source.html#l00740">samp_setTimeout()</a>, <a class="el" href="sampMTypes_8c_source.html#l00413">samp_specLoadSSAGeneric()</a>, <a class="el" href="sampMTypes_8c_source.html#l00221">samp_tableHighlightRow()</a>, <a class="el" href="sampMTypes_8c_source.html#l00177">samp_tableLoadFITS()</a>, <a class="el" href="sampMTypes_8c_source.html#l00133">samp_tableLoadVOTable()</a>, <a class="el" href="sampMTypes_8c_source.html#l00266">samp_tableSelectRowList()</a>, <a class="el" href="sampCommands_8c_source.html#l00102">samp_UnRegister()</a>, <a class="el" href="samp_8c_source.html#l00145">sampClose()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="03918136809ece7e60de4e30c64b6224"></a><!-- doxytag: member="Samp::hubHandle" ref="03918136809ece7e60de4e30c64b6224" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">handle_t <a class="el" href="structSamp.html#03918136809ece7e60de4e30c64b6224">Samp::hubHandle</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="structHub.html">Hub</a> connection +<p>Referenced by <a class="el" href="samp_8c_source.html#l00145">sampClose()</a>, <a class="el" href="samp_8c_source.html#l00323">sampShutdown()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="723b2538cfd65122c49783b36a7d30b5"></a><!-- doxytag: member="Samp::hubThreadID" ref="723b2538cfd65122c49783b36a7d30b5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#723b2538cfd65122c49783b36a7d30b5">Samp::hubThreadID</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +<a class="el" href="structHub.html">Hub</a> handle alias +</div> +</div><p> +<a class="anchor" name="79f2ee1f48cb40edaf9b63ccdbb6942f"></a><!-- doxytag: member="Samp::logfd" ref="79f2ee1f48cb40edaf9b63ccdbb6942f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">FILE * <a class="el" href="structSamp.html#79f2ee1f48cb40edaf9b63ccdbb6942f">Samp::logfd</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +CBR / CBV for user handlers +<p>Referenced by <a class="el" href="sampLog_8c_source.html#l00053">sampLog()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="c8eee2b56f226f59d814fd1baa751b77"></a><!-- doxytag: member="Samp::mapClients" ref="c8eee2b56f226f59d814fd1baa751b77" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#c8eee2b56f226f59d814fd1baa751b77">Samp::mapClients</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +is interface active +<p>Referenced by <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0884021074d1ed14342187005e0b78e7"></a><!-- doxytag: member="Samp::meta" ref="0884021074d1ed14342187005e0b78e7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structappMD.html">appMD</a> <a class="el" href="structSamp.html#0884021074d1ed14342187005e0b78e7">Samp::meta</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +last msh error string +<p>Referenced by <a class="el" href="sampUtil_8c_source.html#l00257">samp_getMetadata()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, and <a class="el" href="sampUtil_8c_source.html#l00215">samp_printMetadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="30ca22535582e7bf6416627d1cd46525"></a><!-- doxytag: member="Samp::msgMode" ref="30ca22535582e7bf6416627d1cd46525" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#30ca22535582e7bf6416627d1cd46525">Samp::msgMode</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +map other clients<p> +is interface active +<p>Referenced by <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>, <a class="el" href="samp_8c_source.html#l00589">samp_setASyncMode()</a>, <a class="el" href="samp_8c_source.html#l00555">samp_setCallMode()</a>, <a class="el" href="samp_8c_source.html#l00624">samp_setMsgMode()</a>, <a class="el" href="samp_8c_source.html#l00606">samp_setNotifyMode()</a>, and <a class="el" href="samp_8c_source.html#l00572">samp_setSyncMode()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="97ef8ad57159f4b6c4fcd93a12853b69"></a><!-- doxytag: member="Samp::nclients" ref="97ef8ad57159f4b6c4fcd93a12853b69" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#97ef8ad57159f4b6c4fcd93a12853b69">Samp::nclients</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +samp clients +<p>Referenced by <a class="el" href="samp_8c_source.html#l00834">samp_addClient()</a>, <a class="el" href="sampUtil_8c_source.html#l00148">samp_app2id()</a>, <a class="el" href="sampMTypes_8c_source.html#l00497">samp_envGet()</a>, <a class="el" href="sampUtil_8c_source.html#l00172">samp_id2app()</a>, <a class="el" href="samp_8c_source.html#l00864">samp_listClients()</a>, <a class="el" href="samp_8c_source.html#l00797">samp_mapClients()</a>, <a class="el" href="sampMTypes_8c_source.html#l00643">samp_paramGet()</a>, <a class="el" href="samp_8c_source.html#l00908">samp_removeClient()</a>, <a class="el" href="sampMTypes_8c_source.html#l00963">samp_sendMsg()</a>, and <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="36f4cfae3407b8961e57a77abca7d599"></a><!-- doxytag: member="Samp::nsubs" ref="36f4cfae3407b8961e57a77abca7d599" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#36f4cfae3407b8961e57a77abca7d599">Samp::nsubs</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +message subscriptions +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00159">samp_getSampHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, <a class="el" href="sampHandlers_8c_source.html#l00090">samp_setSampHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00046">samp_setUserHandler()</a>, <a class="el" href="samp_8c_source.html#l00475">samp_Subscribe()</a>, and <a class="el" href="samp_8c_source.html#l00507">samp_Unsubscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8849cb13cbedae805b4e35327bc449e2"></a><!-- doxytag: member="Samp::serverPort" ref="8849cb13cbedae805b4e35327bc449e2" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#8849cb13cbedae805b4e35327bc449e2">Samp::serverPort</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +samp server threadId +</div> +</div><p> +<a class="anchor" name="69b05b2fa1ab19729d81659ad64387a0"></a><!-- doxytag: member="Samp::serverTid" ref="69b05b2fa1ab19729d81659ad64387a0" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#69b05b2fa1ab19729d81659ad64387a0">Samp::serverTid</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +number of samp clients +</div> +</div><p> +<a class="anchor" name="e7db0cac0c4ad61c9ed7f3d344b623cf"></a><!-- doxytag: member="Samp::svrThread" ref="e7db0cac0c4ad61c9ed7f3d344b623cf" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">pthread_t <a class="el" href="structSamp.html#e7db0cac0c4ad61c9ed7f3d344b623cf">Samp::svrThread</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +metadata +<p>Referenced by <a class="el" href="samp_8c_source.html#l00323">sampShutdown()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="25ddaf846639c7c67ea651a578b804ad"></a><!-- doxytag: member="Samp::trace" ref="25ddaf846639c7c67ea651a578b804ad" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#25ddaf846639c7c67ea651a578b804ad">Samp::trace</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +verbose flag<p> +debug flag +<p>Referenced by <a class="el" href="sampClient_8c_source.html#l00139">samp_call()</a>, <a class="el" href="sampClient_8c_source.html#l00184">samp_callAll()</a>, <a class="el" href="sampClient_8c_source.html#l00230">samp_callAndWait()</a>, <a class="el" href="sampClient_8c_source.html#l00097">samp_notifyAll()</a>, <a class="el" href="sampMethods_8c_source.html#l00045">samp_receiveCall()</a>, <a class="el" href="sampMethods_8c_source.html#l00115">samp_receiveNotification()</a>, <a class="el" href="sampMethods_8c_source.html#l00189">samp_receiveResponse()</a>, <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>, and <a class="el" href="sampLog_8c_source.html#l00091">sampTrace()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="981b01bd09deddb039db3567825bd653"></a><!-- doxytag: member="Samp::verbose" ref="981b01bd09deddb039db3567825bd653" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structSamp.html#981b01bd09deddb039db3567825bd653">Samp::verbose</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +debug flag +<p>Referenced by <a class="el" href="samp_8c_source.html#l00145">sampClose()</a>, <a class="el" href="samp_8c_source.html#l00188">sampDebug()</a>, <a class="el" href="samp_8c_source.html#l00323">sampShutdown()</a>, <a class="el" href="samp_8c_source.html#l00229">sampStartup()</a>, and <a class="el" href="samp_8c_source.html#l00209">sampVerbose()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this struct was generated from the following files:<ul> +<li><a class="el" href="samp_8h_source.html">samp.h</a><li><a class="el" href="sampDecl_8h_source.html">sampDecl.h</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/structSubs.html b/vendor/voclient/libsamp/doc/html/structSubs.html new file mode 100644 index 00000000..f69e3c6a --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/structSubs.html @@ -0,0 +1,111 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: Subs Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>Subs Struct Reference</h1><!-- doxytag: class="Subs" --><code>#include <<a class="el" href="samp_8h_source.html">samp.h</a>></code> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e34561f0e9c8805dcb19fe4f91ea3e3e"></a><!-- doxytag: member="Subs::mtype" ref="e34561f0e9c8805dcb19fe4f91ea3e3e" args="[SZ_LINE]" --> +char </td><td class="memItemRight" valign="bottom"><b>mtype</b> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">userFunc</a> )(void *p)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">sampFunc</a> )(char *sid, char *sender, char *msgid, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map)</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Message subscription. <hr><h2>Field Documentation</h2> +<a class="anchor" name="c4eca724f23609bb7ab9640c39c1001b"></a><!-- doxytag: member="Subs::sampFunc" ref="c4eca724f23609bb7ab9640c39c1001b" args=")(char *sid, char *sender, char *msgid, Map map)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int(* <a class="el" href="structSubs.html#c4eca724f23609bb7ab9640c39c1001b">Subs::sampFunc</a>)(char *sid, char *sender, char *msgid, <a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> map) </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>sid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>sender</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char * </td> + <td class="paramname"> <em>msgid</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="sampDecl_8h.html#39a90bc041db57e1a6ba736ba91eee30">Map</a> </td> + <td class="paramname"> <em>map</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +user handler function samp handler function +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00159">samp_getSampHandler()</a>, <a class="el" href="sampHandlers_8c_source.html#l00090">samp_setSampHandler()</a>, and <a class="el" href="samp_8c_source.html#l00507">samp_Unsubscribe()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="14364d5a161adc47732c39b96e8156f0"></a><!-- doxytag: member="Subs::userFunc" ref="14364d5a161adc47732c39b96e8156f0" args=")(void *p)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int(* <a class="el" href="structSubs.html#14364d5a161adc47732c39b96e8156f0">Subs::userFunc</a>)(void *p) </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>p</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +mtype string +<p>Referenced by <a class="el" href="sampHandlers_8c_source.html#l00126">samp_getUserHandler()</a>, <a class="el" href="sampHub_8c_source.html#l00550">samp_hubDeclareSubscriptions()</a>, <a class="el" href="sampHandlers_8c_source.html#l00046">samp_setUserHandler()</a>, and <a class="el" href="samp_8c_source.html#l00507">samp_Unsubscribe()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this struct was generated from the following files:<ul> +<li><a class="el" href="samp_8h_source.html">samp.h</a><li><a class="el" href="sampDecl_8h_source.html">sampDecl.h</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/structappMD.html b/vendor/voclient/libsamp/doc/html/structappMD.html new file mode 100644 index 00000000..fd43ea07 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/structappMD.html @@ -0,0 +1,174 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>SAMP Client Library: appMD Struct Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.9 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li><a href="functions.html"><span>Data Fields</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>appMD Struct Reference</h1><!-- doxytag: class="appMD" --><code>#include <<a class="el" href="samp_8h_source.html">samp.h</a>></code> +<p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="138f7e855439b5960fedf2bfb28f473e"></a><!-- doxytag: member="appMD::name" ref="138f7e855439b5960fedf2bfb28f473e" args="[SZ_LINE]" --> +char </td><td class="memItemRight" valign="bottom"><b>name</b> [SZ_LINE]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structappMD.html#fe527cb05f296f8e8b8144bf444beffd">desc</a> [SZ_DESC]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structappMD.html#8ff19215559267a838fe300ca4f743a7">iconURL</a> [SZ_URL]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structappMD.html#53945cba18e159fcdd4fb627b1d1d312">docURL</a> [SZ_URL]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structappMD.html#652f4b568b3de167fa0886613c8c6656">descHTML</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structappMD.html#4b9f5ebb7d20beb53a7bfe192009e89a">nkeys</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structappMD.html#cf4d62dbfeb28cb8c503d6a4d1598a8d">aKey</a> [MAX_MDATTRS]</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structappMD.html#13ae9876a351aee3fe5b861733aff77a">aVal</a> [MAX_MDATTRS]</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +SAMP String datatype Application (and <a class="el" href="structHub.html">Hub</a>) metadata.<p> +Application (and <a class="el" href="structHub.html">Hub</a>) metadata. <hr><h2>Field Documentation</h2> +<a class="anchor" name="cf4d62dbfeb28cb8c503d6a4d1598a8d"></a><!-- doxytag: member="appMD::aKey" ref="cf4d62dbfeb28cb8c503d6a4d1598a8d" args="[MAX_MDATTRS]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char * <a class="el" href="structappMD.html#cf4d62dbfeb28cb8c503d6a4d1598a8d">appMD::aKey</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +number of meta keys +<p>Referenced by <a class="el" href="sampUtil_8c_source.html#l00257">samp_getMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, and <a class="el" href="sampUtil_8c_source.html#l00215">samp_printMetadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="13ae9876a351aee3fe5b861733aff77a"></a><!-- doxytag: member="appMD::aVal" ref="13ae9876a351aee3fe5b861733aff77a" args="[MAX_MDATTRS]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char * <a class="el" href="structappMD.html#13ae9876a351aee3fe5b861733aff77a">appMD::aVal</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +attr keyword +<p>Referenced by <a class="el" href="sampUtil_8c_source.html#l00257">samp_getMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, and <a class="el" href="sampUtil_8c_source.html#l00215">samp_printMetadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="fe527cb05f296f8e8b8144bf444beffd"></a><!-- doxytag: member="appMD::desc" ref="fe527cb05f296f8e8b8144bf444beffd" args="[SZ_DESC]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structappMD.html#fe527cb05f296f8e8b8144bf444beffd">appMD::desc</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +name +<p>Referenced by <a class="el" href="sampHub_8c_source.html#l00059">samp_hubOpen()</a>, and <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="652f4b568b3de167fa0886613c8c6656"></a><!-- doxytag: member="appMD::descHTML" ref="652f4b568b3de167fa0886613c8c6656" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char * <a class="el" href="structappMD.html#652f4b568b3de167fa0886613c8c6656">appMD::descHTML</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +documentation URL +</div> +</div><p> +<a class="anchor" name="53945cba18e159fcdd4fb627b1d1d312"></a><!-- doxytag: member="appMD::docURL" ref="53945cba18e159fcdd4fb627b1d1d312" args="[SZ_URL]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structappMD.html#53945cba18e159fcdd4fb627b1d1d312">appMD::docURL</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +icon URL +<p>Referenced by <a class="el" href="sampUtil_8c_source.html#l00257">samp_getMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, and <a class="el" href="sampUtil_8c_source.html#l00215">samp_printMetadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8ff19215559267a838fe300ca4f743a7"></a><!-- doxytag: member="appMD::iconURL" ref="8ff19215559267a838fe300ca4f743a7" args="[SZ_URL]" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="structappMD.html#8ff19215559267a838fe300ca4f743a7">appMD::iconURL</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +descriptive text +<p>Referenced by <a class="el" href="sampUtil_8c_source.html#l00257">samp_getMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, and <a class="el" href="sampUtil_8c_source.html#l00215">samp_printMetadata()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="4b9f5ebb7d20beb53a7bfe192009e89a"></a><!-- doxytag: member="appMD::nkeys" ref="4b9f5ebb7d20beb53a7bfe192009e89a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="structappMD.html#4b9f5ebb7d20beb53a7bfe192009e89a">appMD::nkeys</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +descriptive text (HTML) +<p>Referenced by <a class="el" href="sampUtil_8c_source.html#l00257">samp_getMetadata()</a>, <a class="el" href="sampHub_8c_source.html#l00127">samp_hubClose()</a>, <a class="el" href="sampHub_8c_source.html#l00508">samp_hubDeclareMetadata()</a>, <a class="el" href="samp_8c_source.html#l00408">samp_Metadata()</a>, and <a class="el" href="sampUtil_8c_source.html#l00215">samp_printMetadata()</a>.</p> + +</div> +</div><p> +<hr>The documentation for this struct was generated from the following files:<ul> +<li><a class="el" href="samp_8h_source.html">samp.h</a><li><a class="el" href="sampDecl_8h_source.html">sampDecl.h</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 27 21:10:16 2013 for SAMP Client Library by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> +</body> +</html> diff --git a/vendor/voclient/libsamp/doc/html/tab_b.gif b/vendor/voclient/libsamp/doc/html/tab_b.gif Binary files differnew file mode 100644 index 00000000..0d623483 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/tab_b.gif diff --git a/vendor/voclient/libsamp/doc/html/tab_l.gif b/vendor/voclient/libsamp/doc/html/tab_l.gif Binary files differnew file mode 100644 index 00000000..9b1e6337 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/tab_l.gif diff --git a/vendor/voclient/libsamp/doc/html/tab_r.gif b/vendor/voclient/libsamp/doc/html/tab_r.gif Binary files differnew file mode 100644 index 00000000..ce9dd9f5 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/tab_r.gif diff --git a/vendor/voclient/libsamp/doc/html/tabs.css b/vendor/voclient/libsamp/doc/html/tabs.css new file mode 100644 index 00000000..ab02c624 --- /dev/null +++ b/vendor/voclient/libsamp/doc/html/tabs.css @@ -0,0 +1,105 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; + text-align : center; + margin : 2px; + padding : 2px; +} diff --git a/vendor/voclient/libsamp/doc/latex/Makefile b/vendor/voclient/libsamp/doc/latex/Makefile new file mode 100644 index 00000000..8b7c89a1 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/Makefile @@ -0,0 +1,19 @@ +all: clean refman.pdf + +pdf: refman.pdf + +refman.pdf: refman.tex + pdflatex refman.tex + makeindex refman.idx + pdflatex refman.tex + latex_count=5 ; \ + while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log && [ $$latex_count -gt 0 ] ;\ + do \ + echo "Rerunning latex...." ;\ + pdflatex refman.tex ;\ + latex_count=`expr $$latex_count - 1` ;\ + done + + +clean: + rm -f *.ps *.dvi *.aux *.toc *.idx *.ind *.ilg *.log *.out refman.pdf diff --git a/vendor/voclient/libsamp/doc/latex/annotated.tex b/vendor/voclient/libsamp/doc/latex/annotated.tex new file mode 100644 index 00000000..30770149 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/annotated.tex @@ -0,0 +1,8 @@ +\section{Data Structures} +Here are the data structures with brief descriptions:\begin{CompactList} +\item\contentsline{section}{\hyperlink{structappMD}{appMD} }{\pageref{structappMD}}{} +\item\contentsline{section}{\hyperlink{structClient}{Client} }{\pageref{structClient}}{} +\item\contentsline{section}{\hyperlink{structHub}{Hub} }{\pageref{structHub}}{} +\item\contentsline{section}{\hyperlink{structSamp}{Samp} }{\pageref{structSamp}}{} +\item\contentsline{section}{\hyperlink{structSubs}{Subs} }{\pageref{structSubs}}{} +\end{CompactList} diff --git a/vendor/voclient/libsamp/doc/latex/doxygen.sty b/vendor/voclient/libsamp/doc/latex/doxygen.sty new file mode 100644 index 00000000..e36965b7 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/doxygen.sty @@ -0,0 +1,97 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{doxygen} +\RequirePackage{calc} +\RequirePackage{array} +\RequirePackage{color} +\pagestyle{fancyplain} +\newcommand{\clearemptydoublepage}{\newpage{\pagestyle{empty}\cleardoublepage}} +\renewcommand{\chaptermark}[1]{\markboth{#1}{}} +\renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}} +\lhead[\fancyplain{}{\bfseries\thepage}] + {\fancyplain{}{\bfseries\rightmark}} +\rhead[\fancyplain{}{\bfseries\leftmark}] + {\fancyplain{}{\bfseries\thepage}} +\rfoot[\fancyplain{}{\bfseries\scriptsize Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by Doxygen }]{} +\lfoot[]{\fancyplain{}{\bfseries\scriptsize Generated on Wed Feb 27 21:10:15 2013 for SAMP Client Library by Doxygen }} +\cfoot{} +\newenvironment{Code} +{\footnotesize} +{\normalsize} +\newcommand{\doxyref}[3]{\textbf{#1} (\textnormal{#2}\,\pageref{#3})} +\newenvironment{DocInclude} +{\footnotesize} +{\normalsize} +\newenvironment{VerbInclude} +{\footnotesize} +{\normalsize} +\newenvironment{Image} +{\begin{figure}[H]} +{\end{figure}} +\newenvironment{ImageNoCaption}{}{} +\newenvironment{CompactList} +{\begin{list}{}{ + \setlength{\leftmargin}{0.5cm} + \setlength{\itemsep}{0pt} + \setlength{\parsep}{0pt} + \setlength{\topsep}{0pt} + \renewcommand{\makelabel}{\hfill}}} +{\end{list}} +\newenvironment{CompactItemize} +{ + \begin{itemize} + \setlength{\itemsep}{-3pt} + \setlength{\parsep}{0pt} + \setlength{\topsep}{0pt} + \setlength{\partopsep}{0pt} +} +{\end{itemize}} +\newcommand{\PBS}[1]{\let\temp=\\#1\let\\=\temp} +\newlength{\tmplength} +\newenvironment{TabularC}[1] +{ +\setlength{\tmplength} + {\linewidth/(#1)-\tabcolsep*2-\arrayrulewidth*(#1+1)/(#1)} + \par\begin{tabular*}{\linewidth} + {*{#1}{|>{\PBS\raggedright\hspace{0pt}}p{\the\tmplength}}|} +} +{\end{tabular*}\par} +\newcommand{\entrylabel}[1]{ + {\parbox[b]{\labelwidth-4pt}{\makebox[0pt][l]{\textbf{#1}}\vspace{1.5\baselineskip}}}} +\newenvironment{Desc} +{\begin{list}{} + { + \settowidth{\labelwidth}{40pt} + \setlength{\leftmargin}{\labelwidth} + \setlength{\parsep}{0pt} + \setlength{\itemsep}{-4pt} + \renewcommand{\makelabel}{\entrylabel} + } +} +{\end{list}} +\newenvironment{Indent} + {\begin{list}{}{\setlength{\leftmargin}{0.5cm}} + \item[]\ignorespaces} + {\unskip\end{list}} +\setlength{\parindent}{0cm} +\setlength{\parskip}{0.2cm} +\addtocounter{secnumdepth}{1} +\sloppy +\usepackage[T1]{fontenc} +\makeatletter +\renewcommand{\paragraph}{\@startsection{paragraph}{4}{0ex}% + {-3.25ex plus -1ex minus -0.2ex}% + {1.5ex plus 0.2ex}% + {\normalfont\normalsize\bfseries}} +\makeatother +\stepcounter{secnumdepth} +\stepcounter{tocdepth} +\definecolor{comment}{rgb}{0.5,0.0,0.0} +\definecolor{keyword}{rgb}{0.0,0.5,0.0} +\definecolor{keywordtype}{rgb}{0.38,0.25,0.125} +\definecolor{keywordflow}{rgb}{0.88,0.5,0.0} +\definecolor{preprocessor}{rgb}{0.5,0.38,0.125} +\definecolor{stringliteral}{rgb}{0.0,0.125,0.25} +\definecolor{charliteral}{rgb}{0.0,0.5,0.5} +\definecolor{vhdldigit}{rgb}{1.0,0.0,1.0} +\definecolor{vhdlkeyword}{rgb}{0.43,0.0,0.43} +\definecolor{vhdllogic}{rgb}{1.0,0.0,0.0} diff --git a/vendor/voclient/libsamp/doc/latex/files.tex b/vendor/voclient/libsamp/doc/latex/files.tex new file mode 100644 index 00000000..21ae5106 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/files.tex @@ -0,0 +1,18 @@ +\section{File List} +Here is a list of all documented files with brief descriptions:\begin{CompactList} +\item\contentsline{section}{\hyperlink{samp_8c}{samp.c} (Top-level interface to the SAMP library )}{\pageref{samp_8c}}{} +\item\contentsline{section}{\hyperlink{samp_8h}{samp.h} (SAMP interface include file )}{\pageref{samp_8h}}{} +\item\contentsline{section}{\hyperlink{sampClient_8c}{sampClient.c} (\hyperlink{structClient}{Client} callable methods )}{\pageref{sampClient_8c}}{} +\item\contentsline{section}{\hyperlink{sampCommands_8c}{sampCommands.c} (SAMP commands used by app to send administrative messages )}{\pageref{sampCommands_8c}}{} +\item\contentsline{section}{\hyperlink{sampDecl_8h}{sampDecl.h} (SAMP interface method declarations )}{\pageref{sampDecl_8h}}{} +\item\contentsline{section}{\hyperlink{sampHandlers_8c}{sampHandlers.c} (Message handlers for the interface )}{\pageref{sampHandlers_8c}}{} +\item\contentsline{section}{\hyperlink{sampHub_8c}{sampHub.c} (Methods related to the SAMP \hyperlink{structHub}{Hub} interface )}{\pageref{sampHub_8c}}{} +\item\contentsline{section}{\hyperlink{sampList_8c}{sampList.c} ((Internal) interface to support the List structure )}{\pageref{sampList_8c}}{} +\item\contentsline{section}{\hyperlink{sampLog_8c}{sampLog.c} (SAMP trace and logging interface )}{\pageref{sampLog_8c}}{} +\item\contentsline{section}{\hyperlink{sampMap_8c}{sampMap.c} ((Internal) Interface to support the Map structure )}{\pageref{sampMap_8c}}{} +\item\contentsline{section}{\hyperlink{sampMethods_8c}{sampMethods.c} (SAMP methods implemented by a callable client )}{\pageref{sampMethods_8c}}{} +\item\contentsline{section}{\hyperlink{sampMsg_8c}{sampMsg.c} ((Internal) Interface to Message objects )}{\pageref{sampMsg_8c}}{} +\item\contentsline{section}{\hyperlink{sampMTypes_8c}{sampMTypes.c} (SAMP interface procedures for application mtypes )}{\pageref{sampMTypes_8c}}{} +\item\contentsline{section}{\hyperlink{sampParam_8c}{sampParam.c} ((Internal) Interface to Param objects )}{\pageref{sampParam_8c}}{} +\item\contentsline{section}{\hyperlink{sampUtil_8c}{sampUtil.c} (Utility methods to convert struct pointers to user handles )}{\pageref{sampUtil_8c}}{} +\end{CompactList} diff --git a/vendor/voclient/libsamp/doc/latex/refman.tex b/vendor/voclient/libsamp/doc/latex/refman.tex new file mode 100644 index 00000000..9f3cb083 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/refman.tex @@ -0,0 +1,80 @@ +\documentclass[letterpaper]{book} +\usepackage{makeidx} +\usepackage{fancyhdr} +\usepackage{graphicx} +\usepackage{multicol} +\usepackage{float} +\usepackage{listings} +\usepackage{color} +\usepackage{textcomp} +\usepackage{alltt} +\usepackage{times} +\usepackage{ifpdf} +\ifpdf +\usepackage[pdftex, + pagebackref=true, + colorlinks=true, + linkcolor=blue, + unicode + ]{hyperref} +\else +\usepackage[ps2pdf, + pagebackref=true, + colorlinks=true, + linkcolor=blue, + unicode + ]{hyperref} +\usepackage{pspicture} +\fi +\usepackage[utf8]{inputenc} +\usepackage{doxygen} +\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=4,numbers=left } +\makeindex +\setcounter{tocdepth}{3} +\renewcommand{\footrulewidth}{0.4pt} +\begin{document} +\hypersetup{pageanchor=false} +\begin{titlepage} +\vspace*{7cm} +\begin{center} +{\Large SAMP Client Library \\[1ex]\large v1.0 }\\ +\vspace*{1cm} +{\large Generated by Doxygen 1.5.9}\\ +\vspace*{0.5cm} +{\small Wed Feb 27 21:10:15 2013}\\ +\end{center} +\end{titlepage} +\clearemptydoublepage +\pagenumbering{roman} +\tableofcontents +\clearemptydoublepage +\pagenumbering{arabic} +\hypersetup{pageanchor=true} +\chapter{Data Structure Index} +\input{annotated} +\chapter{File Index} +\input{files} +\chapter{Data Structure Documentation} +\input{structappMD} +\include{structClient} +\include{structHub} +\include{structSamp} +\include{structSubs} +\chapter{File Documentation} +\input{samp_8c} +\include{samp_8h} +\include{sampClient_8c} +\include{sampCommands_8c} +\include{sampDecl_8h} +\include{sampHandlers_8c} +\include{sampHub_8c} +\include{sampList_8c} +\include{sampLog_8c} +\include{sampMap_8c} +\include{sampMethods_8c} +\include{sampMsg_8c} +\include{sampMTypes_8c} +\include{sampParam_8c} +\include{sampUtil_8c} +\printindex +\end{document} diff --git a/vendor/voclient/libsamp/doc/latex/sampClient_8c.tex b/vendor/voclient/libsamp/doc/latex/sampClient_8c.tex new file mode 100644 index 00000000..38107a42 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampClient_8c.tex @@ -0,0 +1,246 @@ +\hypertarget{sampClient_8c}{ +\section{sampClient.c File Reference} +\label{sampClient_8c}\index{sampClient.c@{sampClient.c}} +} +\hyperlink{structClient}{Client} callable methods. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +void \hyperlink{sampClient_8c_c73788ae17493c4042948f6b861ddd74}{samp\_\-notify} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recipId, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a notify() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampClient_8c_f48228224c20ddaf8b4b4ce39fa6ec16}{samp\_\-notifyAll} (handle\_\-t handle, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a notifyAll() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} \hyperlink{sampClient_8c_68d7703657197a3d9256729cf2971033}{samp\_\-call} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recipId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-tag, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a call() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampClient_8c_66d67a1ba0dff1f6dab68f74299f500a}{samp\_\-callAll} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-tag, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a callAll() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampClient_8c_6780568b9e9dfae5b361c2b2e52c16ed}{samp\_\-callAndWait} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recipId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-tag, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a callAndWait() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampClient_8c_ae0a6eaf06027e28ade8865196f1e2c6}{samp\_\-Reply} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} response) +\begin{CompactList}\small\item\em Reply to a message. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} \hyperlink{sampClient_8c_0a996f4e24693c2eacba579ecbceedbb}{samp\_\-clientName} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} pubId) +\begin{CompactList}\small\item\em Get the \hyperlink{structClient}{Client} name from a pubic-id. \item\end{CompactList}\item +int \hyperlink{sampClient_8c_91aeabe77e920fc1924b1cdc4f088e64}{samp\_\-setErr} (handle\_\-t handle, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resp) +\begin{CompactList}\small\item\em Set the error response string. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} \hyperlink{sampClient_8c_4946a754670217dbdbc83cca92217022}{samp\_\-getErr} (handle\_\-t handle) +\begin{CompactList}\small\item\em Get the error response string. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +\hyperlink{structClient}{Client} callable methods. + +SAMPCLIENT.C -- \hyperlink{structClient}{Client} callable methods. + +samp\_\-notify (handle, recipId, msg\_\-map) list = samp\_\-notifyAll (handle, msg\_\-map) str = samp\_\-call (handle, recipId, tag, msg\_\-map) map = samp\_\-callAll (handle, msg\_\-tag, msg\_\-map) map = samp\_\-callAndWait (handle, recipId, msg\_\-tag, msg\_\-map) stat = samp\_\-Reply (handle, msg\_\-id, resp\_\-map) + +str = samp\_\-clientName (handle, pubId) stat = samp\_\-setErr (handle, resp\_\-map) str = samp\_\-getErr (handle) + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/11 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampClient_8c_68d7703657197a3d9256729cf2971033}{ +\index{sampClient.c@{sampClient.c}!samp\_\-call@{samp\_\-call}} +\index{samp\_\-call@{samp\_\-call}!sampClient.c@{sampClient.c}} +\subsubsection[{samp\_\-call}]{\setlength{\rightskip}{0pt plus 5cm}{\bf String} samp\_\-call (handle\_\-t {\em handle}, \/ {\bf String} {\em recipId}, \/ {\bf String} {\em msg\_\-tag}, \/ {\bf Map} {\em msg})}} +\label{sampClient_8c_68d7703657197a3d9256729cf2971033} + + +Make a call() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-CALL -- Make a call() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recipId}]recipient ID \item[{\em msg\_\-tag}]message tag \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]message ID \end{Desc} + + +References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp\_\-app2id(), and Samp::trace. + +Referenced by samp\_\-sendMsg().\hypertarget{sampClient_8c_66d67a1ba0dff1f6dab68f74299f500a}{ +\index{sampClient.c@{sampClient.c}!samp\_\-callAll@{samp\_\-callAll}} +\index{samp\_\-callAll@{samp\_\-callAll}!sampClient.c@{sampClient.c}} +\subsubsection[{samp\_\-callAll}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-callAll (handle\_\-t {\em handle}, \/ {\bf String} {\em msg\_\-tag}, \/ {\bf Map} {\em msg})}} +\label{sampClient_8c_66d67a1ba0dff1f6dab68f74299f500a} + + +Make a callAll() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-CALLALL -- Make a callAll() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em msg\_\-tag}]message tag \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp\_\-setErr(), and Samp::trace. + +Referenced by samp\_\-Ping(), and samp\_\-sendMsg().\hypertarget{sampClient_8c_6780568b9e9dfae5b361c2b2e52c16ed}{ +\index{sampClient.c@{sampClient.c}!samp\_\-callAndWait@{samp\_\-callAndWait}} +\index{samp\_\-callAndWait@{samp\_\-callAndWait}!sampClient.c@{sampClient.c}} +\subsubsection[{samp\_\-callAndWait}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-callAndWait (handle\_\-t {\em handle}, \/ {\bf String} {\em recipId}, \/ {\bf String} {\em msg\_\-tag}, \/ {\bf Map} {\em msg})}} +\label{sampClient_8c_6780568b9e9dfae5b361c2b2e52c16ed} + + +Make a callAndWait() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-CALLANDWAIT -- Make a callAndWait() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recipId}]recipient ID \item[{\em msg\_\-tag}]message tag \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp\_\-app2id(), samp\_\-setErr(), Hub::timeout, and Samp::trace. + +Referenced by samp\_\-Ping(), and samp\_\-sendMsg().\hypertarget{sampClient_8c_0a996f4e24693c2eacba579ecbceedbb}{ +\index{sampClient.c@{sampClient.c}!samp\_\-clientName@{samp\_\-clientName}} +\index{samp\_\-clientName@{samp\_\-clientName}!sampClient.c@{sampClient.c}} +\subsubsection[{samp\_\-clientName}]{\setlength{\rightskip}{0pt plus 5cm}{\bf String} samp\_\-clientName (handle\_\-t {\em handle}, \/ {\bf String} {\em pubId})}} +\label{sampClient_8c_0a996f4e24693c2eacba579ecbceedbb} + + +Get the \hyperlink{structClient}{Client} name from a pubic-id. + +SAMP\_\-CLIENTNAME -- Get the \hyperlink{structClient}{Client} name from a pubic-id. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em pubId}]public ID \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]declared application name \end{Desc} +\hypertarget{sampClient_8c_4946a754670217dbdbc83cca92217022}{ +\index{sampClient.c@{sampClient.c}!samp\_\-getErr@{samp\_\-getErr}} +\index{samp\_\-getErr@{samp\_\-getErr}!sampClient.c@{sampClient.c}} +\subsubsection[{samp\_\-getErr}]{\setlength{\rightskip}{0pt plus 5cm}{\bf String} samp\_\-getErr (handle\_\-t {\em handle})}} +\label{sampClient_8c_4946a754670217dbdbc83cca92217022} + + +Get the error response string. + +SAMP\_\-GETERR -- Get the error response string. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]Error text string \end{Desc} + + +References Samp::errortxt.\hypertarget{sampClient_8c_c73788ae17493c4042948f6b861ddd74}{ +\index{sampClient.c@{sampClient.c}!samp\_\-notify@{samp\_\-notify}} +\index{samp\_\-notify@{samp\_\-notify}!sampClient.c@{sampClient.c}} +\subsubsection[{samp\_\-notify}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-notify (handle\_\-t {\em handle}, \/ {\bf String} {\em recipId}, \/ {\bf Map} {\em msg})}} +\label{sampClient_8c_c73788ae17493c4042948f6b861ddd74} + + +Make a notify() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-NOTIFY -- Make a notify() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recipId}]recipient ID \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::hub, hub, Hub::id, Hub::privateKey, samp\_\-app2id(), and samp\_\-nullResponse(). + +Referenced by samp\_\-sendMsg().\hypertarget{sampClient_8c_f48228224c20ddaf8b4b4ce39fa6ec16}{ +\index{sampClient.c@{sampClient.c}!samp\_\-notifyAll@{samp\_\-notifyAll}} +\index{samp\_\-notifyAll@{samp\_\-notifyAll}!sampClient.c@{sampClient.c}} +\subsubsection[{samp\_\-notifyAll}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-notifyAll (handle\_\-t {\em handle}, \/ {\bf Map} {\em msg})}} +\label{sampClient_8c_f48228224c20ddaf8b4b4ce39fa6ec16} + + +Make a notifyAll() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-NOTIFYALL -- Make a notifyAll() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, and Samp::trace. + +Referenced by samp\_\-sendMsg().\hypertarget{sampClient_8c_ae0a6eaf06027e28ade8865196f1e2c6}{ +\index{sampClient.c@{sampClient.c}!samp\_\-Reply@{samp\_\-Reply}} +\index{samp\_\-Reply@{samp\_\-Reply}!sampClient.c@{sampClient.c}} +\subsubsection[{samp\_\-Reply}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-Reply (handle\_\-t {\em handle}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em response})}} +\label{sampClient_8c_ae0a6eaf06027e28ade8865196f1e2c6} + + +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. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em msg\_\-id}]message ID \item[{\em response}]response map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, Hub::id, Hub::privateKey, and samp\_\-nullResponse(). + +Referenced by samp\_\-receiveCall().\hypertarget{sampClient_8c_91aeabe77e920fc1924b1cdc4f088e64}{ +\index{sampClient.c@{sampClient.c}!samp\_\-setErr@{samp\_\-setErr}} +\index{samp\_\-setErr@{samp\_\-setErr}!sampClient.c@{sampClient.c}} +\subsubsection[{samp\_\-setErr}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-setErr (handle\_\-t {\em handle}, \/ {\bf Map} {\em resp})}} +\label{sampClient_8c_91aeabe77e920fc1924b1cdc4f088e64} + + +Set the error response string. + +SAMP\_\-SETERR -- Set the error response string/code. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em resp}]Response map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::errortxt. + +Referenced by samp\_\-callAll(), samp\_\-callAndWait(), samp\_\-Ping(), and samp\_\-sendMsg().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampCommands_8c.tex b/vendor/voclient/libsamp/doc/latex/sampCommands_8c.tex new file mode 100644 index 00000000..820518e9 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampCommands_8c.tex @@ -0,0 +1,223 @@ +\hypertarget{sampCommands_8c}{ +\section{sampCommands.c File Reference} +\label{sampCommands_8c}\index{sampCommands.c@{sampCommands.c}} +} +SAMP commands used by app to send administrative messages. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include $<$time.h$>$}\par +{\tt \#include $<$ctype.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +int \hyperlink{sampCommands_8c_84ffd50bd4b8dc79e9cf32398c6b3d69}{samp\_\-Register} (handle\_\-t handle) +\begin{CompactList}\small\item\em Register with the \hyperlink{structHub}{Hub} using the currently stored metadata. \item\end{CompactList}\item +int \hyperlink{sampCommands_8c_106fc27544de7c25625ed60eb48e4edd}{samp\_\-UnRegister} (handle\_\-t handle) +\begin{CompactList}\small\item\em Un-Register from the hub. \item\end{CompactList}\item +int \hyperlink{sampCommands_8c_9c6024ae76103069355256c29ee22722}{samp\_\-DeclareMetadata} (handle\_\-t handle) +\begin{CompactList}\small\item\em (Re)Declare all of our metadata. \item\end{CompactList}\item +int \hyperlink{sampCommands_8c_2be0812dc8d34c68407c62762f727c51}{samp\_\-Ping} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} appName) +\begin{CompactList}\small\item\em Ping the hub/app to see if it is alive (returns $>$0). \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampCommands_8c_2ac4b5c50094c394a74f18d6ebe3cd91}{samp\_\-GetMetadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} pubId) +\begin{CompactList}\small\item\em Get the metadata for a specified app. \item\end{CompactList}\item +int \hyperlink{sampCommands_8c_d2b0bdea58688142f55faeffcfc65525}{samp\_\-DeclareSubscriptions} (handle\_\-t handle) +\begin{CompactList}\small\item\em Declare the messages we're interested in. \item\end{CompactList}\item +\hypertarget{sampCommands_8c_c4f65b6315c8bd7380176d2b97462354}{ +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \textbf{samp\_\-GetSubscriptions} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} pubId)} +\label{sampCommands_8c_c4f65b6315c8bd7380176d2b97462354} + +\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampCommands_8c_954712a523e3f86826b4711abd35b165}{samp\_\-GetRegisteredClients} (handle\_\-t handle) +\begin{CompactList}\small\item\em Get public-ids of the registered clients. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampCommands_8c_367a24fc0aa7a81416e6a0d0dbfcd93f}{samp\_\-GetSubscribedClients} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Get clients matching the mtype subscription. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +SAMP commands used by app to send administrative messages. + +SAMPCOMMANDS.C -- SAMP commands used by app to send administrative messages. + +stat = samp\_\-Register (handle) stat = samp\_\-UnRegister (handle) stat = samp\_\-DeclareMetadata (handle) stat = samp\_\-Ping (handle, appName) map = samp\_\-GetMetadata (handle, pubId) samp\_\-DeclareSubscriptions (handle) map = samp\_\-GetSubscriptions (handle) list = samp\_\-GetRegisteredClients (handle) list = samp\_\-GetSubscribedClients (handle, mtype) + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/11 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampCommands_8c_9c6024ae76103069355256c29ee22722}{ +\index{sampCommands.c@{sampCommands.c}!samp\_\-DeclareMetadata@{samp\_\-DeclareMetadata}} +\index{samp\_\-DeclareMetadata@{samp\_\-DeclareMetadata}!sampCommands.c@{sampCommands.c}} +\subsubsection[{samp\_\-DeclareMetadata}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-DeclareMetadata (handle\_\-t {\em handle})}} +\label{sampCommands_8c_9c6024ae76103069355256c29ee22722} + + +(Re)Declare all of our metadata. + +SAMP\_\-DECLAREMETATA -- (Re)Declare all of our metadata. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, and samp\_\-hubDeclareMetadata().\hypertarget{sampCommands_8c_d2b0bdea58688142f55faeffcfc65525}{ +\index{sampCommands.c@{sampCommands.c}!samp\_\-DeclareSubscriptions@{samp\_\-DeclareSubscriptions}} +\index{samp\_\-DeclareSubscriptions@{samp\_\-DeclareSubscriptions}!sampCommands.c@{sampCommands.c}} +\subsubsection[{samp\_\-DeclareSubscriptions}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-DeclareSubscriptions (handle\_\-t {\em handle})}} +\label{sampCommands_8c_d2b0bdea58688142f55faeffcfc65525} + + +Declare the messages we're interested in. + +SAMP\_\-DECLARESUBSCRIPIONS -- Declare the messages we're interested in. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, and samp\_\-hubDeclareSubscriptions(). + +Referenced by samp\_\-Unsubscribe().\hypertarget{sampCommands_8c_2ac4b5c50094c394a74f18d6ebe3cd91}{ +\index{sampCommands.c@{sampCommands.c}!samp\_\-GetMetadata@{samp\_\-GetMetadata}} +\index{samp\_\-GetMetadata@{samp\_\-GetMetadata}!sampCommands.c@{sampCommands.c}} +\subsubsection[{samp\_\-GetMetadata}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-GetMetadata (handle\_\-t {\em handle}, \/ {\bf String} {\em pubId})}} +\label{sampCommands_8c_2ac4b5c50094c394a74f18d6ebe3cd91} + + +Get the metadata for a specified app. + +SAMP\_\-GETMETADATA -- Get the metadata for a specified app. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em pubId}]App public-id \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]Map to message response \end{Desc} + + +References Samp::errortxt, Samp::hub, hub, Hub::id, and Hub::privateKey. + +Referenced by samp\_\-mapClients().\hypertarget{sampCommands_8c_954712a523e3f86826b4711abd35b165}{ +\index{sampCommands.c@{sampCommands.c}!samp\_\-GetRegisteredClients@{samp\_\-GetRegisteredClients}} +\index{samp\_\-GetRegisteredClients@{samp\_\-GetRegisteredClients}!sampCommands.c@{sampCommands.c}} +\subsubsection[{samp\_\-GetRegisteredClients}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-GetRegisteredClients (handle\_\-t {\em handle})}} +\label{sampCommands_8c_954712a523e3f86826b4711abd35b165} + + +Get public-ids of the registered clients. + +SAMP\_\-GETREGISTEREDCLIENTS -- Get public-ids of the registered clients. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to list of registered clients \end{Desc} + + +References Samp::hub, Hub::id, Hub::privateKey, samp\_\-listLen(), samp\_\-newList(), and samp\_\-setStringInList(). + +Referenced by samp\_\-mapClients().\hypertarget{sampCommands_8c_367a24fc0aa7a81416e6a0d0dbfcd93f}{ +\index{sampCommands.c@{sampCommands.c}!samp\_\-GetSubscribedClients@{samp\_\-GetSubscribedClients}} +\index{samp\_\-GetSubscribedClients@{samp\_\-GetSubscribedClients}!sampCommands.c@{sampCommands.c}} +\subsubsection[{samp\_\-GetSubscribedClients}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-GetSubscribedClients (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype})}} +\label{sampCommands_8c_367a24fc0aa7a81416e6a0d0dbfcd93f} + + +Get clients matching the mtype subscription. + +SAMP\_\-GETSUBSCRIBEDCLIENTS -- Get clients matching the mtype subscription. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to list of clients having mtype subscription \end{Desc} + + +References Samp::hub, Hub::id, Hub::privateKey, samp\_\-listLen(), samp\_\-newList(), and samp\_\-setStringInList().\hypertarget{sampCommands_8c_2be0812dc8d34c68407c62762f727c51}{ +\index{sampCommands.c@{sampCommands.c}!samp\_\-Ping@{samp\_\-Ping}} +\index{samp\_\-Ping@{samp\_\-Ping}!sampCommands.c@{sampCommands.c}} +\subsubsection[{samp\_\-Ping}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-Ping (handle\_\-t {\em handle}, \/ {\bf String} {\em appName})}} +\label{sampCommands_8c_2be0812dc8d34c68407c62762f727c51} + + +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). + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em appName}]application name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]OK or ERR if no response \end{Desc} + + +References Samp::hub, samp\_\-app2id(), samp\_\-callAll(), samp\_\-callAndWait(), samp\_\-freeMap(), samp\_\-freeMsg(), samp\_\-hubPing(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-setErr().\hypertarget{sampCommands_8c_84ffd50bd4b8dc79e9cf32398c6b3d69}{ +\index{sampCommands.c@{sampCommands.c}!samp\_\-Register@{samp\_\-Register}} +\index{samp\_\-Register@{samp\_\-Register}!sampCommands.c@{sampCommands.c}} +\subsubsection[{samp\_\-Register}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-Register (handle\_\-t {\em handle})}} +\label{sampCommands_8c_84ffd50bd4b8dc79e9cf32398c6b3d69} + + +Register with the \hyperlink{structHub}{Hub} using the currently stored metadata. + +SAMP\_\-REGISTER -- Register with the \hyperlink{structHub}{Hub} using the currently stored metadata. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, Hub::hubId, Hub::id, Hub::privateKey, samp\_\-replyStatus(), Hub::secret, and Hub::selfId.\hypertarget{sampCommands_8c_106fc27544de7c25625ed60eb48e4edd}{ +\index{sampCommands.c@{sampCommands.c}!samp\_\-UnRegister@{samp\_\-UnRegister}} +\index{samp\_\-UnRegister@{samp\_\-UnRegister}!sampCommands.c@{sampCommands.c}} +\subsubsection[{samp\_\-UnRegister}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-UnRegister (handle\_\-t {\em handle})}} +\label{sampCommands_8c_106fc27544de7c25625ed60eb48e4edd} + + +Un-Register from the hub. + +SAMP\_\-UNREGISTER -- Un-Register from the hub. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, and samp\_\-hubUnRegister().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampDecl_8h.tex b/vendor/voclient/libsamp/doc/latex/sampDecl_8h.tex new file mode 100644 index 00000000..6cde2e60 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampDecl_8h.tex @@ -0,0 +1,3333 @@ +\hypertarget{sampDecl_8h}{ +\section{sampDecl.h File Reference} +\label{sampDecl_8h}\index{sampDecl.h@{sampDecl.h}} +} +SAMP interface method declarations. + + +\subsection*{Data Structures} +\begin{CompactItemize} +\item +struct \hyperlink{structappMD}{appMD} +\item +struct \hyperlink{structSubs}{Subs} +\item +struct \hyperlink{structClient}{Client} +\item +struct \hyperlink{structHub}{Hub} +\item +struct \hyperlink{structSamp}{Samp} +\end{CompactItemize} +\subsection*{Defines} +\begin{CompactItemize} +\item +\#define \hyperlink{sampDecl_8h_6fc88d7dbc85d8d10379f58c910ce847}{SZ\_\-NAME}~256 +\item +\hypertarget{sampDecl_8h_32108415ff44b6f7537b9516f4a84be7}{ +\#define \textbf{SZ\_\-LINE}~256} +\label{sampDecl_8h_32108415ff44b6f7537b9516f4a84be7} + +\item +\hypertarget{sampDecl_8h_7b6cc171ab550fcd6c34d92e010fcec3}{ +\#define \textbf{SZ\_\-SECRET}~64} +\label{sampDecl_8h_7b6cc171ab550fcd6c34d92e010fcec3} + +\item +\hypertarget{sampDecl_8h_3e01a6ceff717c54fca995bb444611a8}{ +\#define \textbf{SZ\_\-DESC}~8192} +\label{sampDecl_8h_3e01a6ceff717c54fca995bb444611a8} + +\item +\hypertarget{sampDecl_8h_76e806c1a560659f0c849d427b64644a}{ +\#define \textbf{SZ\_\-URL}~1024} +\label{sampDecl_8h_76e806c1a560659f0c849d427b64644a} + +\item +\hypertarget{sampDecl_8h_08329a2ecb12005e4089db9f336bde2a}{ +\#define \textbf{SZ\_\-CMD}~1024} +\label{sampDecl_8h_08329a2ecb12005e4089db9f336bde2a} + +\item +\hypertarget{sampDecl_8h_6e5a1caf522da4cb934712482b0aed5b}{ +\#define \textbf{MAX\_\-SAMPS}~16} +\label{sampDecl_8h_6e5a1caf522da4cb934712482b0aed5b} + +\item +\hypertarget{sampDecl_8h_aeadc2a66777c5ca1a67bca1bc4648c5}{ +\#define \textbf{MAX\_\-HUBS}~16} +\label{sampDecl_8h_aeadc2a66777c5ca1a67bca1bc4648c5} + +\item +\hypertarget{sampDecl_8h_0543164fb84dcec0c53c79671c473519}{ +\#define \textbf{MAX\_\-MDATTRS}~32} +\label{sampDecl_8h_0543164fb84dcec0c53c79671c473519} + +\item +\hypertarget{sampDecl_8h_4cecb71b936e9c443f548540fb7a54ff}{ +\#define \textbf{MAX\_\-SUBS}~256} +\label{sampDecl_8h_4cecb71b936e9c443f548540fb7a54ff} + +\item +\hypertarget{sampDecl_8h_0a8f91f93d75a07f0ae45077db45b3eb}{ +\#define \textbf{MAX\_\-CLIENTS}~32} +\label{sampDecl_8h_0a8f91f93d75a07f0ae45077db45b3eb} + +\item +\hypertarget{sampDecl_8h_3b94af9dcb0358f28d175d80eed98330}{ +\#define \textbf{MAX\_\-ROWS}~256} +\label{sampDecl_8h_3b94af9dcb0358f28d175d80eed98330} + +\item +\hypertarget{sampDecl_8h_400c6ad9a4514ac728ef6f26c41e26df}{ +\#define \textbf{MSG\_\-SYNC}~0} +\label{sampDecl_8h_400c6ad9a4514ac728ef6f26c41e26df} + +\item +\hypertarget{sampDecl_8h_f38b71e9d650543379f59e8f7ade60c8}{ +\#define \textbf{MSG\_\-ASYNC}~1} +\label{sampDecl_8h_f38b71e9d650543379f59e8f7ade60c8} + +\item +\hypertarget{sampDecl_8h_ee5730f808625a70be4589312bd6c9ab}{ +\#define \textbf{MSG\_\-NOTIFY}~2} +\label{sampDecl_8h_ee5730f808625a70be4589312bd6c9ab} + +\item +\hypertarget{sampDecl_8h_5ce6908d24bcc91b57bc9ac9923a3855}{ +\#define \textbf{DEF\_\-CALLMODE}~MSG\_\-ASYNC} +\label{sampDecl_8h_5ce6908d24bcc91b57bc9ac9923a3855} + +\end{CompactItemize} +\subsection*{Typedefs} +\begin{CompactItemize} +\item +\hypertarget{sampDecl_8h_578aa9310452ad28beded7f62bbb46b0}{ +typedef XINT \textbf{handle\_\-t}} +\label{sampDecl_8h_578aa9310452ad28beded7f62bbb46b0} + +\item +typedef int \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} +\item +typedef int \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} +\item +typedef int \hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} +\item +typedef int \hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} +\item +typedef char $\ast$ \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} +\item +\hypertarget{sampDecl_8h_cc13f9a2430a2e5b4d08f22a005c28ca}{ +typedef struct \hyperlink{structappMD}{appMD} $\ast$ \textbf{appMDP}} +\label{sampDecl_8h_cc13f9a2430a2e5b4d08f22a005c28ca} + +\item +\hypertarget{sampDecl_8h_5f6c3b3319ba8bd60a15bac1b8fe9a96}{ +typedef struct \hyperlink{structSubs}{Subs} $\ast$ \textbf{SubsP}} +\label{sampDecl_8h_5f6c3b3319ba8bd60a15bac1b8fe9a96} + +\item +\hypertarget{sampDecl_8h_46ebb9354eb637730c6acd2818807321}{ +typedef struct \hyperlink{structClient}{Client} $\ast$ \textbf{ClientP}} +\label{sampDecl_8h_46ebb9354eb637730c6acd2818807321} + +\item +\hypertarget{sampDecl_8h_cf8156b03ce4e66cd90203b1038112a8}{ +typedef struct \hyperlink{structHub}{Hub} $\ast$ \textbf{HubP}} +\label{sampDecl_8h_cf8156b03ce4e66cd90203b1038112a8} + +\item +\hypertarget{sampDecl_8h_159006987ca77a172c19bd254cb6f1c5}{ +typedef struct \hyperlink{structSamp}{Samp} $\ast$ \textbf{SampP}} +\label{sampDecl_8h_159006987ca77a172c19bd254cb6f1c5} + +\end{CompactItemize} +\subsection*{Functions} +\begin{CompactItemize} +\item +handle\_\-t \hyperlink{sampDecl_8h_30f39c72c3783055faa82ad3860f3d1d}{sampInit} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} appName, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} description) +\begin{CompactList}\small\item\em Initialize the SAMP interface. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_2e77115e730e95b31d897b8c50999b74}{samp\_\-Metadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} field, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} value) +\begin{CompactList}\small\item\em Set a metadata field value for the application. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_c6b76655d73825acdacfac8b5a1139ee}{samp\_\-Subscribe} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, void $\ast$func) +\begin{CompactList}\small\item\em Subscribe to a given mtype. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_b3fded97bbbf3751c4916543959f16a5}{samp\_\-Unsubscribe} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Unsubscribe to a given mtype. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_8e18ae12df031094ace47863f93b3634}{sampStartup} (handle\_\-t handle) +\begin{CompactList}\small\item\em Startup the SAMP interface to send/receive messages. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_65908d088c8b917d10db38c147590ad9}{sampShutdown} (handle\_\-t handle) +\begin{CompactList}\small\item\em Shut down the active SAMP interface. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_123413db26ad50a84bd41863af5deae5}{sampClose} (handle\_\-t handle) +\begin{CompactList}\small\item\em Close the SAMP interface and free resources. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_1d00dc78292cfbc01262ef65ab055063}{samp\_\-setSyncMode} (handle\_\-t handle) +\begin{CompactList}\small\item\em Set the calling mode to use synchronous messaging. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_a9aef12dd82bfd38a2382a4ac88c54af}{samp\_\-setASyncMode} (handle\_\-t handle) +\begin{CompactList}\small\item\em Set the calling mode to use asynchronous messaging. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_9056a8601300892f918835259c7fdb3b}{samp\_\-setNotifyMode} (handle\_\-t handle) +\begin{CompactList}\small\item\em Set the calling mode to use notification messaging. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_d4c1514e94c9ef511cfcd27004c38c4d}{samp\_\-setCallByRef} (handle\_\-t handle) +\begin{CompactList}\small\item\em Have interface call user handlers by reference. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_fc27715ec9a5cb60cf0b5415eb7f9a48}{samp\_\-setCallMode} (handle\_\-t handle, int mode) +\begin{CompactList}\small\item\em Set the default calling mode (synch or asynch). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_a3c0bdb4c512357dbc53b0ad7a7d5b01}{samp\_\-setReplyCallback} (handle\_\-t handle, int $\ast$func) +\begin{CompactList}\small\item\em Set the Reply callback. samp\_\-setReplyCallback (handle\_\-t handle, int $\ast$func). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_3db66f28546459327665f8491ea97f4d}{samp\_\-setResponseCallback} (handle\_\-t handle, int $\ast$func) +\begin{CompactList}\small\item\em Set the Response callback. samp\_\-setResponseCallback (handle\_\-t handle, int $\ast$func). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_e11a97c262ab5ab4438eca6c60c0d8cf}{samp\_\-setTimeout} (handle\_\-t handle, int timeout) +\begin{CompactList}\small\item\em Set the message timeout value (in seconds). \item\end{CompactList}\item +\hypertarget{sampDecl_8h_7731da5bec549e7554d1bdc11b13eaf6}{ +void \textbf{samp\_\-setAppName} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name)} +\label{sampDecl_8h_7731da5bec549e7554d1bdc11b13eaf6} + +\item +void \hyperlink{sampDecl_8h_8fbfdc550ede5d52840300ab33639c49}{samp\_\-setAppVersion} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} version) +\begin{CompactList}\small\item\em Set the application name string. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_96851f1c15e4baf67949d86d15f2568d}{samp\_\-defaultReplyHandler} (handle\_\-t handle) +\begin{CompactList}\small\item\em The interface's default Reply handler. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_cd506ac12f25f64ada7c9859af3f857f}{ +void \textbf{samp\_\-deaultfResponseHandler} (handle\_\-t handle)} +\label{sampDecl_8h_cd506ac12f25f64ada7c9859af3f857f} + +\item +int \hyperlink{sampDecl_8h_d47754f3b9fceff4d3019821519432b4}{samp\_\-replyStatus} (handle\_\-t handle) +\begin{CompactList}\small\item\em Reply with the status of the last message sent. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_ff4d125fc9594be25984989fad2fd3c8}{samp\_\-mapClients} (handle\_\-t handle) +\item +int \hyperlink{sampDecl_8h_1e494e73abe2ddfd946fb39e84da42a9}{samp\_\-listClients} (handle\_\-t handle) +\item +int \hyperlink{sampDecl_8h_8a2111bbe4c88cef635e3bf67e899563}{samp\_\-addClient} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} id) +\item +int \hyperlink{sampDecl_8h_e30e492f306a40f853a454faf60ab479}{samp\_\-removeClient} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} id) +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampDecl_8h_cbf9b52550a9ab0b3515c32e692c46fb}{samp\_\-getOKMap} (void) +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampDecl_8h_27baec44edb57136951b5f86ae893246}{samp\_\-getNullMap} (void) +\item +int \hyperlink{sampDecl_8h_84ffd50bd4b8dc79e9cf32398c6b3d69}{samp\_\-Register} (handle\_\-t handle) +\begin{CompactList}\small\item\em Register with the \hyperlink{structHub}{Hub} using the currently stored metadata. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_106fc27544de7c25625ed60eb48e4edd}{samp\_\-UnRegister} (handle\_\-t handle) +\begin{CompactList}\small\item\em Un-Register from the hub. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_9c6024ae76103069355256c29ee22722}{samp\_\-DeclareMetadata} (handle\_\-t handle) +\begin{CompactList}\small\item\em (Re)Declare all of our metadata. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_2be0812dc8d34c68407c62762f727c51}{samp\_\-Ping} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} appName) +\begin{CompactList}\small\item\em Ping the hub/app to see if it is alive (returns $>$0). \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampDecl_8h_2ac4b5c50094c394a74f18d6ebe3cd91}{samp\_\-GetMetadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} pubId) +\begin{CompactList}\small\item\em Get the metadata for a specified app. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_d2b0bdea58688142f55faeffcfc65525}{samp\_\-DeclareSubscriptions} (handle\_\-t handle) +\begin{CompactList}\small\item\em Declare the messages we're interested in. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_c4f65b6315c8bd7380176d2b97462354}{ +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \textbf{samp\_\-GetSubscriptions} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} pubId)} +\label{sampDecl_8h_c4f65b6315c8bd7380176d2b97462354} + +\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampDecl_8h_954712a523e3f86826b4711abd35b165}{samp\_\-GetRegisteredClients} (handle\_\-t handle) +\begin{CompactList}\small\item\em Get public-ids of the registered clients. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampDecl_8h_367a24fc0aa7a81416e6a0d0dbfcd93f}{samp\_\-GetSubscribedClients} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Get clients matching the mtype subscription. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_34e9d38073f36daaf41c418f8d680ee5}{samp\_\-tableLoadVOTable} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Tell an app to load a VOTable. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_74aeaaf742121348390ec854c30c1479}{samp\_\-tableLoadFITS} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Tell an app to load a FITS table. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_4812b571ed87f7842ca20b7024770df3}{samp\_\-imageLoadFITS} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} imageId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Tell an app to load a FITS image. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_e38ac987f1dfd87ad64f97d55396270e}{samp\_\-tableHighlightRow} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, int row) +\begin{CompactList}\small\item\em Tell an app to highlight a table row. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_f133efb67fe4bcfd2b9c8ab9d23b4c5e}{samp\_\-tableSelectRowList} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, int rows\mbox{[}$\,$\mbox{]}, int nrows) +\begin{CompactList}\small\item\em Tell an app to select a list of table rows. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_e1e86e79d9a1768e5f265cbb44279172}{samp\_\-coordPointAtSky} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, float ra, float dec) +\begin{CompactList}\small\item\em Tell an app to point at an RA/Dec coordinate. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_18b351385bd175581a6788a4f7342f07}{samp\_\-specLoadSSAGeneric} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} meta, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} spectrumId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Load a generic spectrum from an SSA service. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_5900317c1609ddd5b6da70dc0eb2040c}{samp\_\-cmdExec} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} cmd) +\begin{CompactList}\small\item\em Execute a command in a remote application. \item\end{CompactList}\item +char $\ast$ \hyperlink{sampDecl_8h_9c64fef9c158d7fd4ff7f72691ccd319}{samp\_\-envGet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Get an environment variable in a remote application. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_ded4b8bdac87c5b6faa7f13d8abb22a1}{samp\_\-envSet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} value) +\begin{CompactList}\small\item\em Set an environment variable in a remote application. \item\end{CompactList}\item +char $\ast$ \hyperlink{sampDecl_8h_19b75403d63714c4fccc8a8d4fa4c8cf}{samp\_\-paramGet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Get a parameter variable in a remote application. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_535cb6760c733a75746d2f104b1a01be}{samp\_\-paramSet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} value) +\begin{CompactList}\small\item\em Set an parameter variable in a remote application. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_ae7f51c1f6169b918568a1202d0fa031}{samp\_\-bibLoad} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} bibcode) +\begin{CompactList}\small\item\em Exchange a bibcode. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_8013c549ef47e0507edf39c8ab1b62aa}{samp\_\-resourceLoad} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} type, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resMap) +\begin{CompactList}\small\item\em Exchange a resource list. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_b2ff2e029c57b56ad57416c624341fe6}{samp\_\-sendGeneric} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} args\mbox{[}$\,$\mbox{]}) +\begin{CompactList}\small\item\em Send a geenric message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_80ef1a82845b96091857c7d4a3c7972c}{samp\_\-sendMsg} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Send the specified message. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_c73788ae17493c4042948f6b861ddd74}{samp\_\-notify} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recipId, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a notify() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampDecl_8h_f48228224c20ddaf8b4b4ce39fa6ec16}{samp\_\-notifyAll} (handle\_\-t handle, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a notifyAll() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} \hyperlink{sampDecl_8h_77f32922cfe662f4b423b678ba09513c}{samp\_\-call} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recipId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tag, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a call() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_66d67a1ba0dff1f6dab68f74299f500a}{samp\_\-callAll} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-tag, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a callAll() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_6780568b9e9dfae5b361c2b2e52c16ed}{samp\_\-callAndWait} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recipId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-tag, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a callAndWait() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_9c6ff3d76997c3d7301a977309a117e0}{samp\_\-Reply} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resp) +\begin{CompactList}\small\item\em Reply to a message. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} \hyperlink{sampDecl_8h_0a996f4e24693c2eacba579ecbceedbb}{samp\_\-clientName} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} pubId) +\begin{CompactList}\small\item\em Get the \hyperlink{structClient}{Client} name from a pubic-id. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_91aeabe77e920fc1924b1cdc4f088e64}{samp\_\-setErr} (handle\_\-t handle, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resp) +\begin{CompactList}\small\item\em Set the error response string. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} \hyperlink{sampDecl_8h_4946a754670217dbdbc83cca92217022}{samp\_\-getErr} (handle\_\-t handle) +\begin{CompactList}\small\item\em Get the error response string. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_59f85e0fce4c9ae7121c98e137d3f743}{samp\_\-receiveCall} (void $\ast$data) +\begin{CompactList}\small\item\em test.echo method \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_03be7cc9e154a6ccdd499286df640936}{samp\_\-receiveNotification} (void $\ast$data) +\begin{CompactList}\small\item\em receiveNotification () client method. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_754b50ad59145c7fd1e4c8f4277f11e4}{samp\_\-receiveResponse} (void $\ast$data) +\begin{CompactList}\small\item\em receiveResponse () client method. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_81222e1f3572585fa30f11a78aa08c3f}{samp\_\-setUserHandler} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, void $\ast$func) +\begin{CompactList}\small\item\em Set the user-interface handler for the mtype. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_2e8ec01a0dd96314622ae313206583db}{samp\_\-setSampHandler} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, void $\ast$func) +\begin{CompactList}\small\item\em Set the SAMP interface handler for the mtype. \item\end{CompactList}\item +void $\ast$ \hyperlink{sampDecl_8h_6bb258d378627da1aa0254fccdb6bd2c}{samp\_\-getUserHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Get the User handler for the named mtype. \item\end{CompactList}\item +void $\ast$ \hyperlink{sampDecl_8h_6ef18dbc5870f58d2161c9ba03a81d26}{samp\_\-getSampHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Get the Samphandler for the named mtype. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_979664bde900a1e1bf7bc499dc92898e}{samp\_\-execUserHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} params) +\begin{CompactList}\small\item\em Execute the user-defined handler for the mtype. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_1b7812ba89eebe15ad24f36a3d439a0a}{ +int \textbf{samp\_\-genericMsgHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map)} +\label{sampDecl_8h_1b7812ba89eebe15ad24f36a3d439a0a} + +\item +int \hyperlink{sampDecl_8h_16d8b8822d169107b8702ae753797923}{samp\_\-PingHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Is app alive and responding to messages? \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_2e342b672e77e012cc98a6f5506a44be}{samp\_\-StatusHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Return status of the task. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_9bd8036dd65dc4f874f39568b691a123}{samp\_\-imLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle an image.load.fits message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_26f96dc6cbf72283e2ee9cb8b4619ed3}{samp\_\-tbLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a generic table.load.$\ast$ message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_750c0fee0c7a99e135299c08751f288c}{samp\_\-tbLoadFITSHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a generic table.load.fits message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_144ec2329355d91022d5ea38736c0093}{samp\_\-tbLoadVOTHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a generic table.load.votable message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_bc319b97b3dbea29bd79c4f723db5438}{samp\_\-specLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a spectrum.load.$\ast$ message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_dd2bca8fa3bf3b4ebbf449edc6b65d85}{samp\_\-specSSAHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a spectrum.load.ssa-generic message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_d9184eb45a5bc93b5205fd5b1c6ef688}{samp\_\-tbHighlightHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a table.highlight.row message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_98d68d7091c0b7790631bb53e0ace656}{samp\_\-tbSelectHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a table.select.rowList message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_3f5632858a2b09759ffe98cd2e183cfb}{samp\_\-pointAtHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a coord.pointAt.sky message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_262bf09278c61b60b5189fef7f26d26b}{samp\_\-bibcodeHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a bibcode.load message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_c57d19afc6fa0b4bc9c7a0fd50d0f54b}{samp\_\-cmdExecHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.cmd.exec message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_e25a92f57babd71d43653d7fcb81025c}{samp\_\-envGetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.env.set message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_0910e6b9d11cdd3111c1f18450de394a}{samp\_\-envSetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.env.set message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_659c272ce881662c1826a04728dc06f6}{samp\_\-paramGetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.param.set message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_071aa9e32f2e94d5b667e87cf65d2bdf}{samp\_\-paramSetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.param.set message. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_c0bf7cf7fea362c0c82ad7bc3f267c48}{samp\_\-resLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_287569451dc1bf59d1f9f6d13b56716d}{samp\_\-resConeHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_8b2300222d7b11f144eb4385412e69a5}{samp\_\-resSiapHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_866578a01c3b762435823b1b11869c42}{samp\_\-resSsapHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_ad42ca17cbaf23012ad497559ea45e4c}{samp\_\-resTapHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_fa207ebdc587ba5eeab60fbf79b635d4}{samp\_\-resVOSpaceHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +\hypertarget{sampDecl_8h_e743048f5b1f903496b2a8a2e9666367}{ +void \textbf{samp\_\-printMessage} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} params)} +\label{sampDecl_8h_e743048f5b1f903496b2a8a2e9666367} + +\item +void \hyperlink{sampDecl_8h_a8a947c24f2c9333adf4e5d7fa11d134}{samp\_\-printMap} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\item +int \hyperlink{sampDecl_8h_5361571754505eaefdf5739cd3e9519e}{samp\_\-nullResponse} (void $\ast$data) +\item +\hypertarget{sampDecl_8h_cc687f745f400b41c9af4f6419bf9bf8}{ +int \textbf{samp\_\-testEcho} (void $\ast$data)} +\label{sampDecl_8h_cc687f745f400b41c9af4f6419bf9bf8} + +\item +handle\_\-t \hyperlink{sampDecl_8h_2b208c34c0e6017f071b9ce654d0f3d6}{samp\_\-hubOpen} (\hyperlink{structSamp}{Samp} $\ast$samp) +\begin{CompactList}\small\item\em Discover and open a connection to the SAMP \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_52f471568663ac6f0116d57a9ce00f00}{samp\_\-hubClose} (handle\_\-t handle) +\begin{CompactList}\small\item\em Close a connection to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampDecl_8h_e792eedc70daa9b2d010ca6cd8e57fe8}{samp\_\-getAvailableHubs} (handle\_\-t handle) +\begin{CompactList}\small\item\em Get a list of available Hubs. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_4b4292d136520c3d276d655e2093dd30}{ +char $\ast$ \textbf{samp\_\-getActiveHubName} (handle\_\-t handle)} +\label{sampDecl_8h_4b4292d136520c3d276d655e2093dd30} + +\item +\hypertarget{sampDecl_8h_bf266e81b16f556e2f42cad5a2eb9157}{ +int \textbf{samp\_\-getActiveHub} (handle\_\-t handle)} +\label{sampDecl_8h_bf266e81b16f556e2f42cad5a2eb9157} + +\item +\hypertarget{sampDecl_8h_12c4307b544d66d57d54cbc4c031dd35}{ +int \textbf{samp\_\-hubInit} (handle\_\-t samp, char $\ast$appName, char $\ast$descr)} +\label{sampDecl_8h_12c4307b544d66d57d54cbc4c031dd35} + +\item +int \hyperlink{sampDecl_8h_2933b26ac05c440196368edad0167bdf}{samp\_\-processHubEvent} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} params) +\begin{CompactList}\small\item\em Determine the type of \hyperlink{structHub}{Hub} event mtype. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_19f64b527fcc431541206e41f8e36132}{samp\_\-hubEvent} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Determine the type of \hyperlink{structHub}{Hub} event mtype. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_13ad32079ae1db571e3114b7bd8ba356}{samp\_\-hubRegister} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Send a Register message to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_6d4e32ed0eb19f02cc8a75f75a98deec}{samp\_\-hubUnRegister} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Send a UnRegister message to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_a704d2a0d290f2fdfb3ebfffc39adcb3}{samp\_\-hubSendShutdown} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Send a samp.app.event.shutdown message to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_2fcb0032e5ae98fff93becdb06da49f9}{samp\_\-hubSetXmlrpcCallback} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Set the client callback and send to \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_47b1a9a4627fde97f95b40b372153cf6}{samp\_\-hubPing} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Ping the \hyperlink{structHub}{Hub} to see if it is alive. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_088f1e762175d0dbc315853d06e50149}{samp\_\-hubDeclareMetadata} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Declare \char`\"{}standard\char`\"{} metadata to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_7be493427eac28b2a064eedd8a7d63ff}{samp\_\-hubDeclareSubscriptions} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Declare mtype subscriptions to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +handle\_\-t \hyperlink{sampDecl_8h_b5375a6478dccefe7df2b48416604b29}{samp\_\-newList} () +\begin{CompactList}\small\item\em Create a new List object. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_b162ae9b9f98da80f6bb5c34b5cbcbf6}{samp\_\-freeList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list) +\begin{CompactList}\small\item\em Free the given List object. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_c260afb0cbf19b427e3eba96a2341e52}{samp\_\-listLen} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list) +\begin{CompactList}\small\item\em Get number of elements in a List. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_5b69180b036e58528c98b1cf5a42825a}{samp\_\-setStringInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, char $\ast$value) +\begin{CompactList}\small\item\em Set a string in a List (append). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_ea188bb711f3b5549d11204b0ff2da08}{samp\_\-setMapInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\begin{CompactList}\small\item\em Set a Map in a List (append). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_0ff97d44e62b7c88a046a29324552400}{samp\_\-setListInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list1, \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list2) +\begin{CompactList}\small\item\em Set a List in another List (append). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_2d8a8a26d7284bb211a933895cddd29c}{samp\_\-setIntInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int value) +\begin{CompactList}\small\item\em Set an Int in a List (append). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_041a551aff57ca03f3ff72a9803e2b58}{samp\_\-setFloatInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, float value) +\begin{CompactList}\small\item\em Set a Float in a List (append). \item\end{CompactList}\item +char $\ast$ \hyperlink{sampDecl_8h_2d1cd41c4583ac300aaa2d50ad3f76ed}{samp\_\-getStringFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a string from the List. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampDecl_8h_33ca96ee3a8e7d26356c7b66f469da74}{samp\_\-getMapFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a Map from the List. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampDecl_8h_1ec1ddadb4e889792b6fa7df6f6c3125}{samp\_\-getListFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a List from the List. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_1174e001b2d16ed0aa1b317cfc883af1}{ +int \textbf{samp\_\-getIntFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index)} +\label{sampDecl_8h_1174e001b2d16ed0aa1b317cfc883af1} + +\item +float \hyperlink{sampDecl_8h_4e8339b2b3f5ff1a58cebb74eddca9e6}{samp\_\-getFloatFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a Float from the List. \item\end{CompactList}\item +handle\_\-t \hyperlink{sampDecl_8h_55c96c3dfe79d00b8445a60769785dae}{samp\_\-newMap} (void) +\begin{CompactList}\small\item\em Create a new Map object. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_fe80438de542c6657d623993360b37d1}{samp\_\-freeMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\begin{CompactList}\small\item\em Free the given Map object. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_1c99f7146ad3acd3e381a02d5df1234f}{ +int \textbf{samp\_\-getMapSize} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map)} +\label{sampDecl_8h_1c99f7146ad3acd3e381a02d5df1234f} + +\item +\hypertarget{sampDecl_8h_4c8a1b402743b52f2837e97cf41e9e34}{ +char $\ast$ \textbf{samp\_\-getMapKey} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, int index)} +\label{sampDecl_8h_4c8a1b402743b52f2837e97cf41e9e34} + +\item +\hypertarget{sampDecl_8h_7dcdf07dd7f3252f3bf2dd5002c62251}{ +char $\ast$ \textbf{samp\_\-getMapVal} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, int index)} +\label{sampDecl_8h_7dcdf07dd7f3252f3bf2dd5002c62251} + +\item +void \hyperlink{sampDecl_8h_b9b2157de89369eb5cd95bfe804eb89a}{samp\_\-setStringInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, char $\ast$value) +\begin{CompactList}\small\item\em Set a string in a Map (append). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_f102490efe1b92d99b67f244dc498c7b}{samp\_\-setMapInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map1, char $\ast$key, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map2) +\begin{CompactList}\small\item\em Set a Map in a Map (append). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_362c2f670c98dd6a3ef69debd1871604}{samp\_\-setListInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list) +\begin{CompactList}\small\item\em Set a List in a Map (append). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_c22ec42dbf9a01c9b4e00cf011e7eb9d}{samp\_\-setIntInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, int value) +\begin{CompactList}\small\item\em Set a Int in a Map (append). \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_0f07ae542f5b317311b3799bd96a88fd}{samp\_\-setFloatInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, float value) +\begin{CompactList}\small\item\em Set a string in a Map (append). \item\end{CompactList}\item +char $\ast$ \hyperlink{sampDecl_8h_96ca606e0e7da659c3dc0a30846bcd66}{samp\_\-getStringFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a string from the Map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampDecl_8h_525e8ffdfa32867f392f2c1340215453}{samp\_\-getMapFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a Map from the Map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampDecl_8h_31ddb90cf2184ae0151b9e7ec8c1a51f}{samp\_\-getListFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a LIST from the Map. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_210fc0eba30abddf1bdc2e780d58072c}{samp\_\-getIntFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a integer from the Map. \item\end{CompactList}\item +float \hyperlink{sampDecl_8h_b0d3768990294554a298c4057b3b315d}{samp\_\-getFloatFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a float from the Map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} \hyperlink{sampDecl_8h_1a66c53bb9e023fb0219ab9baeded3d6}{samp\_\-newMsg} (void) +\begin{CompactList}\small\item\em Create a new Msg object. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_adf2979a5fad0c9a855740330b7fd9ce}{samp\_\-freeMsg} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg) +\begin{CompactList}\small\item\em Free the given Msg object. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_34c9e29fa57216f19a70764df8e5826b}{ +void \textbf{samp\_\-msgMType} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype)} +\label{sampDecl_8h_34c9e29fa57216f19a70764df8e5826b} + +\item +void \hyperlink{sampDecl_8h_281c8f7f8b21a74704dd200d5aaed481}{samp\_\-msgParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, \hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} param) +\begin{CompactList}\small\item\em Add a parameter to the Msg. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_cb9eff6a0f442a1c9fde13c1e9fc097d}{ +char $\ast$ \textbf{samp\_\-msgTag} (void)} +\label{sampDecl_8h_cb9eff6a0f442a1c9fde13c1e9fc097d} + +\item +\hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} \hyperlink{sampDecl_8h_c58f0b105566a61785fb9f2ed9b42830}{samp\_\-newParam} (void) +\begin{CompactList}\small\item\em Create a new Param object. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_5a6fbf3ac37164268afae80c35666c5e}{samp\_\-freeParam} (\hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} param) +\begin{CompactList}\small\item\em Free the given Msg object. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} \hyperlink{sampDecl_8h_d8c5669be313874fef1c484643683f49}{samp\_\-paramInit} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg) +\begin{CompactList}\small\item\em Get number of Params. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_62c2d0b887252730fd6f7bdaa7211403}{ +void \textbf{samp\_\-addStringParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} val)} +\label{sampDecl_8h_62c2d0b887252730fd6f7bdaa7211403} + +\item +void \hyperlink{sampDecl_8h_e3e90c84dd6b1a08d8af18ca9e168b37}{samp\_\-addMapParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} val) +\begin{CompactList}\small\item\em Add a parameter to the Param. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_24f72c4ed033ed2f219b420e491b3c0f}{samp\_\-addListParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} val) +\begin{CompactList}\small\item\em Add a parameter to the Param. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_6897da75444209fc1819042bde906aa6}{samp\_\-addIntParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, int val) +\begin{CompactList}\small\item\em Add a $<$SAMP int$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_d297770f4ab1338697d69b2705d6c1d9}{samp\_\-addFloatParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, float val) +\begin{CompactList}\small\item\em Add a $<$SAMP float$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_7680995e5d4f26ea3d91bf72c9c72e51}{samp\_\-paramLen} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg) +\begin{CompactList}\small\item\em Get number of Params. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_4919f892b6fccced4e6b9d777071b781}{sampLog} (handle\_\-t handle, char $\ast$format,...) +\begin{CompactList}\small\item\em SAMP message logger. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_2b3dd1662e61c83e29109126689b08b9}{sampTrace} (handle\_\-t handle, char $\ast$format,...) +\begin{CompactList}\small\item\em SAMP tracer. \item\end{CompactList}\item +\hypertarget{sampDecl_8h_711aa545f55e9307f662062deefd5903}{ +handle\_\-t \textbf{samp\_\-newHandle} (void $\ast$ptr)} +\label{sampDecl_8h_711aa545f55e9307f662062deefd5903} + +\item +\hypertarget{sampDecl_8h_f02a7c646a9ed56e545d8bf33434c207}{ +void \textbf{samp\_\-freeHandle} (handle\_\-t handle)} +\label{sampDecl_8h_f02a7c646a9ed56e545d8bf33434c207} + +\item +\hypertarget{sampDecl_8h_4d0aef2f09b9cce38d4ea8024831c6e5}{ +handle\_\-t \textbf{samp\_\-P2H} (void $\ast$ptr)} +\label{sampDecl_8h_4d0aef2f09b9cce38d4ea8024831c6e5} + +\item +\hypertarget{sampDecl_8h_909310a995650c224515c9ca0a3ef582}{ +void $\ast$ \textbf{samp\_\-H2P} (handle\_\-t handle)} +\label{sampDecl_8h_909310a995650c224515c9ca0a3ef582} + +\item +char $\ast$ \hyperlink{sampDecl_8h_aed9017996a8361f8abf5b5c6a954414}{samp\_\-app2id} (handle\_\-t handle, char $\ast$appName) +\begin{CompactList}\small\item\em Convert an application name to a public-ID. \item\end{CompactList}\item +char $\ast$ \hyperlink{sampDecl_8h_a75368198ec8cd2fff6ad304806862b8}{samp\_\-id2app} (handle\_\-t handle, char $\ast$pubId) +\begin{CompactList}\small\item\em Convert a public-ID to the application name. \item\end{CompactList}\item +int \hyperlink{sampDecl_8h_0af6dba3d1022e6b220a9b1076021353}{samp\_\-serverPort} (void) +\begin{CompactList}\small\item\em Return a unique port number for the server. \item\end{CompactList}\item +void \hyperlink{sampDecl_8h_ace22fd6ada035930ef93e5a54c375b1}{samp\_\-printMetadata} (handle\_\-t handle, char $\ast$name) +\begin{CompactList}\small\item\em Print the metadata for the application. \item\end{CompactList}\item +char $\ast$ \hyperlink{sampDecl_8h_f9622190e1976c42efebd30f0c51cfe4}{samp\_\-getMetadata} (handle\_\-t handle, char $\ast$name) +\begin{CompactList}\small\item\em Get the metadata item for the application. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +SAMP interface method declarations. + +SAMPDECL.H -- SAMP interface method declarations. + +\begin{Desc} +\item[Author:]Mike FItzpatrick \end{Desc} +\begin{Desc} +\item[Date:]8/10/11 \end{Desc} + + +\subsection{Define Documentation} +\hypertarget{sampDecl_8h_6fc88d7dbc85d8d10379f58c910ce847}{ +\index{sampDecl.h@{sampDecl.h}!SZ\_\-NAME@{SZ\_\-NAME}} +\index{SZ\_\-NAME@{SZ\_\-NAME}!sampDecl.h@{sampDecl.h}} +\subsubsection[{SZ\_\-NAME}]{\setlength{\rightskip}{0pt plus 5cm}\#define SZ\_\-NAME~256}} +\label{sampDecl_8h_6fc88d7dbc85d8d10379f58c910ce847} + + +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(). + +\subsection{Typedef Documentation} +\hypertarget{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{ +\index{sampDecl.h@{sampDecl.h}!List@{List}} +\index{List@{List}!sampDecl.h@{sampDecl.h}} +\subsubsection[{List}]{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf List}}} +\label{sampDecl_8h_39f9d235896a8fd920f319105eb82791} + + +SAMP Map datatype \hypertarget{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{ +\index{sampDecl.h@{sampDecl.h}!Map@{Map}} +\index{Map@{Map}!sampDecl.h@{sampDecl.h}} +\subsubsection[{Map}]{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf Map}}} +\label{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30} + + +generic object handle \hypertarget{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{ +\index{sampDecl.h@{sampDecl.h}!Msg@{Msg}} +\index{Msg@{Msg}!sampDecl.h@{sampDecl.h}} +\subsubsection[{Msg}]{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf Msg}}} +\label{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b} + + +SAMP List datatype \hypertarget{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{ +\index{sampDecl.h@{sampDecl.h}!Param@{Param}} +\index{Param@{Param}!sampDecl.h@{sampDecl.h}} +\subsubsection[{Param}]{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf Param}}} +\label{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8} + + +SAMP Msg datatype \hypertarget{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{ +\index{sampDecl.h@{sampDecl.h}!String@{String}} +\index{String@{String}!sampDecl.h@{sampDecl.h}} +\subsubsection[{String}]{\setlength{\rightskip}{0pt plus 5cm}typedef char$\ast$ {\bf String}}} +\label{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39} + + +SAMP Param datatype + +\subsection{Function Documentation} +\hypertarget{sampDecl_8h_8a2111bbe4c88cef635e3bf67e899563}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-addClient@{samp\_\-addClient}} +\index{samp\_\-addClient@{samp\_\-addClient}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-addClient}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-addClient (handle\_\-t {\em handle}, \/ {\bf String} {\em name}, \/ {\bf String} {\em id})}} +\label{sampDecl_8h_8a2111bbe4c88cef635e3bf67e899563} + + +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().\hypertarget{sampDecl_8h_d297770f4ab1338697d69b2705d6c1d9}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-addFloatParam@{samp\_\-addFloatParam}} +\index{samp\_\-addFloatParam@{samp\_\-addFloatParam}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-addFloatParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addFloatParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ float {\em val})}} +\label{sampDecl_8h_d297770f4ab1338697d69b2705d6c1d9} + + +Add a $<$SAMP float$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +SAMP\_\-ADDFLOATPARAM -- Add a $<$SAMP float$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]floating point value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References samp\_\-paramInit().\hypertarget{sampDecl_8h_6897da75444209fc1819042bde906aa6}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-addIntParam@{samp\_\-addIntParam}} +\index{samp\_\-addIntParam@{samp\_\-addIntParam}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-addIntParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addIntParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ int {\em val})}} +\label{sampDecl_8h_6897da75444209fc1819042bde906aa6} + + +Add a $<$SAMP int$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +SAMP\_\-ADDINTPARAM -- Add a $<$SAMP int$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]integer value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References samp\_\-paramInit().\hypertarget{sampDecl_8h_24f72c4ed033ed2f219b420e491b3c0f}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-addListParam@{samp\_\-addListParam}} +\index{samp\_\-addListParam@{samp\_\-addListParam}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-addListParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addListParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ {\bf List} {\em val})}} +\label{sampDecl_8h_24f72c4ed033ed2f219b420e491b3c0f} + + +Add a parameter to the Param. + +SAMP\_\-ADDLISTPARAM -- Add a List parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]value list \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References samp\_\-paramInit().\hypertarget{sampDecl_8h_e3e90c84dd6b1a08d8af18ca9e168b37}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-addMapParam@{samp\_\-addMapParam}} +\index{samp\_\-addMapParam@{samp\_\-addMapParam}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-addMapParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addMapParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ {\bf Map} {\em val})}} +\label{sampDecl_8h_e3e90c84dd6b1a08d8af18ca9e168b37} + + +Add a parameter to the Param. + +SAMP\_\-ADDMAPPARAM -- Add a Map parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]value map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References samp\_\-paramInit().\hypertarget{sampDecl_8h_aed9017996a8361f8abf5b5c6a954414}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-app2id@{samp\_\-app2id}} +\index{samp\_\-app2id@{samp\_\-app2id}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-app2id}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-app2id (handle\_\-t {\em handle}, \/ char $\ast$ {\em appName})}} +\label{sampDecl_8h_aed9017996a8361f8abf5b5c6a954414} + + +Convert an application name to a public-ID. + +SAMP\_\-APP2ID -- Convert an application name to a public-ID. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em appName}]name of registered application \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]public ID of application \end{Desc} + + +References Samp::clients, Client::name, and Samp::nclients.\hypertarget{sampDecl_8h_262bf09278c61b60b5189fef7f26d26b}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-bibcodeHandler@{samp\_\-bibcodeHandler}} +\index{samp\_\-bibcodeHandler@{samp\_\-bibcodeHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-bibcodeHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-bibcodeHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_262bf09278c61b60b5189fef7f26d26b} + + +Handle a bibcode.load message. + +SAMP\_\-BIBCODEHANDLER -- Handle a bibcode.load message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_ae7f51c1f6169b918568a1202d0fa031}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-bibLoad@{samp\_\-bibLoad}} +\index{samp\_\-bibLoad@{samp\_\-bibLoad}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-bibLoad}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-bibLoad (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em bibcode})}} +\label{sampDecl_8h_ae7f51c1f6169b918568a1202d0fa031} + + +Exchange a bibcode. + +SAMP\_\-BIBLOAD -- Exchange a bibcode. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em bibcode}]Bibcode string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_77f32922cfe662f4b423b678ba09513c}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-call@{samp\_\-call}} +\index{samp\_\-call@{samp\_\-call}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-call}]{\setlength{\rightskip}{0pt plus 5cm}{\bf String} samp\_\-call (handle\_\-t {\em handle}, \/ {\bf String} {\em recipId}, \/ {\bf String} {\em msg\_\-tag}, \/ {\bf Map} {\em msg})}} +\label{sampDecl_8h_77f32922cfe662f4b423b678ba09513c} + + +Make a call() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-CALL -- Make a call() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recipId}]recipient ID \item[{\em msg\_\-tag}]message tag \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]message ID \end{Desc} + + +References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp\_\-app2id(), and Samp::trace.\hypertarget{sampDecl_8h_66d67a1ba0dff1f6dab68f74299f500a}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-callAll@{samp\_\-callAll}} +\index{samp\_\-callAll@{samp\_\-callAll}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-callAll}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-callAll (handle\_\-t {\em handle}, \/ {\bf String} {\em msg\_\-tag}, \/ {\bf Map} {\em msg})}} +\label{sampDecl_8h_66d67a1ba0dff1f6dab68f74299f500a} + + +Make a callAll() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-CALLALL -- Make a callAll() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em msg\_\-tag}]message tag \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp\_\-setErr(), and Samp::trace.\hypertarget{sampDecl_8h_6780568b9e9dfae5b361c2b2e52c16ed}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-callAndWait@{samp\_\-callAndWait}} +\index{samp\_\-callAndWait@{samp\_\-callAndWait}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-callAndWait}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-callAndWait (handle\_\-t {\em handle}, \/ {\bf String} {\em recipId}, \/ {\bf String} {\em msg\_\-tag}, \/ {\bf Map} {\em msg})}} +\label{sampDecl_8h_6780568b9e9dfae5b361c2b2e52c16ed} + + +Make a callAndWait() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-CALLANDWAIT -- Make a callAndWait() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recipId}]recipient ID \item[{\em msg\_\-tag}]message tag \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, samp\_\-app2id(), samp\_\-setErr(), Hub::timeout, and Samp::trace.\hypertarget{sampDecl_8h_0a996f4e24693c2eacba579ecbceedbb}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-clientName@{samp\_\-clientName}} +\index{samp\_\-clientName@{samp\_\-clientName}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-clientName}]{\setlength{\rightskip}{0pt plus 5cm}{\bf String} samp\_\-clientName (handle\_\-t {\em handle}, \/ {\bf String} {\em pubId})}} +\label{sampDecl_8h_0a996f4e24693c2eacba579ecbceedbb} + + +Get the \hyperlink{structClient}{Client} name from a pubic-id. + +SAMP\_\-CLIENTNAME -- Get the \hyperlink{structClient}{Client} name from a pubic-id. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em pubId}]public ID \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]declared application name \end{Desc} +\hypertarget{sampDecl_8h_5900317c1609ddd5b6da70dc0eb2040c}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-cmdExec@{samp\_\-cmdExec}} +\index{samp\_\-cmdExec@{samp\_\-cmdExec}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-cmdExec}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-cmdExec (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em cmd})}} +\label{sampDecl_8h_5900317c1609ddd5b6da70dc0eb2040c} + + +Execute a command in a remote application. + +SAMP\_\-CMDEXEC -- Execute a command in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em cmd}]Command string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_c57d19afc6fa0b4bc9c7a0fd50d0f54b}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-cmdExecHandler@{samp\_\-cmdExecHandler}} +\index{samp\_\-cmdExecHandler@{samp\_\-cmdExecHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-cmdExecHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-cmdExecHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_c57d19afc6fa0b4bc9c7a0fd50d0f54b} + + +Handle a client.cmd.exec message. + +SAMP\_\-CMDEXECHANDLER -- Handle a client.cmd.exec message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), and samp\_\-getUserHandler().\hypertarget{sampDecl_8h_e1e86e79d9a1768e5f265cbb44279172}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-coordPointAtSky@{samp\_\-coordPointAtSky}} +\index{samp\_\-coordPointAtSky@{samp\_\-coordPointAtSky}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-coordPointAtSky}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-coordPointAtSky (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ float {\em ra}, \/ float {\em dec})}} +\label{sampDecl_8h_e1e86e79d9a1768e5f265cbb44279172} + + +Tell an app to point at an RA/Dec coordinate. + +SAMP\_\-COORDPOINTATSKY -- Tell an app to point at an RA/Dec coordinate. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em ra}]RA of coord in degrees \item[{\em dec}]Dec of coord in degrees \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addFloatParam(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_9c6024ae76103069355256c29ee22722}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-DeclareMetadata@{samp\_\-DeclareMetadata}} +\index{samp\_\-DeclareMetadata@{samp\_\-DeclareMetadata}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-DeclareMetadata}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-DeclareMetadata (handle\_\-t {\em handle})}} +\label{sampDecl_8h_9c6024ae76103069355256c29ee22722} + + +(Re)Declare all of our metadata. + +SAMP\_\-DECLAREMETATA -- (Re)Declare all of our metadata. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, and samp\_\-hubDeclareMetadata().\hypertarget{sampDecl_8h_d2b0bdea58688142f55faeffcfc65525}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-DeclareSubscriptions@{samp\_\-DeclareSubscriptions}} +\index{samp\_\-DeclareSubscriptions@{samp\_\-DeclareSubscriptions}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-DeclareSubscriptions}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-DeclareSubscriptions (handle\_\-t {\em handle})}} +\label{sampDecl_8h_d2b0bdea58688142f55faeffcfc65525} + + +Declare the messages we're interested in. + +SAMP\_\-DECLARESUBSCRIPIONS -- Declare the messages we're interested in. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, and samp\_\-hubDeclareSubscriptions().\hypertarget{sampDecl_8h_96851f1c15e4baf67949d86d15f2568d}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-defaultReplyHandler@{samp\_\-defaultReplyHandler}} +\index{samp\_\-defaultReplyHandler@{samp\_\-defaultReplyHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-defaultReplyHandler}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-defaultReplyHandler (handle\_\-t {\em handle})}} +\label{sampDecl_8h_96851f1c15e4baf67949d86d15f2568d} + + +The interface's default Reply handler. + +SAMP\_\-DEFAULTREPLYHANDLER -- The interface's default Reply handler. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_9c64fef9c158d7fd4ff7f72691ccd319}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-envGet@{samp\_\-envGet}} +\index{samp\_\-envGet@{samp\_\-envGet}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-envGet}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-envGet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name})}} +\label{sampDecl_8h_9c64fef9c158d7fd4ff7f72691ccd319} + + +Get an environment variable in a remote application. + +SAMP\_\-ENVGET -- Get an environment variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]NULL, Value of variable, or list of values \end{Desc} + + +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.\hypertarget{sampDecl_8h_e25a92f57babd71d43653d7fcb81025c}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-envGetHandler@{samp\_\-envGetHandler}} +\index{samp\_\-envGetHandler@{samp\_\-envGetHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-envGetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-envGetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_e25a92f57babd71d43653d7fcb81025c} + + +Handle a client.env.set message. + +SAMP\_\-ENVGETHANDLER -- Handle a client.env.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-freeMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-newMap(), samp\_\-setHandlerReply(), samp\_\-setMapInMap(), samp\_\-setStringInMap(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_ded4b8bdac87c5b6faa7f13d8abb22a1}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-envSet@{samp\_\-envSet}} +\index{samp\_\-envSet@{samp\_\-envSet}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-envSet}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-envSet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name}, \/ {\bf String} {\em value})}} +\label{sampDecl_8h_ded4b8bdac87c5b6faa7f13d8abb22a1} + + +Set an environment variable in a remote application. + +SAMP\_\-ENVSET -- Set an environment variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \item[{\em value}]Value of variable or NULL \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_0910e6b9d11cdd3111c1f18450de394a}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-envSetHandler@{samp\_\-envSetHandler}} +\index{samp\_\-envSetHandler@{samp\_\-envSetHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-envSetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-envSetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_0910e6b9d11cdd3111c1f18450de394a} + + +Handle a client.env.set message. + +SAMP\_\-ENVSETHANDLER -- Handle a client.env.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_979664bde900a1e1bf7bc499dc92898e}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-execUserHandler@{samp\_\-execUserHandler}} +\index{samp\_\-execUserHandler@{samp\_\-execUserHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-execUserHandler}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-execUserHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em params})}} +\label{sampDecl_8h_979664bde900a1e1bf7bc499dc92898e} + + +Execute the user-defined handler for the mtype. + +SAMP\_\-EXECUSERHANDLER -- Execute the user-defined handler for the mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message-id string \item[{\em params}]Mtype parameter Map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::defaultUserFunc, Samp::handlerMode, samp\_\-getFloatFromMap(), samp\_\-getIntFromMap(), samp\_\-getListFromMap(), samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-listLen(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_b162ae9b9f98da80f6bb5c34b5cbcbf6}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-freeList@{samp\_\-freeList}} +\index{samp\_\-freeList@{samp\_\-freeList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-freeList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeList ({\bf List} {\em list})}} +\label{sampDecl_8h_b162ae9b9f98da80f6bb5c34b5cbcbf6} + + +Free the given List object. + +SAMP\_\-FREELIST -- Free the given List object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_fe80438de542c6657d623993360b37d1}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-freeMap@{samp\_\-freeMap}} +\index{samp\_\-freeMap@{samp\_\-freeMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-freeMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeMap ({\bf Map} {\em map})}} +\label{sampDecl_8h_fe80438de542c6657d623993360b37d1} + + +Free the given Map object. + +SAMP\_\-FREEMAP -- Free the given Map object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]Map object to free \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_adf2979a5fad0c9a855740330b7fd9ce}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-freeMsg@{samp\_\-freeMsg}} +\index{samp\_\-freeMsg@{samp\_\-freeMsg}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-freeMsg}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeMsg ({\bf Msg} {\em msg})}} +\label{sampDecl_8h_adf2979a5fad0c9a855740330b7fd9ce} + + +Free the given Msg object. + +SAMP\_\-FREEMSG -- Free the given Msg object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]Msg object to free \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_5a6fbf3ac37164268afae80c35666c5e}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-freeParam@{samp\_\-freeParam}} +\index{samp\_\-freeParam@{samp\_\-freeParam}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-freeParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeParam ({\bf Param} {\em param})}} +\label{sampDecl_8h_5a6fbf3ac37164268afae80c35666c5e} + + +Free the given Msg object. + +SAMP\_\-FREEPARAM -- Free the given Param object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em param}]Param object to free \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_e792eedc70daa9b2d010ca6cd8e57fe8}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getAvailableHubs@{samp\_\-getAvailableHubs}} +\index{samp\_\-getAvailableHubs@{samp\_\-getAvailableHubs}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getAvailableHubs}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-getAvailableHubs (handle\_\-t {\em handle})}} +\label{sampDecl_8h_e792eedc70daa9b2d010ca6cd8e57fe8} + + +Get a list of available Hubs. + +SAMP\_\-GETAVAILABLEHUBS -- Get a list of available Hubs + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]hub handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]List of hub handles \end{Desc} +\hypertarget{sampDecl_8h_4946a754670217dbdbc83cca92217022}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getErr@{samp\_\-getErr}} +\index{samp\_\-getErr@{samp\_\-getErr}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getErr}]{\setlength{\rightskip}{0pt plus 5cm}{\bf String} samp\_\-getErr (handle\_\-t {\em handle})}} +\label{sampDecl_8h_4946a754670217dbdbc83cca92217022} + + +Get the error response string. + +SAMP\_\-GETERR -- Get the error response string. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]Error text string \end{Desc} + + +References Samp::errortxt.\hypertarget{sampDecl_8h_4e8339b2b3f5ff1a58cebb74eddca9e6}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getFloatFromList@{samp\_\-getFloatFromList}} +\index{samp\_\-getFloatFromList@{samp\_\-getFloatFromList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getFloatFromList}]{\setlength{\rightskip}{0pt plus 5cm}float samp\_\-getFloatFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{sampDecl_8h_4e8339b2b3f5ff1a58cebb74eddca9e6} + + +Get a Float from the List. + +SAMP\_\-GETFLOATFROMLIST -- Get a Float from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the desired value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]int value \end{Desc} +\hypertarget{sampDecl_8h_b0d3768990294554a298c4057b3b315d}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getFloatFromMap@{samp\_\-getFloatFromMap}} +\index{samp\_\-getFloatFromMap@{samp\_\-getFloatFromMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getFloatFromMap}]{\setlength{\rightskip}{0pt plus 5cm}float samp\_\-getFloatFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampDecl_8h_b0d3768990294554a298c4057b3b315d} + + +Get a float from the Map. + +SAMP\_\-GETFLOATFROMMAP -- Get a float from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]floating point value \end{Desc} +\hypertarget{sampDecl_8h_210fc0eba30abddf1bdc2e780d58072c}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getIntFromMap@{samp\_\-getIntFromMap}} +\index{samp\_\-getIntFromMap@{samp\_\-getIntFromMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getIntFromMap}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-getIntFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampDecl_8h_210fc0eba30abddf1bdc2e780d58072c} + + +Get a integer from the Map. + +SAMP\_\-GETINTFROMMAP -- Get a integer from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]integer value \end{Desc} +\hypertarget{sampDecl_8h_1ec1ddadb4e889792b6fa7df6f6c3125}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getListFromList@{samp\_\-getListFromList}} +\index{samp\_\-getListFromList@{samp\_\-getListFromList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getListFromList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-getListFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{sampDecl_8h_1ec1ddadb4e889792b6fa7df6f6c3125} + + +Get a List from the List. + +Get an Int from the List. + +SAMP\_\-GETLISTFROMLIST -- Get a List from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the List \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]List handle\end{Desc} +SAMP\_\-GETINTFROMLIST -- Get an Int from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the desired value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]int value \end{Desc} +\hypertarget{sampDecl_8h_31ddb90cf2184ae0151b9e7ec8c1a51f}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getListFromMap@{samp\_\-getListFromMap}} +\index{samp\_\-getListFromMap@{samp\_\-getListFromMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getListFromMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-getListFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampDecl_8h_31ddb90cf2184ae0151b9e7ec8c1a51f} + + +Get a LIST from the Map. + +SAMP\_\-GETLISTFROMMAP -- Get a LIST from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to List value \end{Desc} +\hypertarget{sampDecl_8h_33ca96ee3a8e7d26356c7b66f469da74}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getMapFromList@{samp\_\-getMapFromList}} +\index{samp\_\-getMapFromList@{samp\_\-getMapFromList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getMapFromList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getMapFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{sampDecl_8h_33ca96ee3a8e7d26356c7b66f469da74} + + +Get a Map from the List. + +SAMP\_\-GETMAPFROMLIST -- Get a Map from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the Map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]Map handle \end{Desc} +\hypertarget{sampDecl_8h_525e8ffdfa32867f392f2c1340215453}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getMapFromMap@{samp\_\-getMapFromMap}} +\index{samp\_\-getMapFromMap@{samp\_\-getMapFromMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getMapFromMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getMapFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampDecl_8h_525e8ffdfa32867f392f2c1340215453} + + +Get a Map from the Map. + +SAMP\_\-GETMAPFROMMAP -- Get a Map from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to Map value \end{Desc} +\hypertarget{sampDecl_8h_f9622190e1976c42efebd30f0c51cfe4}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getMetadata@{samp\_\-getMetadata}} +\index{samp\_\-getMetadata@{samp\_\-getMetadata}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getMetadata}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-getMetadata (handle\_\-t {\em handle}, \/ {\bf String} {\em name})}} +\label{sampDecl_8h_f9622190e1976c42efebd30f0c51cfe4} + + +Get the metadata item for the application. + +SAMP\_\-GETMETADATA -- Get the metadata item for the application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References appMD::aKey, appMD::aVal, Samp::description, appMD::docURL, appMD::iconURL, Samp::meta, and appMD::nkeys.\hypertarget{sampDecl_8h_2ac4b5c50094c394a74f18d6ebe3cd91}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-GetMetadata@{samp\_\-GetMetadata}} +\index{samp\_\-GetMetadata@{samp\_\-GetMetadata}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-GetMetadata}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-GetMetadata (handle\_\-t {\em handle}, \/ {\bf String} {\em pubId})}} +\label{sampDecl_8h_2ac4b5c50094c394a74f18d6ebe3cd91} + + +Get the metadata for a specified app. + +SAMP\_\-GETMETADATA -- Get the metadata for a specified app. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em pubId}]App public-id \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]Map to message response \end{Desc} + + +References Samp::errortxt, Samp::hub, hub, Hub::id, and Hub::privateKey.\hypertarget{sampDecl_8h_27baec44edb57136951b5f86ae893246}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getNullMap@{samp\_\-getNullMap}} +\index{samp\_\-getNullMap@{samp\_\-getNullMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getNullMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getNullMap (void)}} +\label{sampDecl_8h_27baec44edb57136951b5f86ae893246} + + +SAMP\_\-GETNULLMAP -- Generate a 'Null' map we can return to the \hyperlink{structHub}{Hub}. + +References samp\_\-newMap().\hypertarget{sampDecl_8h_cbf9b52550a9ab0b3515c32e692c46fb}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getOKMap@{samp\_\-getOKMap}} +\index{samp\_\-getOKMap@{samp\_\-getOKMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getOKMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getOKMap (void)}} +\label{sampDecl_8h_cbf9b52550a9ab0b3515c32e692c46fb} + + +SAMP\_\-GETOKMAP -- Generate an 'OK' map we can return to the \hyperlink{structHub}{Hub}. + +References nullMap, samp\_\-newMap(), samp\_\-setMapInMap(), and samp\_\-setStringInMap().\hypertarget{sampDecl_8h_954712a523e3f86826b4711abd35b165}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-GetRegisteredClients@{samp\_\-GetRegisteredClients}} +\index{samp\_\-GetRegisteredClients@{samp\_\-GetRegisteredClients}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-GetRegisteredClients}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-GetRegisteredClients (handle\_\-t {\em handle})}} +\label{sampDecl_8h_954712a523e3f86826b4711abd35b165} + + +Get public-ids of the registered clients. + +SAMP\_\-GETREGISTEREDCLIENTS -- Get public-ids of the registered clients. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to list of registered clients \end{Desc} + + +References Samp::hub, Hub::id, Hub::privateKey, samp\_\-listLen(), samp\_\-newList(), and samp\_\-setStringInList().\hypertarget{sampDecl_8h_6ef18dbc5870f58d2161c9ba03a81d26}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getSampHandler@{samp\_\-getSampHandler}} +\index{samp\_\-getSampHandler@{samp\_\-getSampHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getSampHandler}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ samp\_\-getSampHandler ({\bf String} {\em mtype})}} +\label{sampDecl_8h_6ef18dbc5870f58d2161c9ba03a81d26} + + +Get the Samphandler for the named mtype. + +SAMP\_\-GETSAMPHANDLER -- Get the Samphandler for the named mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::nsubs, and Subs::sampFunc.\hypertarget{sampDecl_8h_2d1cd41c4583ac300aaa2d50ad3f76ed}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getStringFromList@{samp\_\-getStringFromList}} +\index{samp\_\-getStringFromList@{samp\_\-getStringFromList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getStringFromList}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-getStringFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{sampDecl_8h_2d1cd41c4583ac300aaa2d50ad3f76ed} + + +Get a string from the List. + +SAMP\_\-GETSTRINGFROMLIST -- Get a string from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]character string \end{Desc} +\hypertarget{sampDecl_8h_96ca606e0e7da659c3dc0a30846bcd66}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getStringFromMap@{samp\_\-getStringFromMap}} +\index{samp\_\-getStringFromMap@{samp\_\-getStringFromMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getStringFromMap}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-getStringFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampDecl_8h_96ca606e0e7da659c3dc0a30846bcd66} + + +Get a string from the Map. + +SAMP\_\-GETSTRINGFROMMAP -- Get a string from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]string value from Map \end{Desc} +\hypertarget{sampDecl_8h_367a24fc0aa7a81416e6a0d0dbfcd93f}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-GetSubscribedClients@{samp\_\-GetSubscribedClients}} +\index{samp\_\-GetSubscribedClients@{samp\_\-GetSubscribedClients}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-GetSubscribedClients}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-GetSubscribedClients (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype})}} +\label{sampDecl_8h_367a24fc0aa7a81416e6a0d0dbfcd93f} + + +Get clients matching the mtype subscription. + +SAMP\_\-GETSUBSCRIBEDCLIENTS -- Get clients matching the mtype subscription. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to list of clients having mtype subscription \end{Desc} + + +References Samp::hub, Hub::id, Hub::privateKey, samp\_\-listLen(), samp\_\-newList(), and samp\_\-setStringInList().\hypertarget{sampDecl_8h_6bb258d378627da1aa0254fccdb6bd2c}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-getUserHandler@{samp\_\-getUserHandler}} +\index{samp\_\-getUserHandler@{samp\_\-getUserHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-getUserHandler}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ samp\_\-getUserHandler ({\bf String} {\em mtype})}} +\label{sampDecl_8h_6bb258d378627da1aa0254fccdb6bd2c} + + +Get the User handler for the named mtype. + +SAMP\_\-GETUSERHANDLER -- Get the User handler for the named mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::defaultUserFunc, Samp::nsubs, and Subs::userFunc.\hypertarget{sampDecl_8h_52f471568663ac6f0116d57a9ce00f00}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubClose@{samp\_\-hubClose}} +\index{samp\_\-hubClose@{samp\_\-hubClose}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubClose}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubClose (handle\_\-t {\em handle})}} +\label{sampDecl_8h_52f471568663ac6f0116d57a9ce00f00} + + +Close a connection to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBCLOSE -- Close a connection to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]hub handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]unregister status \end{Desc} + + +References appMD::aKey, appMD::aVal, Hub::meta, appMD::nkeys, samp\_\-freeHandle(), and samp\_\-hubUnRegister().\hypertarget{sampDecl_8h_088f1e762175d0dbc315853d06e50149}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubDeclareMetadata@{samp\_\-hubDeclareMetadata}} +\index{samp\_\-hubDeclareMetadata@{samp\_\-hubDeclareMetadata}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubDeclareMetadata}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubDeclareMetadata ({\bf Hub} $\ast$ {\em hub})}} +\label{sampDecl_8h_088f1e762175d0dbc315853d06e50149} + + +Declare \char`\"{}standard\char`\"{} metadata to the \hyperlink{structHub}{Hub}. + +SAMP\_\-DECLAREMETADATA -- Declare \char`\"{}standard\char`\"{} metadata to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References appMD::aKey, appMD::aVal, Hub::description, appMD::docURL, appMD::iconURL, Hub::id, Hub::meta, appMD::nkeys, and Hub::privateKey.\hypertarget{sampDecl_8h_7be493427eac28b2a064eedd8a7d63ff}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubDeclareSubscriptions@{samp\_\-hubDeclareSubscriptions}} +\index{samp\_\-hubDeclareSubscriptions@{samp\_\-hubDeclareSubscriptions}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubDeclareSubscriptions}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubDeclareSubscriptions ({\bf Hub} $\ast$ {\em hub})}} +\label{sampDecl_8h_7be493427eac28b2a064eedd8a7d63ff} + + +Declare mtype subscriptions to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBDECLARESUBSCRIPTIONS -- Declare mtype subscriptions to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, Samp::nsubs, nullMap, Hub::privateKey, Hub::samp, samp\_\-freeMap(), and Subs::userFunc.\hypertarget{sampDecl_8h_19f64b527fcc431541206e41f8e36132}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubEvent@{samp\_\-hubEvent}} +\index{samp\_\-hubEvent@{samp\_\-hubEvent}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubEvent}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubEvent ({\bf String} {\em mtype})}} +\label{sampDecl_8h_19f64b527fcc431541206e41f8e36132} + + +Determine the type of \hyperlink{structHub}{Hub} event mtype. + +SAMP\_\-HUBEVENT -- Determine the type of \hyperlink{structHub}{Hub} event mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]\hyperlink{structHub}{Hub} event code or -1 if not found \end{Desc} + + +References HUB\_\-SHUTDOWN.\hypertarget{sampDecl_8h_2b208c34c0e6017f071b9ce654d0f3d6}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubOpen@{samp\_\-hubOpen}} +\index{samp\_\-hubOpen@{samp\_\-hubOpen}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubOpen}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t samp\_\-hubOpen ({\bf Samp} $\ast$ {\em sampP})}} +\label{sampDecl_8h_2b208c34c0e6017f071b9ce654d0f3d6} + + +Discover and open a connection to the SAMP \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBOPEN -- Discover and open a connection to the SAMP \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em samp}]Same structure \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]hub handle \end{Desc} + + +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.\hypertarget{sampDecl_8h_47b1a9a4627fde97f95b40b372153cf6}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubPing@{samp\_\-hubPing}} +\index{samp\_\-hubPing@{samp\_\-hubPing}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubPing}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubPing ({\bf Hub} $\ast$ {\em hub})}} +\label{sampDecl_8h_47b1a9a4627fde97f95b40b372153cf6} + + +Ping the \hyperlink{structHub}{Hub} to see if it is alive. + +SAMP\_\-HUBPING -- Ping the \hyperlink{structHub}{Hub} to see if it is alive. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, and Hub::privateKey.\hypertarget{sampDecl_8h_13ad32079ae1db571e3114b7bd8ba356}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubRegister@{samp\_\-hubRegister}} +\index{samp\_\-hubRegister@{samp\_\-hubRegister}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubRegister}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubRegister ({\bf Hub} $\ast$ {\em hub})}} +\label{sampDecl_8h_13ad32079ae1db571e3114b7bd8ba356} + + +Send a Register message to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUB\_\-REGISTER -- Send a Register message to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::hubId, Hub::id, Hub::privateKey, Hub::secret, and Hub::selfId.\hypertarget{sampDecl_8h_a704d2a0d290f2fdfb3ebfffc39adcb3}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubSendShutdown@{samp\_\-hubSendShutdown}} +\index{samp\_\-hubSendShutdown@{samp\_\-hubSendShutdown}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubSendShutdown}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubSendShutdown ({\bf Hub} $\ast$ {\em hub})}} +\label{sampDecl_8h_a704d2a0d290f2fdfb3ebfffc39adcb3} + + +Send a samp.app.event.shutdown message to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBSENDSHUTDOWN -- Send a samp.app.event.shutdown message to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, Hub::privateKey, and samp\_\-nullResponse().\hypertarget{sampDecl_8h_2fcb0032e5ae98fff93becdb06da49f9}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubSetXmlrpcCallback@{samp\_\-hubSetXmlrpcCallback}} +\index{samp\_\-hubSetXmlrpcCallback@{samp\_\-hubSetXmlrpcCallback}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubSetXmlrpcCallback}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubSetXmlrpcCallback ({\bf Hub} $\ast$ {\em hub})}} +\label{sampDecl_8h_2fcb0032e5ae98fff93becdb06da49f9} + + +Set the client callback and send to \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBSETXMLRPCCALLBACK -- Set the client callback and send to \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, Hub::privateKey, and samp\_\-serverPort().\hypertarget{sampDecl_8h_6d4e32ed0eb19f02cc8a75f75a98deec}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-hubUnRegister@{samp\_\-hubUnRegister}} +\index{samp\_\-hubUnRegister@{samp\_\-hubUnRegister}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-hubUnRegister}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubUnRegister ({\bf Hub} $\ast$ {\em hub})}} +\label{sampDecl_8h_6d4e32ed0eb19f02cc8a75f75a98deec} + + +Send a UnRegister message to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBUNREGISTER -- Send a UnRegister message to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, and Hub::privateKey.\hypertarget{sampDecl_8h_a75368198ec8cd2fff6ad304806862b8}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-id2app@{samp\_\-id2app}} +\index{samp\_\-id2app@{samp\_\-id2app}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-id2app}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-id2app (handle\_\-t {\em handle}, \/ char $\ast$ {\em pubId})}} +\label{sampDecl_8h_a75368198ec8cd2fff6ad304806862b8} + + +Convert a public-ID to the application name. + +SAMP\_\-ID2APP -- Convert a public-ID to the application name. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em pubId}]public ID of application \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]name of registered application \end{Desc} + + +References Samp::clients, Client::name, and Samp::nclients.\hypertarget{sampDecl_8h_4812b571ed87f7842ca20b7024770df3}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-imageLoadFITS@{samp\_\-imageLoadFITS}} +\index{samp\_\-imageLoadFITS@{samp\_\-imageLoadFITS}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-imageLoadFITS}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-imageLoadFITS (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf String} {\em imageId}, \/ {\bf String} {\em name})}} +\label{sampDecl_8h_4812b571ed87f7842ca20b7024770df3} + + +Tell an app to load a FITS image. + +SAMP\_\-IMAGELOADFITS -- Tell an app to load a FITS image. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em url}]URL to table to be loaded \item[{\em imageId}]ID assigned to image (optional) \item[{\em name}]Name assigned to image (optional) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_9bd8036dd65dc4f874f39568b691a123}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-imLoadHandler@{samp\_\-imLoadHandler}} +\index{samp\_\-imLoadHandler@{samp\_\-imLoadHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-imLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-imLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_9bd8036dd65dc4f874f39568b691a123} + + +Handle an image.load.fits message. + +SAMP\_\-IMLOADHANDLER -- Handle an image.load.fits message. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_1e494e73abe2ddfd946fb39e84da42a9}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-listClients@{samp\_\-listClients}} +\index{samp\_\-listClients@{samp\_\-listClients}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-listClients}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-listClients (handle\_\-t {\em handle})}} +\label{sampDecl_8h_1e494e73abe2ddfd946fb39e84da42a9} + + +SAMP\_\-LISTCLIENTS -- List the available clients to stdout. + +References Samp::clients, Client::name, and Samp::nclients.\hypertarget{sampDecl_8h_c260afb0cbf19b427e3eba96a2341e52}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-listLen@{samp\_\-listLen}} +\index{samp\_\-listLen@{samp\_\-listLen}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-listLen}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-listLen ({\bf List} {\em list})}} +\label{sampDecl_8h_c260afb0cbf19b427e3eba96a2341e52} + + +Get number of elements in a List. + +SAMP\_\-LISTLEN -- Get number of elements in a List. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_ff4d125fc9594be25984989fad2fd3c8}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-mapClients@{samp\_\-mapClients}} +\index{samp\_\-mapClients@{samp\_\-mapClients}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-mapClients}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-mapClients (handle\_\-t {\em handle})}} +\label{sampDecl_8h_ff4d125fc9594be25984989fad2fd3c8} + + +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().\hypertarget{sampDecl_8h_2e77115e730e95b31d897b8c50999b74}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-Metadata@{samp\_\-Metadata}} +\index{samp\_\-Metadata@{samp\_\-Metadata}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-Metadata}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-Metadata (handle\_\-t {\em handle}, \/ {\bf String} {\em field}, \/ {\bf String} {\em value})}} +\label{sampDecl_8h_2e77115e730e95b31d897b8c50999b74} + + +Set a metadata field value for the application. + +SAMP\_\-METADATA -- Set a metadata field for the application. This will be sent to the \hyperlink{structHub}{Hub} later in a declareMetadata() call. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em field}]metadata field to set (name, author, etc) \item[{\em samp}]value of field \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +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().\hypertarget{sampDecl_8h_281c8f7f8b21a74704dd200d5aaed481}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-msgParam@{samp\_\-msgParam}} +\index{samp\_\-msgParam@{samp\_\-msgParam}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-msgParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-msgParam ({\bf Msg} {\em msg}, \/ {\bf Param} {\em param})}} +\label{sampDecl_8h_281c8f7f8b21a74704dd200d5aaed481} + + +Add a parameter to the Msg. + +SAMP\_\-MSGPARAM -- Add a parameter to the Msg. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em param}]parameter map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_b5375a6478dccefe7df2b48416604b29}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-newList@{samp\_\-newList}} +\index{samp\_\-newList@{samp\_\-newList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-newList}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t samp\_\-newList (void)}} +\label{sampDecl_8h_b5375a6478dccefe7df2b48416604b29} + + +Create a new List object. + +SAMP\_\-NEWLIST -- Create a new List object + +\begin{Desc} +\item[Returns:]handle to List object \end{Desc} +\hypertarget{sampDecl_8h_55c96c3dfe79d00b8445a60769785dae}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-newMap@{samp\_\-newMap}} +\index{samp\_\-newMap@{samp\_\-newMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-newMap}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t samp\_\-newMap (void)}} +\label{sampDecl_8h_55c96c3dfe79d00b8445a60769785dae} + + +Create a new Map object. + +SAMP\_\-NEWMAP -- Create a new Map object + +\begin{Desc} +\item[Returns:]handle to new Map \end{Desc} +\hypertarget{sampDecl_8h_1a66c53bb9e023fb0219ab9baeded3d6}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-newMsg@{samp\_\-newMsg}} +\index{samp\_\-newMsg@{samp\_\-newMsg}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-newMsg}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Msg} samp\_\-newMsg (void)}} +\label{sampDecl_8h_1a66c53bb9e023fb0219ab9baeded3d6} + + +Create a new Msg object. + +SAMP\_\-NEWMSG -- Create a new Msg object + +\begin{Desc} +\item[Returns:]handle to new Msg \end{Desc} +\hypertarget{sampDecl_8h_c58f0b105566a61785fb9f2ed9b42830}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-newParam@{samp\_\-newParam}} +\index{samp\_\-newParam@{samp\_\-newParam}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-newParam}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Param} samp\_\-newParam (void)}} +\label{sampDecl_8h_c58f0b105566a61785fb9f2ed9b42830} + + +Create a new Param object. + +SAMP\_\-NEWPARAM -- Create a new Param object + +\begin{Desc} +\item[Returns:]handle to new Param \end{Desc} +\hypertarget{sampDecl_8h_c73788ae17493c4042948f6b861ddd74}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-notify@{samp\_\-notify}} +\index{samp\_\-notify@{samp\_\-notify}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-notify}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-notify (handle\_\-t {\em handle}, \/ {\bf String} {\em recipId}, \/ {\bf Map} {\em msg})}} +\label{sampDecl_8h_c73788ae17493c4042948f6b861ddd74} + + +Make a notify() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-NOTIFY -- Make a notify() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recipId}]recipient ID \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::hub, hub, Hub::id, Hub::privateKey, samp\_\-app2id(), and samp\_\-nullResponse().\hypertarget{sampDecl_8h_f48228224c20ddaf8b4b4ce39fa6ec16}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-notifyAll@{samp\_\-notifyAll}} +\index{samp\_\-notifyAll@{samp\_\-notifyAll}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-notifyAll}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-notifyAll (handle\_\-t {\em handle}, \/ {\bf Map} {\em msg})}} +\label{sampDecl_8h_f48228224c20ddaf8b4b4ce39fa6ec16} + + +Make a notifyAll() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-NOTIFYALL -- Make a notifyAll() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::debug, Samp::errortxt, Samp::hub, hub, Hub::id, Hub::privateKey, and Samp::trace.\hypertarget{sampDecl_8h_5361571754505eaefdf5739cd3e9519e}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-nullResponse@{samp\_\-nullResponse}} +\index{samp\_\-nullResponse@{samp\_\-nullResponse}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-nullResponse}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-nullResponse (void $\ast$ {\em data})}} +\label{sampDecl_8h_5361571754505eaefdf5739cd3e9519e} + + +SAMP\_\-NULLRESPONSE -- Handler to ignore async replies. \hypertarget{sampDecl_8h_19b75403d63714c4fccc8a8d4fa4c8cf}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-paramGet@{samp\_\-paramGet}} +\index{samp\_\-paramGet@{samp\_\-paramGet}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-paramGet}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-paramGet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name})}} +\label{sampDecl_8h_19b75403d63714c4fccc8a8d4fa4c8cf} + + +Get a parameter variable in a remote application. + +SAMP\_\-PARAMGET -- Get a parameter variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]NULL, Value of variable, or list of values \end{Desc} + + +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.\hypertarget{sampDecl_8h_659c272ce881662c1826a04728dc06f6}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-paramGetHandler@{samp\_\-paramGetHandler}} +\index{samp\_\-paramGetHandler@{samp\_\-paramGetHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-paramGetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramGetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_659c272ce881662c1826a04728dc06f6} + + +Handle a client.param.set message. + +SAMP\_\-PARAMGETHANDLER -- Handle a client.param.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-freeMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-newMap(), samp\_\-setHandlerReply(), samp\_\-setMapInMap(), samp\_\-setStringInMap(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_d8c5669be313874fef1c484643683f49}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-paramInit@{samp\_\-paramInit}} +\index{samp\_\-paramInit@{samp\_\-paramInit}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-paramInit}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Param} samp\_\-paramInit ({\bf Msg} {\em msg})}} +\label{sampDecl_8h_d8c5669be313874fef1c484643683f49} + + +Get number of Params. + +SAMP\_\-PARAMINIT -- Get number of Params. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_7680995e5d4f26ea3d91bf72c9c72e51}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-paramLen@{samp\_\-paramLen}} +\index{samp\_\-paramLen@{samp\_\-paramLen}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-paramLen}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramLen ({\bf Msg} {\em msg})}} +\label{sampDecl_8h_7680995e5d4f26ea3d91bf72c9c72e51} + + +Get number of Params. + +SAMP\_\-PARAMLEN -- Get number of Params. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_535cb6760c733a75746d2f104b1a01be}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-paramSet@{samp\_\-paramSet}} +\index{samp\_\-paramSet@{samp\_\-paramSet}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-paramSet}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramSet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name}, \/ {\bf String} {\em value})}} +\label{sampDecl_8h_535cb6760c733a75746d2f104b1a01be} + + +Set an parameter variable in a remote application. + +SAMP\_\-PARAMSET -- Set an parameter variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \item[{\em value}]Value of variable or NULL \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_071aa9e32f2e94d5b667e87cf65d2bdf}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-paramSetHandler@{samp\_\-paramSetHandler}} +\index{samp\_\-paramSetHandler@{samp\_\-paramSetHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-paramSetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramSetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_071aa9e32f2e94d5b667e87cf65d2bdf} + + +Handle a client.param.set message. + +SAMP\_\-PARAMSETHANDLER -- Handle a client.param.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_2be0812dc8d34c68407c62762f727c51}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-Ping@{samp\_\-Ping}} +\index{samp\_\-Ping@{samp\_\-Ping}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-Ping}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-Ping (handle\_\-t {\em handle}, \/ {\bf String} {\em appName})}} +\label{sampDecl_8h_2be0812dc8d34c68407c62762f727c51} + + +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). + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em appName}]application name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]OK or ERR if no response \end{Desc} + + +References Samp::hub, samp\_\-app2id(), samp\_\-callAll(), samp\_\-callAndWait(), samp\_\-freeMap(), samp\_\-freeMsg(), samp\_\-hubPing(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-setErr().\hypertarget{sampDecl_8h_16d8b8822d169107b8702ae753797923}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-PingHandler@{samp\_\-PingHandler}} +\index{samp\_\-PingHandler@{samp\_\-PingHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-PingHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-PingHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_16d8b8822d169107b8702ae753797923} + + +Is app alive and responding to messages? + +SAMP\_\-PINGHANDLER -- Simple aliveness test function. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, and samp\_\-getUserHandler().\hypertarget{sampDecl_8h_3f5632858a2b09759ffe98cd2e183cfb}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-pointAtHandler@{samp\_\-pointAtHandler}} +\index{samp\_\-pointAtHandler@{samp\_\-pointAtHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-pointAtHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-pointAtHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_3f5632858a2b09759ffe98cd2e183cfb} + + +Handle a coord.pointAt.sky message. + +SAMP\_\-POINTATHANDLER -- Handle a coord.pointAt.sky message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getFloatFromMap(), and samp\_\-getUserHandler().\hypertarget{sampDecl_8h_a8a947c24f2c9333adf4e5d7fa11d134}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-printMap@{samp\_\-printMap}} +\index{samp\_\-printMap@{samp\_\-printMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-printMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-printMap ({\bf String} {\em name}, \/ {\bf Map} {\em map})}} +\label{sampDecl_8h_a8a947c24f2c9333adf4e5d7fa11d134} + + +SAMP\_\-PRINTMAP -- Print the contents of a Map structure. \hypertarget{sampDecl_8h_ace22fd6ada035930ef93e5a54c375b1}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-printMetadata@{samp\_\-printMetadata}} +\index{samp\_\-printMetadata@{samp\_\-printMetadata}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-printMetadata}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-printMetadata (handle\_\-t {\em handle}, \/ {\bf String} {\em name})}} +\label{sampDecl_8h_ace22fd6ada035930ef93e5a54c375b1} + + +Print the metadata for the application. + +SAMP\_\-PRINTMETADATA -- Print the metadata for the application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References appMD::aKey, appMD::aVal, Samp::description, appMD::docURL, appMD::iconURL, Samp::meta, and appMD::nkeys.\hypertarget{sampDecl_8h_2933b26ac05c440196368edad0167bdf}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-processHubEvent@{samp\_\-processHubEvent}} +\index{samp\_\-processHubEvent@{samp\_\-processHubEvent}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-processHubEvent}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-processHubEvent ({\bf String} {\em mtype}, \/ {\bf Map} {\em params})}} +\label{sampDecl_8h_2933b26ac05c440196368edad0167bdf} + + +Determine the type of \hyperlink{structHub}{Hub} event mtype. + +SAMP\_\-HUBEVENT -- Determine the type of \hyperlink{structHub}{Hub} event mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \item[{\em params}]message parameter Map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]non-zero value if a \hyperlink{structHub}{Hub} event was processed \end{Desc} + + +References HUB\_\-SHUTDOWN, samp\_\-addClient(), samp\_\-hubEvent(), samp\_\-mutex, samp\_\-P2H(), samp\_\-removeClient(), sampH, and sampShutdown().\hypertarget{sampDecl_8h_59f85e0fce4c9ae7121c98e137d3f743}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-receiveCall@{samp\_\-receiveCall}} +\index{samp\_\-receiveCall@{samp\_\-receiveCall}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-receiveCall}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-receiveCall (void $\ast$ {\em data})}} +\label{sampDecl_8h_59f85e0fce4c9ae7121c98e137d3f743} + + +test.echo method + +receiveCall () client method. + +SAMP\_\-TESTECHO -- test.echo method + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno\end{Desc} +SAMP\_\-RECEIVECALL -- receiveCall() client method. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno \end{Desc} + + +References Samp::defaultUserFunc, OK\_\-Map, samp\_\-execUserHandler(), samp\_\-getHandlerReply(), samp\_\-getSampHandler(), samp\_\-getUserHandler(), samp\_\-Reply(), sampH, and Samp::trace.\hypertarget{sampDecl_8h_03be7cc9e154a6ccdd499286df640936}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-receiveNotification@{samp\_\-receiveNotification}} +\index{samp\_\-receiveNotification@{samp\_\-receiveNotification}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-receiveNotification}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-receiveNotification (void $\ast$ {\em data})}} +\label{sampDecl_8h_03be7cc9e154a6ccdd499286df640936} + + +receiveNotification () client method. + +SAMP\_\-RECEIVENOTIFICATION -- receiveNotification() client method. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno \end{Desc} + + +References Samp::defaultUserFunc, OK\_\-Map, samp\_\-execUserHandler(), samp\_\-getHandlerReply(), samp\_\-getSampHandler(), samp\_\-getUserHandler(), samp\_\-processHubEvent(), and Samp::trace.\hypertarget{sampDecl_8h_754b50ad59145c7fd1e4c8f4277f11e4}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-receiveResponse@{samp\_\-receiveResponse}} +\index{samp\_\-receiveResponse@{samp\_\-receiveResponse}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-receiveResponse}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-receiveResponse (void $\ast$ {\em data})}} +\label{sampDecl_8h_754b50ad59145c7fd1e4c8f4277f11e4} + + +receiveResponse () client method. + +SAMP\_\-RECEIVERESPONSE -- receiveResponse() client method. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno \end{Desc} + + +References Samp::defaultUserFunc, OK\_\-Map, samp\_\-execUserHandler(), and Samp::trace.\hypertarget{sampDecl_8h_84ffd50bd4b8dc79e9cf32398c6b3d69}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-Register@{samp\_\-Register}} +\index{samp\_\-Register@{samp\_\-Register}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-Register}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-Register (handle\_\-t {\em handle})}} +\label{sampDecl_8h_84ffd50bd4b8dc79e9cf32398c6b3d69} + + +Register with the \hyperlink{structHub}{Hub} using the currently stored metadata. + +SAMP\_\-REGISTER -- Register with the \hyperlink{structHub}{Hub} using the currently stored metadata. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, Hub::hubId, Hub::id, Hub::privateKey, samp\_\-replyStatus(), Hub::secret, and Hub::selfId.\hypertarget{sampDecl_8h_e30e492f306a40f853a454faf60ab479}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-removeClient@{samp\_\-removeClient}} +\index{samp\_\-removeClient@{samp\_\-removeClient}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-removeClient}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-removeClient (handle\_\-t {\em handle}, \/ {\bf String} {\em id})}} +\label{sampDecl_8h_e30e492f306a40f853a454faf60ab479} + + +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().\hypertarget{sampDecl_8h_9c6ff3d76997c3d7301a977309a117e0}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-Reply@{samp\_\-Reply}} +\index{samp\_\-Reply@{samp\_\-Reply}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-Reply}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-Reply (handle\_\-t {\em handle}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em response})}} +\label{sampDecl_8h_9c6ff3d76997c3d7301a977309a117e0} + + +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. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em msg\_\-id}]message ID \item[{\em response}]response map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, Hub::id, Hub::privateKey, and samp\_\-nullResponse().\hypertarget{sampDecl_8h_d47754f3b9fceff4d3019821519432b4}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-replyStatus@{samp\_\-replyStatus}} +\index{samp\_\-replyStatus@{samp\_\-replyStatus}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-replyStatus}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-replyStatus (handle\_\-t {\em handle})}} +\label{sampDecl_8h_d47754f3b9fceff4d3019821519432b4} + + +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 + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em samp}]samp struct ptr \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]message status \end{Desc} + + +Referenced by samp\_\-Register().\hypertarget{sampDecl_8h_287569451dc1bf59d1f9f6d13b56716d}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-resConeHandler@{samp\_\-resConeHandler}} +\index{samp\_\-resConeHandler@{samp\_\-resConeHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-resConeHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resConeHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_287569451dc1bf59d1f9f6d13b56716d} + + +handle a voresource.loadlist message + +SAMP\_\-RESCONEHANDLER -- Handle a voresource.loadlist.cone message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_c0bf7cf7fea362c0c82ad7bc3f267c48}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-resLoadHandler@{samp\_\-resLoadHandler}} +\index{samp\_\-resLoadHandler@{samp\_\-resLoadHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-resLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_c0bf7cf7fea362c0c82ad7bc3f267c48} + + +handle a voresource.loadlist message + +SAMP\_\-RESLOADHANDLER -- handle a voresource.loadlist.$\ast$ message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_8013c549ef47e0507edf39c8ab1b62aa}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-resourceLoad@{samp\_\-resourceLoad}} +\index{samp\_\-resourceLoad@{samp\_\-resourceLoad}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-resourceLoad}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resourceLoad (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em type}, \/ {\bf String} {\em name}, \/ {\bf Map} {\em resMap})}} +\label{sampDecl_8h_8013c549ef47e0507edf39c8ab1b62aa} + + +Exchange a resource list. + +SAMP\_\-RESOURCELOAD -- Exchange a resource list. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Name of recipient (or 'all') \item[{\em type}]Resource type (or NULL) \item[{\em name}]Descriptive name (optional) \item[{\em resMap}]Resource map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addMapParam(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), samp\_\-sendMsg(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_8b2300222d7b11f144eb4385412e69a5}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-resSiapHandler@{samp\_\-resSiapHandler}} +\index{samp\_\-resSiapHandler@{samp\_\-resSiapHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-resSiapHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resSiapHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_8b2300222d7b11f144eb4385412e69a5} + + +handle a voresource.loadlist message + +SAMP\_\-RESSIAPHANDLER -- Handle a voresource.loadlist.siap message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_866578a01c3b762435823b1b11869c42}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-resSsapHandler@{samp\_\-resSsapHandler}} +\index{samp\_\-resSsapHandler@{samp\_\-resSsapHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-resSsapHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resSsapHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_866578a01c3b762435823b1b11869c42} + + +handle a voresource.loadlist message + +SAMP\_\-RESSSAPHANDLER -- Handle a voresource.loadlist.ssap message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_ad42ca17cbaf23012ad497559ea45e4c}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-resTapHandler@{samp\_\-resTapHandler}} +\index{samp\_\-resTapHandler@{samp\_\-resTapHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-resTapHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resTapHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_ad42ca17cbaf23012ad497559ea45e4c} + + +handle a voresource.loadlist message + +SAMP\_\-RESTAPHANDLER -- Handle a voresource.loadlist.tap message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_fa207ebdc587ba5eeab60fbf79b635d4}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-resVOSpaceHandler@{samp\_\-resVOSpaceHandler}} +\index{samp\_\-resVOSpaceHandler@{samp\_\-resVOSpaceHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-resVOSpaceHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resVOSpaceHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_fa207ebdc587ba5eeab60fbf79b635d4} + + +handle a voresource.loadlist message + +SAMP\_\-RESVOSPACEHANDLER -- Handle a voresource.loadlist.vospace message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_b2ff2e029c57b56ad57416c624341fe6}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-sendGeneric@{samp\_\-sendGeneric}} +\index{samp\_\-sendGeneric@{samp\_\-sendGeneric}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-sendGeneric}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-sendGeneric (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em args}\mbox{[}$\,$\mbox{]})}} +\label{sampDecl_8h_b2ff2e029c57b56ad57416c624341fe6} + + +Send a geenric message. + +SAMP\_\-SENDGENERIC -- Send a generic message. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Name of recipient (or 'all') \item[{\em mtype}]Message type \item[{\em args}]Argument list \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR\end{Desc} +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.\hypertarget{sampDecl_8h_80ef1a82845b96091857c7d4a3c7972c}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-sendMsg@{samp\_\-sendMsg}} +\index{samp\_\-sendMsg@{samp\_\-sendMsg}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-sendMsg}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-sendMsg (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf Map} {\em msg})}} +\label{sampDecl_8h_80ef1a82845b96091857c7d4a3c7972c} + + +Send the specified message. + +SAMP\_\-SENDMSG -- Send the specified message. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Name of recipient (or 'all') \item[{\em msg}]Message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::clients, Samp::msgMode, Samp::nclients, samp\_\-app2id(), samp\_\-call(), samp\_\-callAll(), samp\_\-callAndWait(), samp\_\-notify(), samp\_\-notifyAll(), and samp\_\-setErr().\hypertarget{sampDecl_8h_0af6dba3d1022e6b220a9b1076021353}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-serverPort@{samp\_\-serverPort}} +\index{samp\_\-serverPort@{samp\_\-serverPort}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-serverPort}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-serverPort (void)}} +\label{sampDecl_8h_0af6dba3d1022e6b220a9b1076021353} + + +Return a unique port number for the server. + +SAMP\_\-SERVERPORT -- Return a unique port number for the server. + +\begin{Desc} +\item[Returns:]port number \end{Desc} +\hypertarget{sampDecl_8h_8fbfdc550ede5d52840300ab33639c49}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setAppVersion@{samp\_\-setAppVersion}} +\index{samp\_\-setAppVersion@{samp\_\-setAppVersion}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setAppVersion}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setAppVersion (handle\_\-t {\em handle}, \/ {\bf String} {\em version})}} +\label{sampDecl_8h_8fbfdc550ede5d52840300ab33639c49} + + +Set the application name string. + +Set the application version string. + +SAMP\_\-SETAPPNAME -- Set the application name string. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em name}]application name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing\end{Desc} +SAMP\_\-SETAPPVERSION -- Set the application version string. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em name}]application version \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Hub::appVer, Samp::appVer, and Samp::hub.\hypertarget{sampDecl_8h_a9aef12dd82bfd38a2382a4ac88c54af}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setASyncMode@{samp\_\-setASyncMode}} +\index{samp\_\-setASyncMode@{samp\_\-setASyncMode}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setASyncMode}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setASyncMode (handle\_\-t {\em handle})}} +\label{sampDecl_8h_a9aef12dd82bfd38a2382a4ac88c54af} + + +Set the calling mode to use asynchronous messaging. + +SAMP\_\-SETASYNCMODE -- Set the calling mode to use asynchronous messaging. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{sampDecl_8h_d4c1514e94c9ef511cfcd27004c38c4d}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setCallByRef@{samp\_\-setCallByRef}} +\index{samp\_\-setCallByRef@{samp\_\-setCallByRef}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setCallByRef}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setCallByRef (handle\_\-t {\em handle})}} +\label{sampDecl_8h_d4c1514e94c9ef511cfcd27004c38c4d} + + +Have interface call user handlers by reference. + +SAMP\_\-SETCALLBYREF -- Have interface call user handlers by reference. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::handlerMode.\hypertarget{sampDecl_8h_fc27715ec9a5cb60cf0b5415eb7f9a48}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setCallMode@{samp\_\-setCallMode}} +\index{samp\_\-setCallMode@{samp\_\-setCallMode}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setCallMode}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setCallMode (handle\_\-t {\em handle}, \/ int {\em mode})}} +\label{sampDecl_8h_fc27715ec9a5cb60cf0b5415eb7f9a48} + + +Set the default calling mode (synch or asynch). + +SAMP\_\-SETCALLMODE -- Set the default calling mode (synch or asynch) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em mode}]call mode (synch or asynch) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{sampDecl_8h_91aeabe77e920fc1924b1cdc4f088e64}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setErr@{samp\_\-setErr}} +\index{samp\_\-setErr@{samp\_\-setErr}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setErr}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-setErr (handle\_\-t {\em handle}, \/ {\bf Map} {\em resp})}} +\label{sampDecl_8h_91aeabe77e920fc1924b1cdc4f088e64} + + +Set the error response string. + +SAMP\_\-SETERR -- Set the error response string/code. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em resp}]Response map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::errortxt.\hypertarget{sampDecl_8h_041a551aff57ca03f3ff72a9803e2b58}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setFloatInList@{samp\_\-setFloatInList}} +\index{samp\_\-setFloatInList@{samp\_\-setFloatInList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setFloatInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setFloatInList ({\bf List} {\em list}, \/ float {\em rval})}} +\label{sampDecl_8h_041a551aff57ca03f3ff72a9803e2b58} + + +Set a Float in a List (append). + +SAMP\_\-SETFLOATINLIST -- Set a Float in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list1}]List object handle \item[{\em rval}]Float value to be appended \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_0f07ae542f5b317311b3799bd96a88fd}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setFloatInMap@{samp\_\-setFloatInMap}} +\index{samp\_\-setFloatInMap@{samp\_\-setFloatInMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setFloatInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setFloatInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ float {\em value})}} +\label{sampDecl_8h_0f07ae542f5b317311b3799bd96a88fd} + + +Set a string in a Map (append). + +SAMP\_\-SETFLOATINMAP -- Set a Float in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em value}]value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_2d8a8a26d7284bb211a933895cddd29c}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setIntInList@{samp\_\-setIntInList}} +\index{samp\_\-setIntInList@{samp\_\-setIntInList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setIntInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setIntInList ({\bf List} {\em list}, \/ int {\em ival})}} +\label{sampDecl_8h_2d8a8a26d7284bb211a933895cddd29c} + + +Set an Int in a List (append). + +SAMP\_\-SETINTINLIST -- Set an Int in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list1}]List object handle \item[{\em ival}]Integer value to be appended \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_c22ec42dbf9a01c9b4e00cf011e7eb9d}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setIntInMap@{samp\_\-setIntInMap}} +\index{samp\_\-setIntInMap@{samp\_\-setIntInMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setIntInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setIntInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ int {\em value})}} +\label{sampDecl_8h_c22ec42dbf9a01c9b4e00cf011e7eb9d} + + +Set a Int in a Map (append). + +SAMP\_\-SETINTINMAP -- Set a Int in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em value}]value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_0ff97d44e62b7c88a046a29324552400}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setListInList@{samp\_\-setListInList}} +\index{samp\_\-setListInList@{samp\_\-setListInList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setListInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setListInList ({\bf List} {\em list1}, \/ {\bf List} {\em list2})}} +\label{sampDecl_8h_0ff97d44e62b7c88a046a29324552400} + + +Set a List in another List (append). + +SAMP\_\-SETLISTINLIST -- Set a List in another List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list1}]List object handle \item[{\em list2}]List to be appended \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_362c2f670c98dd6a3ef69debd1871604}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setListInMap@{samp\_\-setListInMap}} +\index{samp\_\-setListInMap@{samp\_\-setListInMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setListInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setListInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ {\bf List} {\em list})}} +\label{sampDecl_8h_362c2f670c98dd6a3ef69debd1871604} + + +Set a List in a Map (append). + +SAMP\_\-SETLISTINMAP -- Set a List in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em list}]handle to List object to set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_ea188bb711f3b5549d11204b0ff2da08}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setMapInList@{samp\_\-setMapInList}} +\index{samp\_\-setMapInList@{samp\_\-setMapInList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setMapInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setMapInList ({\bf List} {\em list}, \/ {\bf Map} {\em map})}} +\label{sampDecl_8h_ea188bb711f3b5549d11204b0ff2da08} + + +Set a Map in a List (append). + +SAMP\_\-SETMAPINLIST -- Set a Map in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em map}]Map object to be set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_f102490efe1b92d99b67f244dc498c7b}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setMapInMap@{samp\_\-setMapInMap}} +\index{samp\_\-setMapInMap@{samp\_\-setMapInMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setMapInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setMapInMap ({\bf Map} {\em map1}, \/ char $\ast$ {\em key}, \/ {\bf Map} {\em map2})}} +\label{sampDecl_8h_f102490efe1b92d99b67f244dc498c7b} + + +Set a Map in a Map (append). + +SAMP\_\-SETMAPINMAP -- Set a Map in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map1}]handle to Map object \item[{\em key}]Map key \item[{\em map2}]handle to Map object to set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_9056a8601300892f918835259c7fdb3b}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setNotifyMode@{samp\_\-setNotifyMode}} +\index{samp\_\-setNotifyMode@{samp\_\-setNotifyMode}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setNotifyMode}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setNotifyMode (handle\_\-t {\em handle})}} +\label{sampDecl_8h_9056a8601300892f918835259c7fdb3b} + + +Set the calling mode to use notification messaging. + +SAMP\_\-SETNOTIFYMODE -- Set the calling mode to use notification messaging. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{sampDecl_8h_a3c0bdb4c512357dbc53b0ad7a7d5b01}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setReplyCallback@{samp\_\-setReplyCallback}} +\index{samp\_\-setReplyCallback@{samp\_\-setReplyCallback}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setReplyCallback}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setReplyCallback (handle\_\-t {\em handle}, \/ int $\ast$ {\em func})}} +\label{sampDecl_8h_a3c0bdb4c512357dbc53b0ad7a7d5b01} + + +Set the Reply callback. samp\_\-setReplyCallback (handle\_\-t handle, int $\ast$func). + +SAMP\_\-SETREPLYCALLBACK -- Set the Reply callback. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em func}]callback for Reply message \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_3db66f28546459327665f8491ea97f4d}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setResponseCallback@{samp\_\-setResponseCallback}} +\index{samp\_\-setResponseCallback@{samp\_\-setResponseCallback}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setResponseCallback}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setResponseCallback (handle\_\-t {\em handle}, \/ int $\ast$ {\em func})}} +\label{sampDecl_8h_3db66f28546459327665f8491ea97f4d} + + +Set the Response callback. samp\_\-setResponseCallback (handle\_\-t handle, int $\ast$func). + +SAMP\_\-SETRESPONSECALLBACK -- Set the Response callback. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em func}]callback for message response \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_2e8ec01a0dd96314622ae313206583db}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setSampHandler@{samp\_\-setSampHandler}} +\index{samp\_\-setSampHandler@{samp\_\-setSampHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setSampHandler}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setSampHandler (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype}, \/ void $\ast$ {\em func})}} +\label{sampDecl_8h_2e8ec01a0dd96314622ae313206583db} + + +Set the SAMP interface handler for the mtype. + +SAMP\_\-SETSAMPHANDLER -- Set the SAMP interface handler for the mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \item[{\em func}]callback function \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::nsubs, and Subs::sampFunc.\hypertarget{sampDecl_8h_5b69180b036e58528c98b1cf5a42825a}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setStringInList@{samp\_\-setStringInList}} +\index{samp\_\-setStringInList@{samp\_\-setStringInList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setStringInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setStringInList ({\bf List} {\em list}, \/ char $\ast$ {\em value})}} +\label{sampDecl_8h_5b69180b036e58528c98b1cf5a42825a} + + +Set a string in a List (append). + +SAMP\_\-SETSTRINGINLIST -- Set a string in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em value}]string value to set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_b9b2157de89369eb5cd95bfe804eb89a}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setStringInMap@{samp\_\-setStringInMap}} +\index{samp\_\-setStringInMap@{samp\_\-setStringInMap}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setStringInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setStringInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ char $\ast$ {\em value})}} +\label{sampDecl_8h_b9b2157de89369eb5cd95bfe804eb89a} + + +Set a string in a Map (append). + +SAMP\_\-SETSTRINGINMAP -- Set a string in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em value}]Map value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampDecl_8h_1d00dc78292cfbc01262ef65ab055063}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setSyncMode@{samp\_\-setSyncMode}} +\index{samp\_\-setSyncMode@{samp\_\-setSyncMode}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setSyncMode}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setSyncMode (handle\_\-t {\em handle})}} +\label{sampDecl_8h_1d00dc78292cfbc01262ef65ab055063} + + +Set the calling mode to use synchronous messaging. + +SAMP\_\-SETSYNCMODE -- Set the calling mode to use synchronous messaging. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{sampDecl_8h_e11a97c262ab5ab4438eca6c60c0d8cf}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setTimeout@{samp\_\-setTimeout}} +\index{samp\_\-setTimeout@{samp\_\-setTimeout}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setTimeout}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setTimeout (handle\_\-t {\em handle}, \/ int {\em timeout})}} +\label{sampDecl_8h_e11a97c262ab5ab4438eca6c60c0d8cf} + + +Set the message timeout value (in seconds). + +SAMP\_\-SETTIMEOUT -- Set the message timeout value (in seconds). + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em name}]application name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::hub, and Hub::timeout.\hypertarget{sampDecl_8h_81222e1f3572585fa30f11a78aa08c3f}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-setUserHandler@{samp\_\-setUserHandler}} +\index{samp\_\-setUserHandler@{samp\_\-setUserHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-setUserHandler}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setUserHandler (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype}, \/ void $\ast$ {\em func})}} +\label{sampDecl_8h_81222e1f3572585fa30f11a78aa08c3f} + + +Set the user-interface handler for the mtype. + +SAMP\_\-SETUSERHANDLER -- Set the user-interface handler for the mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \item[{\em func}]callback function \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::defaultUserFunc, Samp::nsubs, and Subs::userFunc.\hypertarget{sampDecl_8h_bc319b97b3dbea29bd79c4f723db5438}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-specLoadHandler@{samp\_\-specLoadHandler}} +\index{samp\_\-specLoadHandler@{samp\_\-specLoadHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-specLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-specLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_bc319b97b3dbea29bd79c4f723db5438} + + +Handle a spectrum.load.$\ast$ message. + +SAMP\_\-SPECLOADHANDLER -- Handle a spectrum.load.$\ast$ message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_18b351385bd175581a6788a4f7342f07}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-specLoadSSAGeneric@{samp\_\-specLoadSSAGeneric}} +\index{samp\_\-specLoadSSAGeneric@{samp\_\-specLoadSSAGeneric}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-specLoadSSAGeneric}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-specLoadSSAGeneric (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf Map} {\em meta}, \/ {\bf String} {\em spectrumId}, \/ {\bf String} {\em name})}} +\label{sampDecl_8h_18b351385bd175581a6788a4f7342f07} + + +Load a generic spectrum from an SSA service. + +SAMP\_\-SPECLOADSSAGENERIC -- Load a generic spectrum from an SSA service. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em url}]URL of spectrum to load \item[{\em meta}]Metadata map describing data found at the URL \item[{\em spectrumId}]Identifier for spectrum (optional) \item[{\em name}]Name used to label spectrum (optional); \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addMapParam(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_dd2bca8fa3bf3b4ebbf449edc6b65d85}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-specSSAHandler@{samp\_\-specSSAHandler}} +\index{samp\_\-specSSAHandler@{samp\_\-specSSAHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-specSSAHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-specSSAHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_dd2bca8fa3bf3b4ebbf449edc6b65d85} + + +Handle a spectrum.load.ssa-generic message. + +SAMP\_\-SPECSSAHANDLER -- Handle a spectrum.load.ssa-generic message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-specLoadHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_2e342b672e77e012cc98a6f5506a44be}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-StatusHandler@{samp\_\-StatusHandler}} +\index{samp\_\-StatusHandler@{samp\_\-StatusHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-StatusHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-StatusHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_2e342b672e77e012cc98a6f5506a44be} + + +Return status of the task. + +SAMP\_\-STATUSHANDLER -- Return status of the task. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, and samp\_\-getUserHandler().\hypertarget{sampDecl_8h_c6b76655d73825acdacfac8b5a1139ee}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-Subscribe@{samp\_\-Subscribe}} +\index{samp\_\-Subscribe@{samp\_\-Subscribe}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-Subscribe}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-Subscribe (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype}, \/ void $\ast$ {\em userFunc})}} +\label{sampDecl_8h_c6b76655d73825acdacfac8b5a1139ee} + + +Subscribe to a given mtype. + +SAMP\_\-SUBSCRIBE -- Subscribe to a given mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \item[{\em func}]callback function \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::nsubs, samp\_\-getSampHandler(), samp\_\-setSampHandler(), and samp\_\-setUserHandler().\hypertarget{sampDecl_8h_e38ac987f1dfd87ad64f97d55396270e}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-tableHighlightRow@{samp\_\-tableHighlightRow}} +\index{samp\_\-tableHighlightRow@{samp\_\-tableHighlightRow}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-tableHighlightRow}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tableHighlightRow (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em url}, \/ int {\em row})}} +\label{sampDecl_8h_e38ac987f1dfd87ad64f97d55396270e} + + +Tell an app to highlight a table row. + +SAMP\_\-TABLEHIGHLIGHTROW -- Tell an app to highlight a table row. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em tableId}]ID associated with a previously loaded table \item[{\em url}]URL to table to be loaded \item[{\em rows}]List of (zero-based) row indices \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addIntParam(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_74aeaaf742121348390ec854c30c1479}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-tableLoadFITS@{samp\_\-tableLoadFITS}} +\index{samp\_\-tableLoadFITS@{samp\_\-tableLoadFITS}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-tableLoadFITS}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tableLoadFITS (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em name})}} +\label{sampDecl_8h_74aeaaf742121348390ec854c30c1479} + + +Tell an app to load a FITS table. + +SAMP\_\-TABLELOADFITS -- Tell an app to load a FITS table. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em url}]URL to table to be loaded \item[{\em tableId}]ID assigned to table (optional) \item[{\em name}]Name assigned to table (optional) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_34e9d38073f36daaf41c418f8d680ee5}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-tableLoadVOTable@{samp\_\-tableLoadVOTable}} +\index{samp\_\-tableLoadVOTable@{samp\_\-tableLoadVOTable}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-tableLoadVOTable}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tableLoadVOTable (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em name})}} +\label{sampDecl_8h_34e9d38073f36daaf41c418f8d680ee5} + + +Tell an app to load a VOTable. + +SAMP\_\-TABLELOADVOTABLE -- Tell an app to load a VOTable. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em url}]URL to table to be loaded \item[{\em tableId}]ID assigned to table (optional) \item[{\em name}]Name assigned to table (optional) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampDecl_8h_f133efb67fe4bcfd2b9c8ab9d23b4c5e}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-tableSelectRowList@{samp\_\-tableSelectRowList}} +\index{samp\_\-tableSelectRowList@{samp\_\-tableSelectRowList}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-tableSelectRowList}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tableSelectRowList (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em url}, \/ int {\em rows}\mbox{[}$\,$\mbox{]}, \/ int {\em nrows})}} +\label{sampDecl_8h_f133efb67fe4bcfd2b9c8ab9d23b4c5e} + + +Tell an app to select a list of table rows. + +SAMP\_\-TABLESELECTROWLIST -- Tell an app to select a list of table rows. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em tableId}]ID associated with a previously loaded table \item[{\em url}]URL to table to be loaded \item[{\em rows}]Array of (zero-based) row indices \item[{\em nrows}]Number of rows \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addListParam(), samp\_\-freeList(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newList(), samp\_\-newMsg(), samp\_\-newParam(), samp\_\-sendMsg(), and samp\_\-setIntInList().\hypertarget{sampDecl_8h_d9184eb45a5bc93b5205fd5b1c6ef688}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-tbHighlightHandler@{samp\_\-tbHighlightHandler}} +\index{samp\_\-tbHighlightHandler@{samp\_\-tbHighlightHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-tbHighlightHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbHighlightHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_d9184eb45a5bc93b5205fd5b1c6ef688} + + +Handle a table.highlight.row message. + +SAMP\_\-TBHIGHLIGHTHANDLER -- Handle a table.highlight.row message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getIntFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_750c0fee0c7a99e135299c08751f288c}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-tbLoadFITSHandler@{samp\_\-tbLoadFITSHandler}} +\index{samp\_\-tbLoadFITSHandler@{samp\_\-tbLoadFITSHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-tbLoadFITSHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbLoadFITSHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_750c0fee0c7a99e135299c08751f288c} + + +Handle a generic table.load.fits message. + +SAMP\_\-TBLOADFITSHANDLER -- Handle a generic table.load.fits message $\ast$\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-tbLoadHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_26f96dc6cbf72283e2ee9cb8b4619ed3}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-tbLoadHandler@{samp\_\-tbLoadHandler}} +\index{samp\_\-tbLoadHandler@{samp\_\-tbLoadHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-tbLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_26f96dc6cbf72283e2ee9cb8b4619ed3} + + +Handle a generic table.load.$\ast$ message. + +SAMP\_\-TBLOADHANDLER -- Handle a generic table.load.$\ast$ message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_144ec2329355d91022d5ea38736c0093}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-tbLoadVOTHandler@{samp\_\-tbLoadVOTHandler}} +\index{samp\_\-tbLoadVOTHandler@{samp\_\-tbLoadVOTHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-tbLoadVOTHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbLoadVOTHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_144ec2329355d91022d5ea38736c0093} + + +Handle a generic table.load.votable message. + +SAMP\_\-TBLOADVOTHANDLER -- Handle a generic table.load.votable message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-tbLoadHandler(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_98d68d7091c0b7790631bb53e0ace656}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-tbSelectHandler@{samp\_\-tbSelectHandler}} +\index{samp\_\-tbSelectHandler@{samp\_\-tbSelectHandler}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-tbSelectHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbSelectHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampDecl_8h_98d68d7091c0b7790631bb53e0ace656} + + +Handle a table.select.rowList message. + +SAMP\_\-TBSELECTHANDLER -- Handle a table.select.rowList message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getListFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-listLen(), and SZ\_\-NAME.\hypertarget{sampDecl_8h_106fc27544de7c25625ed60eb48e4edd}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-UnRegister@{samp\_\-UnRegister}} +\index{samp\_\-UnRegister@{samp\_\-UnRegister}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-UnRegister}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-UnRegister (handle\_\-t {\em handle})}} +\label{sampDecl_8h_106fc27544de7c25625ed60eb48e4edd} + + +Un-Register from the hub. + +SAMP\_\-UNREGISTER -- Un-Register from the hub. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, and samp\_\-hubUnRegister().\hypertarget{sampDecl_8h_b3fded97bbbf3751c4916543959f16a5}{ +\index{sampDecl.h@{sampDecl.h}!samp\_\-Unsubscribe@{samp\_\-Unsubscribe}} +\index{samp\_\-Unsubscribe@{samp\_\-Unsubscribe}!sampDecl.h@{sampDecl.h}} +\subsubsection[{samp\_\-Unsubscribe}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-Unsubscribe (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype})}} +\label{sampDecl_8h_b3fded97bbbf3751c4916543959f16a5} + + +Unsubscribe to a given mtype. + +SAMP\_\-UNSUBSCRIBE -- Unsubscribe to a given mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::nsubs, samp\_\-DeclareSubscriptions(), Subs::sampFunc, and Subs::userFunc.\hypertarget{sampDecl_8h_123413db26ad50a84bd41863af5deae5}{ +\index{sampDecl.h@{sampDecl.h}!sampClose@{sampClose}} +\index{sampClose@{sampClose}!sampDecl.h@{sampDecl.h}} +\subsubsection[{sampClose}]{\setlength{\rightskip}{0pt plus 5cm}void sampClose (handle\_\-t {\em handle})}} +\label{sampDecl_8h_123413db26ad50a84bd41863af5deae5} + + +Close the SAMP interface and free resources. + +SAMP\_\-CLOSE -- Close the SAMP interface. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::hub, Samp::hubHandle, samp\_\-freeHandle(), samp\_\-hubClose(), sampTrace(), and Samp::verbose.\hypertarget{sampDecl_8h_30f39c72c3783055faa82ad3860f3d1d}{ +\index{sampDecl.h@{sampDecl.h}!sampInit@{sampInit}} +\index{sampInit@{sampInit}!sampDecl.h@{sampDecl.h}} +\subsubsection[{sampInit}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t sampInit ({\bf String} {\em appName}, \/ {\bf String} {\em description})}} +\label{sampDecl_8h_30f39c72c3783055faa82ad3860f3d1d} + + +Initialize the SAMP interface. + +Prototype declarations. + +SAMP\_\-INIT -- Initialize the SAMP interface. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em appName}]application name \item[{\em description}]description of application \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]samp handle \end{Desc} + + +References nullList, nullMap, OK\_\-Map, samp\_\-hubOpen(), samp\_\-newHandle(), samp\_\-newList(), samp\_\-newMap(), samp\_\-serverPort(), samp\_\-setMapInMap(), samp\_\-setStringInMap(), sampH, and sampTrace().\hypertarget{sampDecl_8h_4919f892b6fccced4e6b9d777071b781}{ +\index{sampDecl.h@{sampDecl.h}!sampLog@{sampLog}} +\index{sampLog@{sampLog}!sampDecl.h@{sampDecl.h}} +\subsubsection[{sampLog}]{\setlength{\rightskip}{0pt plus 5cm}void sampLog (handle\_\-t {\em handle}, \/ char $\ast$ {\em format}, \/ {\em ...})}} +\label{sampDecl_8h_4919f892b6fccced4e6b9d777071b781} + + +SAMP message logger. + +SAMPLOG -- SAMP message logger. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]SAMP handle \item[{\em format}]message format string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::debug, and Samp::logfd.\hypertarget{sampDecl_8h_65908d088c8b917d10db38c147590ad9}{ +\index{sampDecl.h@{sampDecl.h}!sampShutdown@{sampShutdown}} +\index{sampShutdown@{sampShutdown}!sampDecl.h@{sampDecl.h}} +\subsubsection[{sampShutdown}]{\setlength{\rightskip}{0pt plus 5cm}int sampShutdown (handle\_\-t {\em handle})}} +\label{sampDecl_8h_65908d088c8b917d10db38c147590ad9} + + +Shut down the active SAMP interface. + +SAMP\_\-SHUTDOWN -- Shut down the active SAMP interface. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::active, Samp::hubHandle, samp\_\-hubClose(), Samp::svrThread, and Samp::verbose. + +Referenced by samp\_\-processHubEvent().\hypertarget{sampDecl_8h_8e18ae12df031094ace47863f93b3634}{ +\index{sampDecl.h@{sampDecl.h}!sampStartup@{sampStartup}} +\index{sampStartup@{sampStartup}!sampDecl.h@{sampDecl.h}} +\subsubsection[{sampStartup}]{\setlength{\rightskip}{0pt plus 5cm}int sampStartup (handle\_\-t {\em handle})}} +\label{sampDecl_8h_8e18ae12df031094ace47863f93b3634} + + +Startup the SAMP interface to send/receive messages. + +SAMP\_\-STARTUP -- Startup the SAMP interface to send/receive messages. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +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.\hypertarget{sampDecl_8h_2b3dd1662e61c83e29109126689b08b9}{ +\index{sampDecl.h@{sampDecl.h}!sampTrace@{sampTrace}} +\index{sampTrace@{sampTrace}!sampDecl.h@{sampDecl.h}} +\subsubsection[{sampTrace}]{\setlength{\rightskip}{0pt plus 5cm}void sampTrace (handle\_\-t {\em handle}, \/ char $\ast$ {\em format}, \/ {\em ...})}} +\label{sampDecl_8h_2b3dd1662e61c83e29109126689b08b9} + + +SAMP tracer. + +SAMPTRACE -- SAMP tracer. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]SAMP handle \item[{\em format}]message format string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::trace.
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampHandlers_8c.tex b/vendor/voclient/libsamp/doc/latex/sampHandlers_8c.tex new file mode 100644 index 00000000..0f6f564a --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampHandlers_8c.tex @@ -0,0 +1,785 @@ +\hypertarget{sampHandlers_8c}{ +\section{sampHandlers.c File Reference} +\label{sampHandlers_8c}\index{sampHandlers.c@{sampHandlers.c}} +} +Message handlers for the interface. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include $<$time.h$>$}\par +{\tt \#include $<$ctype.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Defines} +\begin{CompactItemize} +\item +\hypertarget{sampHandlers_8c_ee07de873e18503ecd72f89d07e4c628}{ +\#define \textbf{METH\_\-DBG}~(getenv(\char`\"{}METH\_\-DBG\char`\"{})!=NULL$|$$|$access(\char`\"{}/tmp/METH\_\-DBG\char`\"{},F\_\-OK)==0)} +\label{sampHandlers_8c_ee07de873e18503ecd72f89d07e4c628} + +\item +\hypertarget{sampHandlers_8c_ae51f9fc173a9cba2485f91d93fe8428}{ +\#define \textbf{OK\_\-Map}~samp\_\-getOKMap()} +\label{sampHandlers_8c_ae51f9fc173a9cba2485f91d93fe8428} + +\item +\hypertarget{sampHandlers_8c_0a7803909f0c4188761ec0a533eab82e}{ +\#define \textbf{MATCH}(s)~(func\&\&strncasecmp(mtype,s,min(len,16))==0)} +\label{sampHandlers_8c_0a7803909f0c4188761ec0a533eab82e} + +\item +\hypertarget{sampHandlers_8c_f6e89a3c178ea921d5340ce296c817cf}{ +\#define \textbf{PMATCH}(s)~(strcasecmp(mtype,s)==0)} +\label{sampHandlers_8c_f6e89a3c178ea921d5340ce296c817cf} + +\item +\hypertarget{sampHandlers_8c_d98187ef66ebe7e9334652739715250d}{ +\#define \textbf{POPT}(s)~(s\mbox{[}0\mbox{]}?s:\char`\"{}INDEF\char`\"{})} +\label{sampHandlers_8c_d98187ef66ebe7e9334652739715250d} + +\end{CompactItemize} +\subsection*{Functions} +\begin{CompactItemize} +\item +void \hyperlink{sampHandlers_8c_81222e1f3572585fa30f11a78aa08c3f}{samp\_\-setUserHandler} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, void $\ast$func) +\begin{CompactList}\small\item\em Set the user-interface handler for the mtype. \item\end{CompactList}\item +void \hyperlink{sampHandlers_8c_2e8ec01a0dd96314622ae313206583db}{samp\_\-setSampHandler} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, void $\ast$func) +\begin{CompactList}\small\item\em Set the SAMP interface handler for the mtype. \item\end{CompactList}\item +void $\ast$ \hyperlink{sampHandlers_8c_6bb258d378627da1aa0254fccdb6bd2c}{samp\_\-getUserHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Get the User handler for the named mtype. \item\end{CompactList}\item +void $\ast$ \hyperlink{sampHandlers_8c_6ef18dbc5870f58d2161c9ba03a81d26}{samp\_\-getSampHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Get the Samphandler for the named mtype. \item\end{CompactList}\item +void \hyperlink{sampHandlers_8c_23644999b70eebfe75f52c465d1ed97f}{samp\_\-execUserHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} params) +\begin{CompactList}\small\item\em Execute the user-defined handler for the mtype. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_bea5fa0cd958545710afcf3c5da9dc15}{samp\_\-hubHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle \hyperlink{structHub}{Hub} event messages. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_16d8b8822d169107b8702ae753797923}{samp\_\-PingHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Is app alive and responding to messages? \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_2e342b672e77e012cc98a6f5506a44be}{samp\_\-StatusHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Return status of the task. \item\end{CompactList}\item +\hypertarget{sampHandlers_8c_1b7812ba89eebe15ad24f36a3d439a0a}{ +int \textbf{samp\_\-genericMsgHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map)} +\label{sampHandlers_8c_1b7812ba89eebe15ad24f36a3d439a0a} + +\item +int \hyperlink{sampHandlers_8c_9bd8036dd65dc4f874f39568b691a123}{samp\_\-imLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle an image.load.fits message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_26f96dc6cbf72283e2ee9cb8b4619ed3}{samp\_\-tbLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a generic table.load.$\ast$ message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_750c0fee0c7a99e135299c08751f288c}{samp\_\-tbLoadFITSHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a generic table.load.fits message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_144ec2329355d91022d5ea38736c0093}{samp\_\-tbLoadVOTHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a generic table.load.votable message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_d9184eb45a5bc93b5205fd5b1c6ef688}{samp\_\-tbHighlightHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a table.highlight.row message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_98d68d7091c0b7790631bb53e0ace656}{samp\_\-tbSelectHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a table.select.rowList message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_3f5632858a2b09759ffe98cd2e183cfb}{samp\_\-pointAtHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a coord.pointAt.sky message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_bc319b97b3dbea29bd79c4f723db5438}{samp\_\-specLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a spectrum.load.$\ast$ message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_dd2bca8fa3bf3b4ebbf449edc6b65d85}{samp\_\-specSSAHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a spectrum.load.ssa-generic message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_c57d19afc6fa0b4bc9c7a0fd50d0f54b}{samp\_\-cmdExecHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.cmd.exec message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_e25a92f57babd71d43653d7fcb81025c}{samp\_\-envGetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.env.set message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_0910e6b9d11cdd3111c1f18450de394a}{samp\_\-envSetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.env.set message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_659c272ce881662c1826a04728dc06f6}{samp\_\-paramGetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.param.set message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_071aa9e32f2e94d5b667e87cf65d2bdf}{samp\_\-paramSetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.param.set message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_262bf09278c61b60b5189fef7f26d26b}{samp\_\-bibcodeHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a bibcode.load message. \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_c0bf7cf7fea362c0c82ad7bc3f267c48}{samp\_\-resLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_287569451dc1bf59d1f9f6d13b56716d}{samp\_\-resConeHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_8b2300222d7b11f144eb4385412e69a5}{samp\_\-resSiapHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_866578a01c3b762435823b1b11869c42}{samp\_\-resSsapHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_ad42ca17cbaf23012ad497559ea45e4c}{samp\_\-resTapHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{sampHandlers_8c_fa207ebdc587ba5eeab60fbf79b635d4}{samp\_\-resVOSpaceHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +\hypertarget{sampHandlers_8c_e743048f5b1f903496b2a8a2e9666367}{ +void \textbf{samp\_\-printMessage} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} params)} +\label{sampHandlers_8c_e743048f5b1f903496b2a8a2e9666367} + +\item +void \hyperlink{sampHandlers_8c_a8a947c24f2c9333adf4e5d7fa11d134}{samp\_\-printMap} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\item +int \hyperlink{sampHandlers_8c_5361571754505eaefdf5739cd3e9519e}{samp\_\-nullResponse} (void $\ast$data) +\item +\hypertarget{sampHandlers_8c_cc687f745f400b41c9af4f6419bf9bf8}{ +int \textbf{samp\_\-testEcho} (void $\ast$data)} +\label{sampHandlers_8c_cc687f745f400b41c9af4f6419bf9bf8} + +\end{CompactItemize} +\subsection*{Variables} +\begin{CompactItemize} +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampHandlers_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e}{nullMap} +\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampHandlers_8c_a2106c7fe3a5747178c046238fbd5d55}{nullList} +\item +\hypertarget{sampHandlers_8c_12abcaf1a16a8a7c2ef6358cdbf4d705}{ +\hyperlink{structSamp}{Samp} $\ast$ \textbf{sampP}} +\label{sampHandlers_8c_12abcaf1a16a8a7c2ef6358cdbf4d705} + +\item +handle\_\-t \hyperlink{sampHandlers_8c_b04b61ee02d86e15b02b861699ae7424}{sampH} +\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +Message handlers for the interface. + +SAMPHANDLERS.C -- Message handlers for the interface. + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/09 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampHandlers_8c_262bf09278c61b60b5189fef7f26d26b}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-bibcodeHandler@{samp\_\-bibcodeHandler}} +\index{samp\_\-bibcodeHandler@{samp\_\-bibcodeHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-bibcodeHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-bibcodeHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_262bf09278c61b60b5189fef7f26d26b} + + +Handle a bibcode.load message. + +SAMP\_\-BIBCODEHANDLER -- Handle a bibcode.load message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_c57d19afc6fa0b4bc9c7a0fd50d0f54b}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-cmdExecHandler@{samp\_\-cmdExecHandler}} +\index{samp\_\-cmdExecHandler@{samp\_\-cmdExecHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-cmdExecHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-cmdExecHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_c57d19afc6fa0b4bc9c7a0fd50d0f54b} + + +Handle a client.cmd.exec message. + +SAMP\_\-CMDEXECHANDLER -- Handle a client.cmd.exec message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), and samp\_\-getUserHandler().\hypertarget{sampHandlers_8c_e25a92f57babd71d43653d7fcb81025c}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-envGetHandler@{samp\_\-envGetHandler}} +\index{samp\_\-envGetHandler@{samp\_\-envGetHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-envGetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-envGetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_e25a92f57babd71d43653d7fcb81025c} + + +Handle a client.env.set message. + +SAMP\_\-ENVGETHANDLER -- Handle a client.env.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-freeMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-newMap(), samp\_\-setHandlerReply(), samp\_\-setMapInMap(), samp\_\-setStringInMap(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_0910e6b9d11cdd3111c1f18450de394a}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-envSetHandler@{samp\_\-envSetHandler}} +\index{samp\_\-envSetHandler@{samp\_\-envSetHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-envSetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-envSetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_0910e6b9d11cdd3111c1f18450de394a} + + +Handle a client.env.set message. + +SAMP\_\-ENVSETHANDLER -- Handle a client.env.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_23644999b70eebfe75f52c465d1ed97f}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-execUserHandler@{samp\_\-execUserHandler}} +\index{samp\_\-execUserHandler@{samp\_\-execUserHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-execUserHandler}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-execUserHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em params})}} +\label{sampHandlers_8c_23644999b70eebfe75f52c465d1ed97f} + + +Execute the user-defined handler for the mtype. + +SAMP\_\-EXECUSERHANDLER -- Execute the user-defined handler for the mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message-id string \item[{\em params}]Mtype parameter Map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +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().\hypertarget{sampHandlers_8c_6ef18dbc5870f58d2161c9ba03a81d26}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-getSampHandler@{samp\_\-getSampHandler}} +\index{samp\_\-getSampHandler@{samp\_\-getSampHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-getSampHandler}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ samp\_\-getSampHandler ({\bf String} {\em mtype})}} +\label{sampHandlers_8c_6ef18dbc5870f58d2161c9ba03a81d26} + + +Get the Samphandler for the named mtype. + +SAMP\_\-GETSAMPHANDLER -- Get the Samphandler for the named mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::nsubs, and Subs::sampFunc. + +Referenced by samp\_\-receiveCall(), samp\_\-receiveNotification(), and samp\_\-Subscribe().\hypertarget{sampHandlers_8c_6bb258d378627da1aa0254fccdb6bd2c}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-getUserHandler@{samp\_\-getUserHandler}} +\index{samp\_\-getUserHandler@{samp\_\-getUserHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-getUserHandler}]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ samp\_\-getUserHandler ({\bf String} {\em mtype})}} +\label{sampHandlers_8c_6bb258d378627da1aa0254fccdb6bd2c} + + +Get the User handler for the named mtype. + +SAMP\_\-GETUSERHANDLER -- Get the User handler for the named mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +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().\hypertarget{sampHandlers_8c_bea5fa0cd958545710afcf3c5da9dc15}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-hubHandler@{samp\_\-hubHandler}} +\index{samp\_\-hubHandler@{samp\_\-hubHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-hubHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_bea5fa0cd958545710afcf3c5da9dc15} + + +Handle \hyperlink{structHub}{Hub} event messages. + +SAMP\_\-HUBHANDLER -- Handle \hyperlink{structHub}{Hub} event messages. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{sampHandlers_8c_9bd8036dd65dc4f874f39568b691a123}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-imLoadHandler@{samp\_\-imLoadHandler}} +\index{samp\_\-imLoadHandler@{samp\_\-imLoadHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-imLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-imLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_9bd8036dd65dc4f874f39568b691a123} + + +Handle an image.load.fits message. + +SAMP\_\-IMLOADHANDLER -- Handle an image.load.fits message. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_5361571754505eaefdf5739cd3e9519e}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-nullResponse@{samp\_\-nullResponse}} +\index{samp\_\-nullResponse@{samp\_\-nullResponse}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-nullResponse}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-nullResponse (void $\ast$ {\em data})}} +\label{sampHandlers_8c_5361571754505eaefdf5739cd3e9519e} + + +SAMP\_\-NULLRESPONSE -- Handler to ignore async replies. + +Referenced by samp\_\-hubSendShutdown(), samp\_\-notify(), and samp\_\-Reply().\hypertarget{sampHandlers_8c_659c272ce881662c1826a04728dc06f6}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-paramGetHandler@{samp\_\-paramGetHandler}} +\index{samp\_\-paramGetHandler@{samp\_\-paramGetHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-paramGetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramGetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_659c272ce881662c1826a04728dc06f6} + + +Handle a client.param.set message. + +SAMP\_\-PARAMGETHANDLER -- Handle a client.param.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-freeMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-newMap(), samp\_\-setHandlerReply(), samp\_\-setMapInMap(), samp\_\-setStringInMap(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_071aa9e32f2e94d5b667e87cf65d2bdf}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-paramSetHandler@{samp\_\-paramSetHandler}} +\index{samp\_\-paramSetHandler@{samp\_\-paramSetHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-paramSetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramSetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_071aa9e32f2e94d5b667e87cf65d2bdf} + + +Handle a client.param.set message. + +SAMP\_\-PARAMSETHANDLER -- Handle a client.param.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_16d8b8822d169107b8702ae753797923}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-PingHandler@{samp\_\-PingHandler}} +\index{samp\_\-PingHandler@{samp\_\-PingHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-PingHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-PingHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_16d8b8822d169107b8702ae753797923} + + +Is app alive and responding to messages? + +SAMP\_\-PINGHANDLER -- Simple aliveness test function. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, and samp\_\-getUserHandler().\hypertarget{sampHandlers_8c_3f5632858a2b09759ffe98cd2e183cfb}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-pointAtHandler@{samp\_\-pointAtHandler}} +\index{samp\_\-pointAtHandler@{samp\_\-pointAtHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-pointAtHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-pointAtHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_3f5632858a2b09759ffe98cd2e183cfb} + + +Handle a coord.pointAt.sky message. + +SAMP\_\-POINTATHANDLER -- Handle a coord.pointAt.sky message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getFloatFromMap(), and samp\_\-getUserHandler().\hypertarget{sampHandlers_8c_a8a947c24f2c9333adf4e5d7fa11d134}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-printMap@{samp\_\-printMap}} +\index{samp\_\-printMap@{samp\_\-printMap}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-printMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-printMap ({\bf String} {\em name}, \/ {\bf Map} {\em map})}} +\label{sampHandlers_8c_a8a947c24f2c9333adf4e5d7fa11d134} + + +SAMP\_\-PRINTMAP -- Print the contents of a Map structure. \hypertarget{sampHandlers_8c_287569451dc1bf59d1f9f6d13b56716d}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-resConeHandler@{samp\_\-resConeHandler}} +\index{samp\_\-resConeHandler@{samp\_\-resConeHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-resConeHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resConeHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_287569451dc1bf59d1f9f6d13b56716d} + + +handle a voresource.loadlist message + +SAMP\_\-RESCONEHANDLER -- Handle a voresource.loadlist.cone message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_c0bf7cf7fea362c0c82ad7bc3f267c48}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-resLoadHandler@{samp\_\-resLoadHandler}} +\index{samp\_\-resLoadHandler@{samp\_\-resLoadHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-resLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_c0bf7cf7fea362c0c82ad7bc3f267c48} + + +handle a voresource.loadlist message + +SAMP\_\-RESLOADHANDLER -- handle a voresource.loadlist.$\ast$ message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +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().\hypertarget{sampHandlers_8c_8b2300222d7b11f144eb4385412e69a5}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-resSiapHandler@{samp\_\-resSiapHandler}} +\index{samp\_\-resSiapHandler@{samp\_\-resSiapHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-resSiapHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resSiapHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_8b2300222d7b11f144eb4385412e69a5} + + +handle a voresource.loadlist message + +SAMP\_\-RESSIAPHANDLER -- Handle a voresource.loadlist.siap message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_866578a01c3b762435823b1b11869c42}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-resSsapHandler@{samp\_\-resSsapHandler}} +\index{samp\_\-resSsapHandler@{samp\_\-resSsapHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-resSsapHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resSsapHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_866578a01c3b762435823b1b11869c42} + + +handle a voresource.loadlist message + +SAMP\_\-RESSSAPHANDLER -- Handle a voresource.loadlist.ssap message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_ad42ca17cbaf23012ad497559ea45e4c}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-resTapHandler@{samp\_\-resTapHandler}} +\index{samp\_\-resTapHandler@{samp\_\-resTapHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-resTapHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resTapHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_ad42ca17cbaf23012ad497559ea45e4c} + + +handle a voresource.loadlist message + +SAMP\_\-RESTAPHANDLER -- Handle a voresource.loadlist.tap message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_fa207ebdc587ba5eeab60fbf79b635d4}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-resVOSpaceHandler@{samp\_\-resVOSpaceHandler}} +\index{samp\_\-resVOSpaceHandler@{samp\_\-resVOSpaceHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-resVOSpaceHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resVOSpaceHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_fa207ebdc587ba5eeab60fbf79b635d4} + + +handle a voresource.loadlist message + +SAMP\_\-RESVOSPACEHANDLER -- Handle a voresource.loadlist.vospace message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-resLoadHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_2e8ec01a0dd96314622ae313206583db}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-setSampHandler@{samp\_\-setSampHandler}} +\index{samp\_\-setSampHandler@{samp\_\-setSampHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-setSampHandler}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setSampHandler (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype}, \/ void $\ast$ {\em func})}} +\label{sampHandlers_8c_2e8ec01a0dd96314622ae313206583db} + + +Set the SAMP interface handler for the mtype. + +SAMP\_\-SETSAMPHANDLER -- Set the SAMP interface handler for the mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \item[{\em func}]callback function \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::nsubs, and Subs::sampFunc. + +Referenced by samp\_\-Subscribe().\hypertarget{sampHandlers_8c_81222e1f3572585fa30f11a78aa08c3f}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-setUserHandler@{samp\_\-setUserHandler}} +\index{samp\_\-setUserHandler@{samp\_\-setUserHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-setUserHandler}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setUserHandler (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype}, \/ void $\ast$ {\em func})}} +\label{sampHandlers_8c_81222e1f3572585fa30f11a78aa08c3f} + + +Set the user-interface handler for the mtype. + +SAMP\_\-SETUSERHANDLER -- Set the user-interface handler for the mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \item[{\em func}]callback function \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::defaultUserFunc, Samp::nsubs, and Subs::userFunc. + +Referenced by samp\_\-Subscribe().\hypertarget{sampHandlers_8c_bc319b97b3dbea29bd79c4f723db5438}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-specLoadHandler@{samp\_\-specLoadHandler}} +\index{samp\_\-specLoadHandler@{samp\_\-specLoadHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-specLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-specLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_bc319b97b3dbea29bd79c4f723db5438} + + +Handle a spectrum.load.$\ast$ message. + +SAMP\_\-SPECLOADHANDLER -- Handle a spectrum.load.$\ast$ message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME. + +Referenced by samp\_\-specSSAHandler().\hypertarget{sampHandlers_8c_dd2bca8fa3bf3b4ebbf449edc6b65d85}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-specSSAHandler@{samp\_\-specSSAHandler}} +\index{samp\_\-specSSAHandler@{samp\_\-specSSAHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-specSSAHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-specSSAHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_dd2bca8fa3bf3b4ebbf449edc6b65d85} + + +Handle a spectrum.load.ssa-generic message. + +SAMP\_\-SPECSSAHANDLER -- Handle a spectrum.load.ssa-generic message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getMapFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-specLoadHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_2e342b672e77e012cc98a6f5506a44be}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-StatusHandler@{samp\_\-StatusHandler}} +\index{samp\_\-StatusHandler@{samp\_\-StatusHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-StatusHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-StatusHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_2e342b672e77e012cc98a6f5506a44be} + + +Return status of the task. + +SAMP\_\-STATUSHANDLER -- Return status of the task. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, and samp\_\-getUserHandler().\hypertarget{sampHandlers_8c_d9184eb45a5bc93b5205fd5b1c6ef688}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-tbHighlightHandler@{samp\_\-tbHighlightHandler}} +\index{samp\_\-tbHighlightHandler@{samp\_\-tbHighlightHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-tbHighlightHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbHighlightHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_d9184eb45a5bc93b5205fd5b1c6ef688} + + +Handle a table.highlight.row message. + +SAMP\_\-TBHIGHLIGHTHANDLER -- Handle a table.highlight.row message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getIntFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_750c0fee0c7a99e135299c08751f288c}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-tbLoadFITSHandler@{samp\_\-tbLoadFITSHandler}} +\index{samp\_\-tbLoadFITSHandler@{samp\_\-tbLoadFITSHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-tbLoadFITSHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbLoadFITSHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_750c0fee0c7a99e135299c08751f288c} + + +Handle a generic table.load.fits message. + +SAMP\_\-TBLOADFITSHANDLER -- Handle a generic table.load.fits message $\ast$\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-tbLoadHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_26f96dc6cbf72283e2ee9cb8b4619ed3}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-tbLoadHandler@{samp\_\-tbLoadHandler}} +\index{samp\_\-tbLoadHandler@{samp\_\-tbLoadHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-tbLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_26f96dc6cbf72283e2ee9cb8b4619ed3} + + +Handle a generic table.load.$\ast$ message. + +SAMP\_\-TBLOADHANDLER -- Handle a generic table.load.$\ast$ message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), and SZ\_\-NAME. + +Referenced by samp\_\-tbLoadFITSHandler(), and samp\_\-tbLoadVOTHandler().\hypertarget{sampHandlers_8c_144ec2329355d91022d5ea38736c0093}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-tbLoadVOTHandler@{samp\_\-tbLoadVOTHandler}} +\index{samp\_\-tbLoadVOTHandler@{samp\_\-tbLoadVOTHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-tbLoadVOTHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbLoadVOTHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_144ec2329355d91022d5ea38736c0093} + + +Handle a generic table.load.votable message. + +SAMP\_\-TBLOADVOTHANDLER -- Handle a generic table.load.votable message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-tbLoadHandler(), and SZ\_\-NAME.\hypertarget{sampHandlers_8c_98d68d7091c0b7790631bb53e0ace656}{ +\index{sampHandlers.c@{sampHandlers.c}!samp\_\-tbSelectHandler@{samp\_\-tbSelectHandler}} +\index{samp\_\-tbSelectHandler@{samp\_\-tbSelectHandler}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{samp\_\-tbSelectHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbSelectHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{sampHandlers_8c_98d68d7091c0b7790631bb53e0ace656} + + +Handle a table.select.rowList message. + +SAMP\_\-TBSELECTHANDLER -- Handle a table.select.rowList message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::handlerMode, samp\_\-getListFromMap(), samp\_\-getStringFromMap(), samp\_\-getUserHandler(), samp\_\-listLen(), and SZ\_\-NAME. + +\subsection{Variable Documentation} +\hypertarget{sampHandlers_8c_a2106c7fe3a5747178c046238fbd5d55}{ +\index{sampHandlers.c@{sampHandlers.c}!nullList@{nullList}} +\index{nullList@{nullList}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{nullList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} {\bf nullList}}} +\label{sampHandlers_8c_a2106c7fe3a5747178c046238fbd5d55} + + +SAMP\_\-OK Map struct \hypertarget{sampHandlers_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e}{ +\index{sampHandlers.c@{sampHandlers.c}!nullMap@{nullMap}} +\index{nullMap@{nullMap}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{nullMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} {\bf nullMap}}} +\label{sampHandlers_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e} + + +SAMP handle \hypertarget{sampHandlers_8c_b04b61ee02d86e15b02b861699ae7424}{ +\index{sampHandlers.c@{sampHandlers.c}!sampH@{sampH}} +\index{sampH@{sampH}!sampHandlers.c@{sampHandlers.c}} +\subsubsection[{sampH}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t {\bf sampH}}} +\label{sampHandlers_8c_b04b61ee02d86e15b02b861699ae7424} + + +SAMP struct pointer
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampHub_8c.tex b/vendor/voclient/libsamp/doc/latex/sampHub_8c.tex new file mode 100644 index 00000000..5f668259 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampHub_8c.tex @@ -0,0 +1,421 @@ +\hypertarget{sampHub_8c}{ +\section{sampHub.c File Reference} +\label{sampHub_8c}\index{sampHub.c@{sampHub.c}} +} +Methods related to the SAMP \hyperlink{structHub}{Hub} interface. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include $<$time.h$>$}\par +{\tt \#include $<$pthread.h$>$}\par +{\tt \#include $<$ctype.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Defines} +\begin{CompactItemize} +\item +\hypertarget{sampHub_8c_15f13b436c106e975a91e0d343005e01}{ +\#define \textbf{HUB\_\-DBG}~(getenv(\char`\"{}HUB\_\-DBG\char`\"{})!=NULL$|$$|$access(\char`\"{}/tmp/HUB\_\-DBG\char`\"{},F\_\-OK)==0)} +\label{sampHub_8c_15f13b436c106e975a91e0d343005e01} + +\end{CompactItemize} +\subsection*{Functions} +\begin{CompactItemize} +\item +handle\_\-t \hyperlink{sampHub_8c_ab66aed8f93a9cd5734a8dd62e427418}{samp\_\-hubOpen} (\hyperlink{structSamp}{Samp} $\ast$sampP) +\begin{CompactList}\small\item\em Discover and open a connection to the SAMP \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_52f471568663ac6f0116d57a9ce00f00}{samp\_\-hubClose} (handle\_\-t handle) +\begin{CompactList}\small\item\em Close a connection to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_a927eb8dcb67e245aeb5a8a4feeb6230}{samp\_\-hubRunning} (void) +\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampHub_8c_e792eedc70daa9b2d010ca6cd8e57fe8}{samp\_\-getAvailableHubs} (handle\_\-t handle) +\begin{CompactList}\small\item\em Get a list of available Hubs. \item\end{CompactList}\item +\hypertarget{sampHub_8c_4b4292d136520c3d276d655e2093dd30}{ +char $\ast$ \textbf{samp\_\-getActiveHubName} (handle\_\-t handle)} +\label{sampHub_8c_4b4292d136520c3d276d655e2093dd30} + +\item +\hypertarget{sampHub_8c_bf266e81b16f556e2f42cad5a2eb9157}{ +int \textbf{samp\_\-getActiveHub} (handle\_\-t handle)} +\label{sampHub_8c_bf266e81b16f556e2f42cad5a2eb9157} + +\item +\hypertarget{sampHub_8c_b7ea81f81c8b5b5a6d7a323e9c98cd12}{ +int \textbf{samp\_\-hubInit} (handle\_\-t handle, char $\ast$appName, char $\ast$descr)} +\label{sampHub_8c_b7ea81f81c8b5b5a6d7a323e9c98cd12} + +\item +int \hyperlink{sampHub_8c_2933b26ac05c440196368edad0167bdf}{samp\_\-processHubEvent} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} params) +\begin{CompactList}\small\item\em Determine the type of \hyperlink{structHub}{Hub} event mtype. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_19f64b527fcc431541206e41f8e36132}{samp\_\-hubEvent} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Determine the type of \hyperlink{structHub}{Hub} event mtype. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_13ad32079ae1db571e3114b7bd8ba356}{samp\_\-hubRegister} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Send a Register message to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_6d4e32ed0eb19f02cc8a75f75a98deec}{samp\_\-hubUnRegister} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Send a UnRegister message to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_a704d2a0d290f2fdfb3ebfffc39adcb3}{samp\_\-hubSendShutdown} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Send a samp.app.event.shutdown message to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_2fcb0032e5ae98fff93becdb06da49f9}{samp\_\-hubSetXmlrpcCallback} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Set the client callback and send to \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_47b1a9a4627fde97f95b40b372153cf6}{samp\_\-hubPing} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Ping the \hyperlink{structHub}{Hub} to see if it is alive. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_088f1e762175d0dbc315853d06e50149}{samp\_\-hubDeclareMetadata} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Declare \char`\"{}standard\char`\"{} metadata to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{sampHub_8c_7be493427eac28b2a064eedd8a7d63ff}{samp\_\-hubDeclareSubscriptions} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Declare mtype subscriptions to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\end{CompactItemize} +\subsection*{Variables} +\begin{CompactItemize} +\item +\hyperlink{structHub}{Hub} $\ast$ \hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub} = (\hyperlink{structHub}{Hub} $\ast$) NULL +\item +int \hyperlink{sampHub_8c_037f00cb1101b007b4bf45e8bee1bd3e}{numHubs} = 0 +\item +handle\_\-t \hyperlink{sampHub_8c_86b0db44d25bc3079d8d9d75e01a0ecd}{hubHandles} \mbox{[}MAX\_\-HUBS\mbox{]} +\item +pthread\_\-mutex\_\-t \hyperlink{sampHub_8c_c49d9bc6850c63f257c18f2920915d9c}{samp\_\-mutex} = PTHREAD\_\-MUTEX\_\-INITIALIZER +\item +\hypertarget{sampHub_8c_12abcaf1a16a8a7c2ef6358cdbf4d705}{ +\hyperlink{structSamp}{Samp} $\ast$ \textbf{sampP}} +\label{sampHub_8c_12abcaf1a16a8a7c2ef6358cdbf4d705} + +\item +\hypertarget{sampHub_8c_b45e068a722f83368367449cb0a5312b}{ +int \textbf{numSamps}} +\label{sampHub_8c_b45e068a722f83368367449cb0a5312b} + +\item +\hypertarget{sampHub_8c_9ee46f73e7f3c5e99958a618b2b6ed5a}{ +handle\_\-t \textbf{sampHandles} \mbox{[}MAX\_\-SAMPS\mbox{]}} +\label{sampHub_8c_9ee46f73e7f3c5e99958a618b2b6ed5a} + +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampHub_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e}{nullMap} +\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +Methods related to the SAMP \hyperlink{structHub}{Hub} interface. + +SAMPHUB.C -- Methods related to the SAMP \hyperlink{structHub}{Hub} interface. + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/09 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampHub_8c_e792eedc70daa9b2d010ca6cd8e57fe8}{ +\index{sampHub.c@{sampHub.c}!samp\_\-getAvailableHubs@{samp\_\-getAvailableHubs}} +\index{samp\_\-getAvailableHubs@{samp\_\-getAvailableHubs}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-getAvailableHubs}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-getAvailableHubs (handle\_\-t {\em handle})}} +\label{sampHub_8c_e792eedc70daa9b2d010ca6cd8e57fe8} + + +Get a list of available Hubs. + +SAMP\_\-GETAVAILABLEHUBS -- Get a list of available Hubs + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]hub handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]List of hub handles \end{Desc} +\hypertarget{sampHub_8c_52f471568663ac6f0116d57a9ce00f00}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubClose@{samp\_\-hubClose}} +\index{samp\_\-hubClose@{samp\_\-hubClose}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubClose}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubClose (handle\_\-t {\em handle})}} +\label{sampHub_8c_52f471568663ac6f0116d57a9ce00f00} + + +Close a connection to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBCLOSE -- Close a connection to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]hub handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]unregister status \end{Desc} + + +References appMD::aKey, appMD::aVal, Hub::meta, appMD::nkeys, samp\_\-freeHandle(), and samp\_\-hubUnRegister(). + +Referenced by sampClose(), and sampShutdown().\hypertarget{sampHub_8c_088f1e762175d0dbc315853d06e50149}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubDeclareMetadata@{samp\_\-hubDeclareMetadata}} +\index{samp\_\-hubDeclareMetadata@{samp\_\-hubDeclareMetadata}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubDeclareMetadata}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubDeclareMetadata ({\bf Hub} $\ast$ {\em hub})}} +\label{sampHub_8c_088f1e762175d0dbc315853d06e50149} + + +Declare \char`\"{}standard\char`\"{} metadata to the \hyperlink{structHub}{Hub}. + +SAMP\_\-DECLAREMETADATA -- Declare \char`\"{}standard\char`\"{} metadata to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References appMD::aKey, appMD::aVal, Hub::description, appMD::docURL, appMD::iconURL, Hub::id, Hub::meta, appMD::nkeys, and Hub::privateKey. + +Referenced by samp\_\-DeclareMetadata(), and sampStartup().\hypertarget{sampHub_8c_7be493427eac28b2a064eedd8a7d63ff}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubDeclareSubscriptions@{samp\_\-hubDeclareSubscriptions}} +\index{samp\_\-hubDeclareSubscriptions@{samp\_\-hubDeclareSubscriptions}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubDeclareSubscriptions}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubDeclareSubscriptions ({\bf Hub} $\ast$ {\em hub})}} +\label{sampHub_8c_7be493427eac28b2a064eedd8a7d63ff} + + +Declare mtype subscriptions to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBDECLARESUBSCRIPTIONS -- Declare mtype subscriptions to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, Samp::nsubs, nullMap, Hub::privateKey, Hub::samp, samp\_\-freeMap(), and Subs::userFunc. + +Referenced by samp\_\-DeclareSubscriptions(), and sampStartup().\hypertarget{sampHub_8c_19f64b527fcc431541206e41f8e36132}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubEvent@{samp\_\-hubEvent}} +\index{samp\_\-hubEvent@{samp\_\-hubEvent}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubEvent}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubEvent ({\bf String} {\em mtype})}} +\label{sampHub_8c_19f64b527fcc431541206e41f8e36132} + + +Determine the type of \hyperlink{structHub}{Hub} event mtype. + +SAMP\_\-HUBEVENT -- Determine the type of \hyperlink{structHub}{Hub} event mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]\hyperlink{structHub}{Hub} event code or -1 if not found \end{Desc} + + +References HUB\_\-SHUTDOWN. + +Referenced by samp\_\-processHubEvent().\hypertarget{sampHub_8c_ab66aed8f93a9cd5734a8dd62e427418}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubOpen@{samp\_\-hubOpen}} +\index{samp\_\-hubOpen@{samp\_\-hubOpen}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubOpen}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t samp\_\-hubOpen ({\bf Samp} $\ast$ {\em sampP})}} +\label{sampHub_8c_ab66aed8f93a9cd5734a8dd62e427418} + + +Discover and open a connection to the SAMP \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBOPEN -- Discover and open a connection to the SAMP \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em samp}]Same structure \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]hub handle \end{Desc} + + +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. + +Referenced by sampInit(), and sampStartup().\hypertarget{sampHub_8c_47b1a9a4627fde97f95b40b372153cf6}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubPing@{samp\_\-hubPing}} +\index{samp\_\-hubPing@{samp\_\-hubPing}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubPing}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubPing ({\bf Hub} $\ast$ {\em hub})}} +\label{sampHub_8c_47b1a9a4627fde97f95b40b372153cf6} + + +Ping the \hyperlink{structHub}{Hub} to see if it is alive. + +SAMP\_\-HUBPING -- Ping the \hyperlink{structHub}{Hub} to see if it is alive. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, and Hub::privateKey. + +Referenced by samp\_\-Ping().\hypertarget{sampHub_8c_13ad32079ae1db571e3114b7bd8ba356}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubRegister@{samp\_\-hubRegister}} +\index{samp\_\-hubRegister@{samp\_\-hubRegister}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubRegister}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubRegister ({\bf Hub} $\ast$ {\em hub})}} +\label{sampHub_8c_13ad32079ae1db571e3114b7bd8ba356} + + +Send a Register message to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUB\_\-REGISTER -- Send a Register message to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::hubId, Hub::id, Hub::privateKey, Hub::secret, and Hub::selfId. + +Referenced by samp\_\-hubOpen().\hypertarget{sampHub_8c_a927eb8dcb67e245aeb5a8a4feeb6230}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubRunning@{samp\_\-hubRunning}} +\index{samp\_\-hubRunning@{samp\_\-hubRunning}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubRunning}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubRunning (void)}} +\label{sampHub_8c_a927eb8dcb67e245aeb5a8a4feeb6230} + + +SAMP\_\-HUBRUNNING -- See whether a \hyperlink{structHub}{Hub} is running. The test simply checks the existence of a \hyperlink{structHub}{Hub} lockfile. + +References SZ\_\-NAME.\hypertarget{sampHub_8c_a704d2a0d290f2fdfb3ebfffc39adcb3}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubSendShutdown@{samp\_\-hubSendShutdown}} +\index{samp\_\-hubSendShutdown@{samp\_\-hubSendShutdown}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubSendShutdown}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubSendShutdown ({\bf Hub} $\ast$ {\em hub})}} +\label{sampHub_8c_a704d2a0d290f2fdfb3ebfffc39adcb3} + + +Send a samp.app.event.shutdown message to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBSENDSHUTDOWN -- Send a samp.app.event.shutdown message to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, Hub::privateKey, and samp\_\-nullResponse().\hypertarget{sampHub_8c_2fcb0032e5ae98fff93becdb06da49f9}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubSetXmlrpcCallback@{samp\_\-hubSetXmlrpcCallback}} +\index{samp\_\-hubSetXmlrpcCallback@{samp\_\-hubSetXmlrpcCallback}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubSetXmlrpcCallback}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubSetXmlrpcCallback ({\bf Hub} $\ast$ {\em hub})}} +\label{sampHub_8c_2fcb0032e5ae98fff93becdb06da49f9} + + +Set the client callback and send to \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBSETXMLRPCCALLBACK -- Set the client callback and send to \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, Hub::privateKey, and samp\_\-serverPort(). + +Referenced by samp\_\-hubOpen().\hypertarget{sampHub_8c_6d4e32ed0eb19f02cc8a75f75a98deec}{ +\index{sampHub.c@{sampHub.c}!samp\_\-hubUnRegister@{samp\_\-hubUnRegister}} +\index{samp\_\-hubUnRegister@{samp\_\-hubUnRegister}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-hubUnRegister}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubUnRegister ({\bf Hub} $\ast$ {\em hub})}} +\label{sampHub_8c_6d4e32ed0eb19f02cc8a75f75a98deec} + + +Send a UnRegister message to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBUNREGISTER -- Send a UnRegister message to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +References Hub::id, and Hub::privateKey. + +Referenced by samp\_\-hubClose(), and samp\_\-UnRegister().\hypertarget{sampHub_8c_2933b26ac05c440196368edad0167bdf}{ +\index{sampHub.c@{sampHub.c}!samp\_\-processHubEvent@{samp\_\-processHubEvent}} +\index{samp\_\-processHubEvent@{samp\_\-processHubEvent}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-processHubEvent}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-processHubEvent ({\bf String} {\em mtype}, \/ {\bf Map} {\em params})}} +\label{sampHub_8c_2933b26ac05c440196368edad0167bdf} + + +Determine the type of \hyperlink{structHub}{Hub} event mtype. + +SAMP\_\-HUBEVENT -- Determine the type of \hyperlink{structHub}{Hub} event mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \item[{\em params}]message parameter Map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]non-zero value if a \hyperlink{structHub}{Hub} event was processed \end{Desc} + + +References HUB\_\-SHUTDOWN, samp\_\-addClient(), samp\_\-hubEvent(), samp\_\-mutex, samp\_\-P2H(), samp\_\-removeClient(), sampH, and sampShutdown(). + +Referenced by samp\_\-receiveNotification(). + +\subsection{Variable Documentation} +\hypertarget{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{ +\index{sampHub.c@{sampHub.c}!hub@{hub}} +\index{hub@{hub}!sampHub.c@{sampHub.c}} +\subsubsection[{hub}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Hub}$\ast$ {\bf hub} = ({\bf Hub} $\ast$) NULL}} +\label{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad} + + +empty List struct + +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\_\-imageLoadFITS(), samp\_\-notify(), samp\_\-notifyAll(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Register(), samp\_\-Reply(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), samp\_\-tableSelectRowList(), and samp\_\-UnRegister().\hypertarget{sampHub_8c_86b0db44d25bc3079d8d9d75e01a0ecd}{ +\index{sampHub.c@{sampHub.c}!hubHandles@{hubHandles}} +\index{hubHandles@{hubHandles}!sampHub.c@{sampHub.c}} +\subsubsection[{hubHandles}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t {\bf hubHandles}\mbox{[}MAX\_\-HUBS\mbox{]}}} +\label{sampHub_8c_86b0db44d25bc3079d8d9d75e01a0ecd} + + +No. of available hubs \hypertarget{sampHub_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e}{ +\index{sampHub.c@{sampHub.c}!nullMap@{nullMap}} +\index{nullMap@{nullMap}!sampHub.c@{sampHub.c}} +\subsubsection[{nullMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} {\bf nullMap}}} +\label{sampHub_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e} + + +SAMP handle \hypertarget{sampHub_8c_037f00cb1101b007b4bf45e8bee1bd3e}{ +\index{sampHub.c@{sampHub.c}!numHubs@{numHubs}} +\index{numHubs@{numHubs}!sampHub.c@{sampHub.c}} +\subsubsection[{numHubs}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf numHubs} = 0}} +\label{sampHub_8c_037f00cb1101b007b4bf45e8bee1bd3e} + + +HUB connection \hypertarget{sampHub_8c_c49d9bc6850c63f257c18f2920915d9c}{ +\index{sampHub.c@{sampHub.c}!samp\_\-mutex@{samp\_\-mutex}} +\index{samp\_\-mutex@{samp\_\-mutex}!sampHub.c@{sampHub.c}} +\subsubsection[{samp\_\-mutex}]{\setlength{\rightskip}{0pt plus 5cm}pthread\_\-mutex\_\-t {\bf samp\_\-mutex} = PTHREAD\_\-MUTEX\_\-INITIALIZER}} +\label{sampHub_8c_c49d9bc6850c63f257c18f2920915d9c} + + +lock so we can update struct + +Referenced by samp\_\-processHubEvent().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampList_8c.tex b/vendor/voclient/libsamp/doc/latex/sampList_8c.tex new file mode 100644 index 00000000..821a0745 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampList_8c.tex @@ -0,0 +1,301 @@ +\hypertarget{sampList_8c}{ +\section{sampList.c File Reference} +\label{sampList_8c}\index{sampList.c@{sampList.c}} +} +(Internal) interface to support the List structure. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +handle\_\-t \hyperlink{sampList_8c_b5375a6478dccefe7df2b48416604b29}{samp\_\-newList} () +\begin{CompactList}\small\item\em Create a new List object. \item\end{CompactList}\item +void \hyperlink{sampList_8c_b162ae9b9f98da80f6bb5c34b5cbcbf6}{samp\_\-freeList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list) +\begin{CompactList}\small\item\em Free the given List object. \item\end{CompactList}\item +int \hyperlink{sampList_8c_c260afb0cbf19b427e3eba96a2341e52}{samp\_\-listLen} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list) +\begin{CompactList}\small\item\em Get number of elements in a List. \item\end{CompactList}\item +void \hyperlink{sampList_8c_5b69180b036e58528c98b1cf5a42825a}{samp\_\-setStringInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, char $\ast$value) +\begin{CompactList}\small\item\em Set a string in a List (append). \item\end{CompactList}\item +void \hyperlink{sampList_8c_ea188bb711f3b5549d11204b0ff2da08}{samp\_\-setMapInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\begin{CompactList}\small\item\em Set a Map in a List (append). \item\end{CompactList}\item +void \hyperlink{sampList_8c_0ff97d44e62b7c88a046a29324552400}{samp\_\-setListInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list1, \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list2) +\begin{CompactList}\small\item\em Set a List in another List (append). \item\end{CompactList}\item +void \hyperlink{sampList_8c_a803bead8b452de6e1d08b8b3b9e8828}{samp\_\-setIntInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int ival) +\begin{CompactList}\small\item\em Set an Int in a List (append). \item\end{CompactList}\item +void \hyperlink{sampList_8c_18d586491620a63b3a4d6c3667ee2aa5}{samp\_\-setFloatInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, float rval) +\begin{CompactList}\small\item\em Set a Float in a List (append). \item\end{CompactList}\item +char $\ast$ \hyperlink{sampList_8c_2d1cd41c4583ac300aaa2d50ad3f76ed}{samp\_\-getStringFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a string from the List. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampList_8c_33ca96ee3a8e7d26356c7b66f469da74}{samp\_\-getMapFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a Map from the List. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampList_8c_1ec1ddadb4e889792b6fa7df6f6c3125}{samp\_\-getListFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a List from the List. \item\end{CompactList}\item +\hypertarget{sampList_8c_1174e001b2d16ed0aa1b317cfc883af1}{ +int \textbf{samp\_\-getIntFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index)} +\label{sampList_8c_1174e001b2d16ed0aa1b317cfc883af1} + +\item +float \hyperlink{sampList_8c_4e8339b2b3f5ff1a58cebb74eddca9e6}{samp\_\-getFloatFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a Float from the List. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +(Internal) interface to support the List structure. + +SAMPLIST.C -- (Internal) interface to support the List structure. + +list = samp\_\-newList () samp\_\-freeList (List list) len = samp\_\-listLen (List list) + +samp\_\-setStringInList (List list, char $\ast$value) samp\_\-setMapInList (List list, Map map) samp\_\-setListInList (List list1, List list2) samp\_\-setIntInList (List list, int val) samp\_\-setFloatInList (List list, float val) + +str = samp\_\-getStringFromList (List list, int index) map = samp\_\-getMapFromList (List list, int index) list = samp\_\-getListFromList (List list, int index) ival = samp\_\-getIntFromList (List list, int index) rval = samp\_\-getFloatFromList (List list, int index) + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/09 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampList_8c_b162ae9b9f98da80f6bb5c34b5cbcbf6}{ +\index{sampList.c@{sampList.c}!samp\_\-freeList@{samp\_\-freeList}} +\index{samp\_\-freeList@{samp\_\-freeList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-freeList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeList ({\bf List} {\em list})}} +\label{sampList_8c_b162ae9b9f98da80f6bb5c34b5cbcbf6} + + +Free the given List object. + +SAMP\_\-FREELIST -- Free the given List object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-mapClients(), and samp\_\-tableSelectRowList().\hypertarget{sampList_8c_4e8339b2b3f5ff1a58cebb74eddca9e6}{ +\index{sampList.c@{sampList.c}!samp\_\-getFloatFromList@{samp\_\-getFloatFromList}} +\index{samp\_\-getFloatFromList@{samp\_\-getFloatFromList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-getFloatFromList}]{\setlength{\rightskip}{0pt plus 5cm}float samp\_\-getFloatFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{sampList_8c_4e8339b2b3f5ff1a58cebb74eddca9e6} + + +Get a Float from the List. + +SAMP\_\-GETFLOATFROMLIST -- Get a Float from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the desired value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]int value \end{Desc} +\hypertarget{sampList_8c_1ec1ddadb4e889792b6fa7df6f6c3125}{ +\index{sampList.c@{sampList.c}!samp\_\-getListFromList@{samp\_\-getListFromList}} +\index{samp\_\-getListFromList@{samp\_\-getListFromList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-getListFromList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-getListFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{sampList_8c_1ec1ddadb4e889792b6fa7df6f6c3125} + + +Get a List from the List. + +Get an Int from the List. + +SAMP\_\-GETLISTFROMLIST -- Get a List from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the List \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]List handle\end{Desc} +SAMP\_\-GETINTFROMLIST -- Get an Int from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the desired value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]int value \end{Desc} +\hypertarget{sampList_8c_33ca96ee3a8e7d26356c7b66f469da74}{ +\index{sampList.c@{sampList.c}!samp\_\-getMapFromList@{samp\_\-getMapFromList}} +\index{samp\_\-getMapFromList@{samp\_\-getMapFromList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-getMapFromList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getMapFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{sampList_8c_33ca96ee3a8e7d26356c7b66f469da74} + + +Get a Map from the List. + +SAMP\_\-GETMAPFROMLIST -- Get a Map from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the Map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]Map handle \end{Desc} +\hypertarget{sampList_8c_2d1cd41c4583ac300aaa2d50ad3f76ed}{ +\index{sampList.c@{sampList.c}!samp\_\-getStringFromList@{samp\_\-getStringFromList}} +\index{samp\_\-getStringFromList@{samp\_\-getStringFromList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-getStringFromList}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-getStringFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{sampList_8c_2d1cd41c4583ac300aaa2d50ad3f76ed} + + +Get a string from the List. + +SAMP\_\-GETSTRINGFROMLIST -- Get a string from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]character string \end{Desc} + + +Referenced by samp\_\-mapClients().\hypertarget{sampList_8c_c260afb0cbf19b427e3eba96a2341e52}{ +\index{sampList.c@{sampList.c}!samp\_\-listLen@{samp\_\-listLen}} +\index{samp\_\-listLen@{samp\_\-listLen}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-listLen}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-listLen ({\bf List} {\em list})}} +\label{sampList_8c_c260afb0cbf19b427e3eba96a2341e52} + + +Get number of elements in a List. + +SAMP\_\-LISTLEN -- Get number of elements in a List. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-execUserHandler(), samp\_\-GetRegisteredClients(), samp\_\-GetSubscribedClients(), samp\_\-mapClients(), and samp\_\-tbSelectHandler().\hypertarget{sampList_8c_b5375a6478dccefe7df2b48416604b29}{ +\index{sampList.c@{sampList.c}!samp\_\-newList@{samp\_\-newList}} +\index{samp\_\-newList@{samp\_\-newList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-newList}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t samp\_\-newList (void)}} +\label{sampList_8c_b5375a6478dccefe7df2b48416604b29} + + +Create a new List object. + +SAMP\_\-NEWLIST -- Create a new List object + +\begin{Desc} +\item[Returns:]handle to List object \end{Desc} + + +Referenced by samp\_\-GetRegisteredClients(), samp\_\-GetSubscribedClients(), samp\_\-tableSelectRowList(), and sampInit().\hypertarget{sampList_8c_18d586491620a63b3a4d6c3667ee2aa5}{ +\index{sampList.c@{sampList.c}!samp\_\-setFloatInList@{samp\_\-setFloatInList}} +\index{samp\_\-setFloatInList@{samp\_\-setFloatInList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-setFloatInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setFloatInList ({\bf List} {\em list}, \/ float {\em rval})}} +\label{sampList_8c_18d586491620a63b3a4d6c3667ee2aa5} + + +Set a Float in a List (append). + +SAMP\_\-SETFLOATINLIST -- Set a Float in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list1}]List object handle \item[{\em rval}]Float value to be appended \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampList_8c_a803bead8b452de6e1d08b8b3b9e8828}{ +\index{sampList.c@{sampList.c}!samp\_\-setIntInList@{samp\_\-setIntInList}} +\index{samp\_\-setIntInList@{samp\_\-setIntInList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-setIntInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setIntInList ({\bf List} {\em list}, \/ int {\em ival})}} +\label{sampList_8c_a803bead8b452de6e1d08b8b3b9e8828} + + +Set an Int in a List (append). + +SAMP\_\-SETINTINLIST -- Set an Int in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list1}]List object handle \item[{\em ival}]Integer value to be appended \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-tableSelectRowList().\hypertarget{sampList_8c_0ff97d44e62b7c88a046a29324552400}{ +\index{sampList.c@{sampList.c}!samp\_\-setListInList@{samp\_\-setListInList}} +\index{samp\_\-setListInList@{samp\_\-setListInList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-setListInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setListInList ({\bf List} {\em list1}, \/ {\bf List} {\em list2})}} +\label{sampList_8c_0ff97d44e62b7c88a046a29324552400} + + +Set a List in another List (append). + +SAMP\_\-SETLISTINLIST -- Set a List in another List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list1}]List object handle \item[{\em list2}]List to be appended \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampList_8c_ea188bb711f3b5549d11204b0ff2da08}{ +\index{sampList.c@{sampList.c}!samp\_\-setMapInList@{samp\_\-setMapInList}} +\index{samp\_\-setMapInList@{samp\_\-setMapInList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-setMapInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setMapInList ({\bf List} {\em list}, \/ {\bf Map} {\em map})}} +\label{sampList_8c_ea188bb711f3b5549d11204b0ff2da08} + + +Set a Map in a List (append). + +SAMP\_\-SETMAPINLIST -- Set a Map in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em map}]Map object to be set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampList_8c_5b69180b036e58528c98b1cf5a42825a}{ +\index{sampList.c@{sampList.c}!samp\_\-setStringInList@{samp\_\-setStringInList}} +\index{samp\_\-setStringInList@{samp\_\-setStringInList}!sampList.c@{sampList.c}} +\subsubsection[{samp\_\-setStringInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setStringInList ({\bf List} {\em list}, \/ char $\ast$ {\em value})}} +\label{sampList_8c_5b69180b036e58528c98b1cf5a42825a} + + +Set a string in a List (append). + +SAMP\_\-SETSTRINGINLIST -- Set a string in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em value}]string value to set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-GetRegisteredClients(), and samp\_\-GetSubscribedClients().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampLog_8c.tex b/vendor/voclient/libsamp/doc/latex/sampLog_8c.tex new file mode 100644 index 00000000..f52c3ab3 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampLog_8c.tex @@ -0,0 +1,109 @@ +\hypertarget{sampLog_8c}{ +\section{sampLog.c File Reference} +\label{sampLog_8c}\index{sampLog.c@{sampLog.c}} +} +SAMP trace and logging interface. + + +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$fcntl.h$>$}\par +{\tt \#include $<$signal.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include $<$stdarg.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Defines} +\begin{CompactItemize} +\item +\hypertarget{sampLog_8c_7ca95aa869dee3c8acc0b1e278ec08be}{ +\#define \textbf{SZ\_\-FMTSPEC}~25} +\label{sampLog_8c_7ca95aa869dee3c8acc0b1e278ec08be} + +\item +\hypertarget{sampLog_8c_adbbc7b02d94a4c18646813ac8d7dec1}{ +\#define \textbf{EOS}~0} +\label{sampLog_8c_adbbc7b02d94a4c18646813ac8d7dec1} + +\item +\hypertarget{sampLog_8c_4fa28a492427bc4af75248e22537e9b4}{ +\#define \textbf{T\_\-INT}~0} +\label{sampLog_8c_4fa28a492427bc4af75248e22537e9b4} + +\item +\hypertarget{sampLog_8c_6e80924a839d0f80571bcd1d2b6ec084}{ +\#define \textbf{T\_\-DOUBLE}~1} +\label{sampLog_8c_6e80924a839d0f80571bcd1d2b6ec084} + +\item +\hypertarget{sampLog_8c_e2381f297a8fbb736886d7d1b6b99b42}{ +\#define \textbf{T\_\-CHAR}~2} +\label{sampLog_8c_e2381f297a8fbb736886d7d1b6b99b42} + +\end{CompactItemize} +\subsection*{Functions} +\begin{CompactItemize} +\item +void \hyperlink{sampLog_8c_4919f892b6fccced4e6b9d777071b781}{sampLog} (handle\_\-t handle, char $\ast$format,...) +\begin{CompactList}\small\item\em SAMP message logger. \item\end{CompactList}\item +void \hyperlink{sampLog_8c_2b3dd1662e61c83e29109126689b08b9}{sampTrace} (handle\_\-t handle, char $\ast$format,...) +\begin{CompactList}\small\item\em SAMP tracer. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +SAMP trace and logging interface. + +SAMPLOG.C -- SAMP trace and logging interface. + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]6/10/09 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampLog_8c_4919f892b6fccced4e6b9d777071b781}{ +\index{sampLog.c@{sampLog.c}!sampLog@{sampLog}} +\index{sampLog@{sampLog}!sampLog.c@{sampLog.c}} +\subsubsection[{sampLog}]{\setlength{\rightskip}{0pt plus 5cm}void sampLog (handle\_\-t {\em handle}, \/ char $\ast$ {\em format}, \/ {\em ...})}} +\label{sampLog_8c_4919f892b6fccced4e6b9d777071b781} + + +SAMP message logger. + +SAMPLOG -- SAMP message logger. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]SAMP handle \item[{\em format}]message format string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::debug, and Samp::logfd.\hypertarget{sampLog_8c_2b3dd1662e61c83e29109126689b08b9}{ +\index{sampLog.c@{sampLog.c}!sampTrace@{sampTrace}} +\index{sampTrace@{sampTrace}!sampLog.c@{sampLog.c}} +\subsubsection[{sampTrace}]{\setlength{\rightskip}{0pt plus 5cm}void sampTrace (handle\_\-t {\em handle}, \/ char $\ast$ {\em format}, \/ {\em ...})}} +\label{sampLog_8c_2b3dd1662e61c83e29109126689b08b9} + + +SAMP tracer. + +SAMPTRACE -- SAMP tracer. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]SAMP handle \item[{\em format}]message format string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::trace. + +Referenced by samp\_\-Metadata(), sampClose(), and sampInit().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampMTypes_8c.tex b/vendor/voclient/libsamp/doc/latex/sampMTypes_8c.tex new file mode 100644 index 00000000..87bc9119 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampMTypes_8c.tex @@ -0,0 +1,396 @@ +\hypertarget{sampMTypes_8c}{ +\section{sampMTypes.c File Reference} +\label{sampMTypes_8c}\index{sampMTypes.c@{sampMTypes.c}} +} +SAMP interface procedures for application mtypes. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include $<$time.h$>$}\par +{\tt \#include $<$ctype.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +int \hyperlink{sampMTypes_8c_34e9d38073f36daaf41c418f8d680ee5}{samp\_\-tableLoadVOTable} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Tell an app to load a VOTable. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_74aeaaf742121348390ec854c30c1479}{samp\_\-tableLoadFITS} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Tell an app to load a FITS table. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_e38ac987f1dfd87ad64f97d55396270e}{samp\_\-tableHighlightRow} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, int row) +\begin{CompactList}\small\item\em Tell an app to highlight a table row. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_f133efb67fe4bcfd2b9c8ab9d23b4c5e}{samp\_\-tableSelectRowList} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, int rows\mbox{[}$\,$\mbox{]}, int nrows) +\begin{CompactList}\small\item\em Tell an app to select a list of table rows. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_4812b571ed87f7842ca20b7024770df3}{samp\_\-imageLoadFITS} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} imageId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Tell an app to load a FITS image. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_e1e86e79d9a1768e5f265cbb44279172}{samp\_\-coordPointAtSky} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, float ra, float dec) +\begin{CompactList}\small\item\em Tell an app to point at an RA/Dec coordinate. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_18b351385bd175581a6788a4f7342f07}{samp\_\-specLoadSSAGeneric} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} meta, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} spectrumId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Load a generic spectrum from an SSA service. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_5900317c1609ddd5b6da70dc0eb2040c}{samp\_\-cmdExec} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} cmd) +\begin{CompactList}\small\item\em Execute a command in a remote application. \item\end{CompactList}\item +char $\ast$ \hyperlink{sampMTypes_8c_9c64fef9c158d7fd4ff7f72691ccd319}{samp\_\-envGet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Get an environment variable in a remote application. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_ded4b8bdac87c5b6faa7f13d8abb22a1}{samp\_\-envSet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} value) +\begin{CompactList}\small\item\em Set an environment variable in a remote application. \item\end{CompactList}\item +char $\ast$ \hyperlink{sampMTypes_8c_19b75403d63714c4fccc8a8d4fa4c8cf}{samp\_\-paramGet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Get a parameter variable in a remote application. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_535cb6760c733a75746d2f104b1a01be}{samp\_\-paramSet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} value) +\begin{CompactList}\small\item\em Set an parameter variable in a remote application. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_ae7f51c1f6169b918568a1202d0fa031}{samp\_\-bibLoad} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} bibcode) +\begin{CompactList}\small\item\em Exchange a bibcode. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_8013c549ef47e0507edf39c8ab1b62aa}{samp\_\-resourceLoad} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} type, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resMap) +\begin{CompactList}\small\item\em Exchange a resource list. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_b2ff2e029c57b56ad57416c624341fe6}{samp\_\-sendGeneric} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} args\mbox{[}$\,$\mbox{]}) +\begin{CompactList}\small\item\em Send a geenric message. \item\end{CompactList}\item +int \hyperlink{sampMTypes_8c_80ef1a82845b96091857c7d4a3c7972c}{samp\_\-sendMsg} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Send the specified message. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +SAMP interface procedures for application mtypes. + +SAMPMTYPES.C -- SAMP interface procedures for application mtypes. + +samp\_\-tableLoadVOTable (handle, recip, url, tableId, name) samp\_\-tableLoadFITS (handle, recip, url, tableId, name) samp\_\-tableHighlightRow (handle, recip, tableId, url, row) samp\_\-tableSelectRowList (handle, recip, tableId, url, rows\mbox{[}\mbox{]}, nrows) + +samp\_\-imageLoadFITS (handle, recip, url, imageId, name) samp\_\-coordPointAtSky (handle, recip, ra, dec) + +samp\_\-specLoadSSAGeneric (handle, recip, url, meta\_\-map, specId, name) samp\_\-cmdExec (handle, recip, cmd) samp\_\-envGet (handle, recip, name) samp\_\-envSet (handle, recip, name, value) samp\_\-paramGet (handle, recip, name) samp\_\-paramSet (handle, recip, name, value) samp\_\-bibLoad (handle, recip, bibcode) samp\_\-resourceLoad (handle, recip, type, resList\mbox{[}\mbox{]}) + +samp\_\-sendGeneric (handle, recip, mtype, args) samp\_\-sendMsg (handle, recip, Map msg\_\-map) + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/18/11 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampMTypes_8c_ae7f51c1f6169b918568a1202d0fa031}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-bibLoad@{samp\_\-bibLoad}} +\index{samp\_\-bibLoad@{samp\_\-bibLoad}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-bibLoad}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-bibLoad (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em bibcode})}} +\label{sampMTypes_8c_ae7f51c1f6169b918568a1202d0fa031} + + +Exchange a bibcode. + +SAMP\_\-BIBLOAD -- Exchange a bibcode. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em bibcode}]Bibcode string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_5900317c1609ddd5b6da70dc0eb2040c}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-cmdExec@{samp\_\-cmdExec}} +\index{samp\_\-cmdExec@{samp\_\-cmdExec}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-cmdExec}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-cmdExec (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em cmd})}} +\label{sampMTypes_8c_5900317c1609ddd5b6da70dc0eb2040c} + + +Execute a command in a remote application. + +SAMP\_\-CMDEXEC -- Execute a command in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em cmd}]Command string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_e1e86e79d9a1768e5f265cbb44279172}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-coordPointAtSky@{samp\_\-coordPointAtSky}} +\index{samp\_\-coordPointAtSky@{samp\_\-coordPointAtSky}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-coordPointAtSky}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-coordPointAtSky (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ float {\em ra}, \/ float {\em dec})}} +\label{sampMTypes_8c_e1e86e79d9a1768e5f265cbb44279172} + + +Tell an app to point at an RA/Dec coordinate. + +SAMP\_\-COORDPOINTATSKY -- Tell an app to point at an RA/Dec coordinate. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em ra}]RA of coord in degrees \item[{\em dec}]Dec of coord in degrees \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addFloatParam(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_9c64fef9c158d7fd4ff7f72691ccd319}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-envGet@{samp\_\-envGet}} +\index{samp\_\-envGet@{samp\_\-envGet}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-envGet}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-envGet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name})}} +\label{sampMTypes_8c_9c64fef9c158d7fd4ff7f72691ccd319} + + +Get an environment variable in a remote application. + +SAMP\_\-ENVGET -- Get an environment variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]NULL, Value of variable, or list of values \end{Desc} + + +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.\hypertarget{sampMTypes_8c_ded4b8bdac87c5b6faa7f13d8abb22a1}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-envSet@{samp\_\-envSet}} +\index{samp\_\-envSet@{samp\_\-envSet}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-envSet}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-envSet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name}, \/ {\bf String} {\em value})}} +\label{sampMTypes_8c_ded4b8bdac87c5b6faa7f13d8abb22a1} + + +Set an environment variable in a remote application. + +SAMP\_\-ENVSET -- Set an environment variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \item[{\em value}]Value of variable or NULL \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_4812b571ed87f7842ca20b7024770df3}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-imageLoadFITS@{samp\_\-imageLoadFITS}} +\index{samp\_\-imageLoadFITS@{samp\_\-imageLoadFITS}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-imageLoadFITS}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-imageLoadFITS (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf String} {\em imageId}, \/ {\bf String} {\em name})}} +\label{sampMTypes_8c_4812b571ed87f7842ca20b7024770df3} + + +Tell an app to load a FITS image. + +SAMP\_\-IMAGELOADFITS -- Tell an app to load a FITS image. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em url}]URL to table to be loaded \item[{\em imageId}]ID assigned to image (optional) \item[{\em name}]Name assigned to image (optional) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_19b75403d63714c4fccc8a8d4fa4c8cf}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-paramGet@{samp\_\-paramGet}} +\index{samp\_\-paramGet@{samp\_\-paramGet}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-paramGet}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-paramGet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name})}} +\label{sampMTypes_8c_19b75403d63714c4fccc8a8d4fa4c8cf} + + +Get a parameter variable in a remote application. + +SAMP\_\-PARAMGET -- Get a parameter variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]NULL, Value of variable, or list of values \end{Desc} + + +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.\hypertarget{sampMTypes_8c_535cb6760c733a75746d2f104b1a01be}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-paramSet@{samp\_\-paramSet}} +\index{samp\_\-paramSet@{samp\_\-paramSet}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-paramSet}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramSet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name}, \/ {\bf String} {\em value})}} +\label{sampMTypes_8c_535cb6760c733a75746d2f104b1a01be} + + +Set an parameter variable in a remote application. + +SAMP\_\-PARAMSET -- Set an parameter variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \item[{\em value}]Value of variable or NULL \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_8013c549ef47e0507edf39c8ab1b62aa}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-resourceLoad@{samp\_\-resourceLoad}} +\index{samp\_\-resourceLoad@{samp\_\-resourceLoad}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-resourceLoad}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resourceLoad (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em type}, \/ {\bf String} {\em name}, \/ {\bf Map} {\em resMap})}} +\label{sampMTypes_8c_8013c549ef47e0507edf39c8ab1b62aa} + + +Exchange a resource list. + +SAMP\_\-RESOURCELOAD -- Exchange a resource list. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Name of recipient (or 'all') \item[{\em type}]Resource type (or NULL) \item[{\em name}]Descriptive name (optional) \item[{\em resMap}]Resource map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addMapParam(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), samp\_\-sendMsg(), and SZ\_\-NAME.\hypertarget{sampMTypes_8c_b2ff2e029c57b56ad57416c624341fe6}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-sendGeneric@{samp\_\-sendGeneric}} +\index{samp\_\-sendGeneric@{samp\_\-sendGeneric}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-sendGeneric}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-sendGeneric (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em args}\mbox{[}$\,$\mbox{]})}} +\label{sampMTypes_8c_b2ff2e029c57b56ad57416c624341fe6} + + +Send a geenric message. + +SAMP\_\-SENDGENERIC -- Send a generic message. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Name of recipient (or 'all') \item[{\em mtype}]Message type \item[{\em args}]Argument list \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR\end{Desc} +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.\hypertarget{sampMTypes_8c_80ef1a82845b96091857c7d4a3c7972c}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-sendMsg@{samp\_\-sendMsg}} +\index{samp\_\-sendMsg@{samp\_\-sendMsg}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-sendMsg}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-sendMsg (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf Map} {\em msg})}} +\label{sampMTypes_8c_80ef1a82845b96091857c7d4a3c7972c} + + +Send the specified message. + +SAMP\_\-SENDMSG -- Send the specified message. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Name of recipient (or 'all') \item[{\em msg}]Message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::clients, Samp::msgMode, Samp::nclients, samp\_\-app2id(), samp\_\-call(), samp\_\-callAll(), samp\_\-callAndWait(), samp\_\-notify(), samp\_\-notifyAll(), and samp\_\-setErr(). + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramSet(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().\hypertarget{sampMTypes_8c_18b351385bd175581a6788a4f7342f07}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-specLoadSSAGeneric@{samp\_\-specLoadSSAGeneric}} +\index{samp\_\-specLoadSSAGeneric@{samp\_\-specLoadSSAGeneric}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-specLoadSSAGeneric}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-specLoadSSAGeneric (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf Map} {\em meta}, \/ {\bf String} {\em spectrumId}, \/ {\bf String} {\em name})}} +\label{sampMTypes_8c_18b351385bd175581a6788a4f7342f07} + + +Load a generic spectrum from an SSA service. + +SAMP\_\-SPECLOADSSAGENERIC -- Load a generic spectrum from an SSA service. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em url}]URL of spectrum to load \item[{\em meta}]Metadata map describing data found at the URL \item[{\em spectrumId}]Identifier for spectrum (optional) \item[{\em name}]Name used to label spectrum (optional); \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addMapParam(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_e38ac987f1dfd87ad64f97d55396270e}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-tableHighlightRow@{samp\_\-tableHighlightRow}} +\index{samp\_\-tableHighlightRow@{samp\_\-tableHighlightRow}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-tableHighlightRow}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tableHighlightRow (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em url}, \/ int {\em row})}} +\label{sampMTypes_8c_e38ac987f1dfd87ad64f97d55396270e} + + +Tell an app to highlight a table row. + +SAMP\_\-TABLEHIGHLIGHTROW -- Tell an app to highlight a table row. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em tableId}]ID associated with a previously loaded table \item[{\em url}]URL to table to be loaded \item[{\em rows}]List of (zero-based) row indices \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addIntParam(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_74aeaaf742121348390ec854c30c1479}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-tableLoadFITS@{samp\_\-tableLoadFITS}} +\index{samp\_\-tableLoadFITS@{samp\_\-tableLoadFITS}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-tableLoadFITS}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tableLoadFITS (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em name})}} +\label{sampMTypes_8c_74aeaaf742121348390ec854c30c1479} + + +Tell an app to load a FITS table. + +SAMP\_\-TABLELOADFITS -- Tell an app to load a FITS table. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em url}]URL to table to be loaded \item[{\em tableId}]ID assigned to table (optional) \item[{\em name}]Name assigned to table (optional) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_34e9d38073f36daaf41c418f8d680ee5}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-tableLoadVOTable@{samp\_\-tableLoadVOTable}} +\index{samp\_\-tableLoadVOTable@{samp\_\-tableLoadVOTable}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-tableLoadVOTable}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tableLoadVOTable (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em name})}} +\label{sampMTypes_8c_34e9d38073f36daaf41c418f8d680ee5} + + +Tell an app to load a VOTable. + +SAMP\_\-TABLELOADVOTABLE -- Tell an app to load a VOTable. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em url}]URL to table to be loaded \item[{\em tableId}]ID assigned to table (optional) \item[{\em name}]Name assigned to table (optional) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newMsg(), samp\_\-newParam(), and samp\_\-sendMsg().\hypertarget{sampMTypes_8c_f133efb67fe4bcfd2b9c8ab9d23b4c5e}{ +\index{sampMTypes.c@{sampMTypes.c}!samp\_\-tableSelectRowList@{samp\_\-tableSelectRowList}} +\index{samp\_\-tableSelectRowList@{samp\_\-tableSelectRowList}!sampMTypes.c@{sampMTypes.c}} +\subsubsection[{samp\_\-tableSelectRowList}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tableSelectRowList (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em url}, \/ int {\em rows}\mbox{[}$\,$\mbox{]}, \/ int {\em nrows})}} +\label{sampMTypes_8c_f133efb67fe4bcfd2b9c8ab9d23b4c5e} + + +Tell an app to select a list of table rows. + +SAMP\_\-TABLESELECTROWLIST -- Tell an app to select a list of table rows. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em tableId}]ID associated with a previously loaded table \item[{\em url}]URL to table to be loaded \item[{\em rows}]Array of (zero-based) row indices \item[{\em nrows}]Number of rows \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +References Samp::hub, hub, samp\_\-addListParam(), samp\_\-freeList(), samp\_\-freeMsg(), samp\_\-msgParam(), samp\_\-newList(), samp\_\-newMsg(), samp\_\-newParam(), samp\_\-sendMsg(), and samp\_\-setIntInList().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampMap_8c.tex b/vendor/voclient/libsamp/doc/latex/sampMap_8c.tex new file mode 100644 index 00000000..70208745 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampMap_8c.tex @@ -0,0 +1,308 @@ +\hypertarget{sampMap_8c}{ +\section{sampMap.c File Reference} +\label{sampMap_8c}\index{sampMap.c@{sampMap.c}} +} +(Internal) Interface to support the Map structure + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +handle\_\-t \hyperlink{sampMap_8c_9985b96289047cafc24f2adbfeed977f}{samp\_\-newMap} () +\begin{CompactList}\small\item\em Create a new Map object. \item\end{CompactList}\item +void \hyperlink{sampMap_8c_fe80438de542c6657d623993360b37d1}{samp\_\-freeMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\begin{CompactList}\small\item\em Free the given Map object. \item\end{CompactList}\item +\hypertarget{sampMap_8c_1c99f7146ad3acd3e381a02d5df1234f}{ +int \textbf{samp\_\-getMapSize} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map)} +\label{sampMap_8c_1c99f7146ad3acd3e381a02d5df1234f} + +\item +\hypertarget{sampMap_8c_4c8a1b402743b52f2837e97cf41e9e34}{ +char $\ast$ \textbf{samp\_\-getMapKey} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, int index)} +\label{sampMap_8c_4c8a1b402743b52f2837e97cf41e9e34} + +\item +\hypertarget{sampMap_8c_7dcdf07dd7f3252f3bf2dd5002c62251}{ +char $\ast$ \textbf{samp\_\-getMapVal} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, int index)} +\label{sampMap_8c_7dcdf07dd7f3252f3bf2dd5002c62251} + +\item +void \hyperlink{sampMap_8c_b9b2157de89369eb5cd95bfe804eb89a}{samp\_\-setStringInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, char $\ast$value) +\begin{CompactList}\small\item\em Set a string in a Map (append). \item\end{CompactList}\item +void \hyperlink{sampMap_8c_f102490efe1b92d99b67f244dc498c7b}{samp\_\-setMapInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map1, char $\ast$key, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map2) +\begin{CompactList}\small\item\em Set a Map in a Map (append). \item\end{CompactList}\item +void \hyperlink{sampMap_8c_362c2f670c98dd6a3ef69debd1871604}{samp\_\-setListInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list) +\begin{CompactList}\small\item\em Set a List in a Map (append). \item\end{CompactList}\item +void \hyperlink{sampMap_8c_c22ec42dbf9a01c9b4e00cf011e7eb9d}{samp\_\-setIntInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, int value) +\begin{CompactList}\small\item\em Set a Int in a Map (append). \item\end{CompactList}\item +void \hyperlink{sampMap_8c_0f07ae542f5b317311b3799bd96a88fd}{samp\_\-setFloatInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, float value) +\begin{CompactList}\small\item\em Set a string in a Map (append). \item\end{CompactList}\item +char $\ast$ \hyperlink{sampMap_8c_96ca606e0e7da659c3dc0a30846bcd66}{samp\_\-getStringFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a string from the Map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampMap_8c_525e8ffdfa32867f392f2c1340215453}{samp\_\-getMapFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a Map from the Map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampMap_8c_31ddb90cf2184ae0151b9e7ec8c1a51f}{samp\_\-getListFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a LIST from the Map. \item\end{CompactList}\item +int \hyperlink{sampMap_8c_210fc0eba30abddf1bdc2e780d58072c}{samp\_\-getIntFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a integer from the Map. \item\end{CompactList}\item +float \hyperlink{sampMap_8c_b0d3768990294554a298c4057b3b315d}{samp\_\-getFloatFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a float from the Map. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +(Internal) Interface to support the Map structure + +SAMPMAP.C -- (Internal) Interface to support the Map structure + +map = samp\_\-newMap () samp\_\-freeMap (Map map) + +nelem = samp\_\-getMapSize (Map map) key = samp\_\-getMapKey (Map map, int index) val = samp\_\-getMapVal (Map map, int index) + +samp\_\-setStringInMap (Map map, char $\ast$value) samp\_\-setMapInMap (Map map1, Map map2) samp\_\-setListInMap (Map map, List list) samp\_\-setIntInMap (Map map, int ival) samp\_\-setFloatInMap (Map map, float rval) + +str = samp\_\-getStringFromMap (Map map, char $\ast$key) map = samp\_\-getMapFromMap (Map map, char $\ast$key) list = samp\_\-getListFromMap (Map map, char $\ast$key) ival = samp\_\-getIntFromMap (Map map, char $\ast$key) rval = samp\_\-getFloatFromMap (Map map, char $\ast$key) + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/09 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampMap_8c_fe80438de542c6657d623993360b37d1}{ +\index{sampMap.c@{sampMap.c}!samp\_\-freeMap@{samp\_\-freeMap}} +\index{samp\_\-freeMap@{samp\_\-freeMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-freeMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeMap ({\bf Map} {\em map})}} +\label{sampMap_8c_fe80438de542c6657d623993360b37d1} + + +Free the given Map object. + +SAMP\_\-FREEMAP -- Free the given Map object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]Map object to free \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-envGetHandler(), samp\_\-hubDeclareSubscriptions(), samp\_\-paramGetHandler(), and samp\_\-Ping().\hypertarget{sampMap_8c_b0d3768990294554a298c4057b3b315d}{ +\index{sampMap.c@{sampMap.c}!samp\_\-getFloatFromMap@{samp\_\-getFloatFromMap}} +\index{samp\_\-getFloatFromMap@{samp\_\-getFloatFromMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-getFloatFromMap}]{\setlength{\rightskip}{0pt plus 5cm}float samp\_\-getFloatFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampMap_8c_b0d3768990294554a298c4057b3b315d} + + +Get a float from the Map. + +SAMP\_\-GETFLOATFROMMAP -- Get a float from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]floating point value \end{Desc} + + +Referenced by samp\_\-execUserHandler(), and samp\_\-pointAtHandler().\hypertarget{sampMap_8c_210fc0eba30abddf1bdc2e780d58072c}{ +\index{sampMap.c@{sampMap.c}!samp\_\-getIntFromMap@{samp\_\-getIntFromMap}} +\index{samp\_\-getIntFromMap@{samp\_\-getIntFromMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-getIntFromMap}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-getIntFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampMap_8c_210fc0eba30abddf1bdc2e780d58072c} + + +Get a integer from the Map. + +SAMP\_\-GETINTFROMMAP -- Get a integer from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]integer value \end{Desc} + + +Referenced by samp\_\-execUserHandler(), and samp\_\-tbHighlightHandler().\hypertarget{sampMap_8c_31ddb90cf2184ae0151b9e7ec8c1a51f}{ +\index{sampMap.c@{sampMap.c}!samp\_\-getListFromMap@{samp\_\-getListFromMap}} +\index{samp\_\-getListFromMap@{samp\_\-getListFromMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-getListFromMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-getListFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampMap_8c_31ddb90cf2184ae0151b9e7ec8c1a51f} + + +Get a LIST from the Map. + +SAMP\_\-GETLISTFROMMAP -- Get a LIST from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to List value \end{Desc} + + +Referenced by samp\_\-execUserHandler(), and samp\_\-tbSelectHandler().\hypertarget{sampMap_8c_525e8ffdfa32867f392f2c1340215453}{ +\index{sampMap.c@{sampMap.c}!samp\_\-getMapFromMap@{samp\_\-getMapFromMap}} +\index{samp\_\-getMapFromMap@{samp\_\-getMapFromMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-getMapFromMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getMapFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampMap_8c_525e8ffdfa32867f392f2c1340215453} + + +Get a Map from the Map. + +SAMP\_\-GETMAPFROMMAP -- Get a Map from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to Map value \end{Desc} + + +Referenced by samp\_\-execUserHandler(), samp\_\-resConeHandler(), samp\_\-resLoadHandler(), samp\_\-resSiapHandler(), samp\_\-resSsapHandler(), samp\_\-resTapHandler(), samp\_\-resVOSpaceHandler(), samp\_\-specLoadHandler(), and samp\_\-specSSAHandler().\hypertarget{sampMap_8c_96ca606e0e7da659c3dc0a30846bcd66}{ +\index{sampMap.c@{sampMap.c}!samp\_\-getStringFromMap@{samp\_\-getStringFromMap}} +\index{samp\_\-getStringFromMap@{samp\_\-getStringFromMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-getStringFromMap}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-getStringFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{sampMap_8c_96ca606e0e7da659c3dc0a30846bcd66} + + +Get a string from the Map. + +SAMP\_\-GETSTRINGFROMMAP -- Get a string from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]string value from Map \end{Desc} + + +Referenced by samp\_\-bibcodeHandler(), samp\_\-cmdExecHandler(), samp\_\-envGetHandler(), samp\_\-envSetHandler(), samp\_\-execUserHandler(), samp\_\-imLoadHandler(), samp\_\-paramGetHandler(), samp\_\-paramSetHandler(), samp\_\-resConeHandler(), samp\_\-resLoadHandler(), samp\_\-resSiapHandler(), samp\_\-resSsapHandler(), samp\_\-resTapHandler(), samp\_\-resVOSpaceHandler(), samp\_\-specLoadHandler(), samp\_\-specSSAHandler(), samp\_\-tbHighlightHandler(), samp\_\-tbLoadFITSHandler(), samp\_\-tbLoadHandler(), samp\_\-tbLoadVOTHandler(), and samp\_\-tbSelectHandler().\hypertarget{sampMap_8c_9985b96289047cafc24f2adbfeed977f}{ +\index{sampMap.c@{sampMap.c}!samp\_\-newMap@{samp\_\-newMap}} +\index{samp\_\-newMap@{samp\_\-newMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-newMap}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t samp\_\-newMap (void)}} +\label{sampMap_8c_9985b96289047cafc24f2adbfeed977f} + + +Create a new Map object. + +SAMP\_\-NEWMAP -- Create a new Map object + +\begin{Desc} +\item[Returns:]handle to new Map \end{Desc} + + +Referenced by samp\_\-envGetHandler(), samp\_\-getNullMap(), samp\_\-getOKMap(), samp\_\-paramGetHandler(), and sampInit().\hypertarget{sampMap_8c_0f07ae542f5b317311b3799bd96a88fd}{ +\index{sampMap.c@{sampMap.c}!samp\_\-setFloatInMap@{samp\_\-setFloatInMap}} +\index{samp\_\-setFloatInMap@{samp\_\-setFloatInMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-setFloatInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setFloatInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ float {\em value})}} +\label{sampMap_8c_0f07ae542f5b317311b3799bd96a88fd} + + +Set a string in a Map (append). + +SAMP\_\-SETFLOATINMAP -- Set a Float in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em value}]value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampMap_8c_c22ec42dbf9a01c9b4e00cf011e7eb9d}{ +\index{sampMap.c@{sampMap.c}!samp\_\-setIntInMap@{samp\_\-setIntInMap}} +\index{samp\_\-setIntInMap@{samp\_\-setIntInMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-setIntInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setIntInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ int {\em value})}} +\label{sampMap_8c_c22ec42dbf9a01c9b4e00cf011e7eb9d} + + +Set a Int in a Map (append). + +SAMP\_\-SETINTINMAP -- Set a Int in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em value}]value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampMap_8c_362c2f670c98dd6a3ef69debd1871604}{ +\index{sampMap.c@{sampMap.c}!samp\_\-setListInMap@{samp\_\-setListInMap}} +\index{samp\_\-setListInMap@{samp\_\-setListInMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-setListInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setListInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ {\bf List} {\em list})}} +\label{sampMap_8c_362c2f670c98dd6a3ef69debd1871604} + + +Set a List in a Map (append). + +SAMP\_\-SETLISTINMAP -- Set a List in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em list}]handle to List object to set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampMap_8c_f102490efe1b92d99b67f244dc498c7b}{ +\index{sampMap.c@{sampMap.c}!samp\_\-setMapInMap@{samp\_\-setMapInMap}} +\index{samp\_\-setMapInMap@{samp\_\-setMapInMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-setMapInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setMapInMap ({\bf Map} {\em map1}, \/ char $\ast$ {\em key}, \/ {\bf Map} {\em map2})}} +\label{sampMap_8c_f102490efe1b92d99b67f244dc498c7b} + + +Set a Map in a Map (append). + +SAMP\_\-SETMAPINMAP -- Set a Map in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map1}]handle to Map object \item[{\em key}]Map key \item[{\em map2}]handle to Map object to set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-envGetHandler(), samp\_\-getOKMap(), samp\_\-paramGetHandler(), and sampInit().\hypertarget{sampMap_8c_b9b2157de89369eb5cd95bfe804eb89a}{ +\index{sampMap.c@{sampMap.c}!samp\_\-setStringInMap@{samp\_\-setStringInMap}} +\index{samp\_\-setStringInMap@{samp\_\-setStringInMap}!sampMap.c@{sampMap.c}} +\subsubsection[{samp\_\-setStringInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setStringInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ char $\ast$ {\em value})}} +\label{sampMap_8c_b9b2157de89369eb5cd95bfe804eb89a} + + +Set a string in a Map (append). + +SAMP\_\-SETSTRINGINMAP -- Set a string in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em value}]Map value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-envGetHandler(), samp\_\-getOKMap(), samp\_\-paramGetHandler(), and sampInit().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampMethods_8c.tex b/vendor/voclient/libsamp/doc/latex/sampMethods_8c.tex new file mode 100644 index 00000000..e094f593 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampMethods_8c.tex @@ -0,0 +1,209 @@ +\hypertarget{sampMethods_8c}{ +\section{sampMethods.c File Reference} +\label{sampMethods_8c}\index{sampMethods.c@{sampMethods.c}} +} +SAMP methods implemented by a callable client. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include $<$time.h$>$}\par +{\tt \#include $<$ctype.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Defines} +\begin{CompactItemize} +\item +\hypertarget{sampMethods_8c_ee07de873e18503ecd72f89d07e4c628}{ +\#define \textbf{METH\_\-DBG}~(getenv(\char`\"{}METH\_\-DBG\char`\"{})!=NULL$|$$|$access(\char`\"{}/tmp/METH\_\-DBG\char`\"{},F\_\-OK)==0)} +\label{sampMethods_8c_ee07de873e18503ecd72f89d07e4c628} + +\item +\hypertarget{sampMethods_8c_ae51f9fc173a9cba2485f91d93fe8428}{ +\#define \textbf{OK\_\-Map}~samp\_\-getOKMap()} +\label{sampMethods_8c_ae51f9fc173a9cba2485f91d93fe8428} + +\end{CompactItemize} +\subsection*{Functions} +\begin{CompactItemize} +\item +int \hyperlink{sampMethods_8c_59f85e0fce4c9ae7121c98e137d3f743}{samp\_\-receiveCall} (void $\ast$data) +\begin{CompactList}\small\item\em test.echo method \item\end{CompactList}\item +int \hyperlink{sampMethods_8c_03be7cc9e154a6ccdd499286df640936}{samp\_\-receiveNotification} (void $\ast$data) +\begin{CompactList}\small\item\em receiveNotification () client method. \item\end{CompactList}\item +int \hyperlink{sampMethods_8c_754b50ad59145c7fd1e4c8f4277f11e4}{samp\_\-receiveResponse} (void $\ast$data) +\begin{CompactList}\small\item\em receiveResponse () client method. \item\end{CompactList}\item +void \hyperlink{sampMethods_8c_82fec51207e326e6373e174bb6855634}{samp\_\-setHandlerReply} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resp) +\begin{CompactList}\small\item\em Set the \hyperlink{structSamp}{Samp} Handler reply map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampMethods_8c_eebed5000d39977556e0bc330a020915}{samp\_\-getHandlerReply} () +\begin{CompactList}\small\item\em Get the \hyperlink{structSamp}{Samp} Handler reply map. \item\end{CompactList}\end{CompactItemize} +\subsection*{Variables} +\begin{CompactItemize} +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{sampMethods_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e}{nullMap} +\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{sampMethods_8c_a2106c7fe3a5747178c046238fbd5d55}{nullList} +\item +\hypertarget{sampMethods_8c_12abcaf1a16a8a7c2ef6358cdbf4d705}{ +\hyperlink{structSamp}{Samp} $\ast$ \textbf{sampP}} +\label{sampMethods_8c_12abcaf1a16a8a7c2ef6358cdbf4d705} + +\item +handle\_\-t \hyperlink{sampMethods_8c_b04b61ee02d86e15b02b861699ae7424}{sampH} +\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +SAMP methods implemented by a callable client. + +SAMPMETHODS.C -- SAMP methods implemented by a callable client. + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/09 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampMethods_8c_eebed5000d39977556e0bc330a020915}{ +\index{sampMethods.c@{sampMethods.c}!samp\_\-getHandlerReply@{samp\_\-getHandlerReply}} +\index{samp\_\-getHandlerReply@{samp\_\-getHandlerReply}!sampMethods.c@{sampMethods.c}} +\subsubsection[{samp\_\-getHandlerReply}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getHandlerReply (void)}} +\label{sampMethods_8c_eebed5000d39977556e0bc330a020915} + + +Get the \hyperlink{structSamp}{Samp} Handler reply map. + +SAMP\_\-GETHANDLERREPLY -- Get the \hyperlink{structSamp}{Samp} Handler reply map. + +\begin{Desc} +\item[Returns:]Map handle for reply map \end{Desc} + + +References nullMap, and OK\_\-Map. + +Referenced by samp\_\-receiveCall(), and samp\_\-receiveNotification().\hypertarget{sampMethods_8c_59f85e0fce4c9ae7121c98e137d3f743}{ +\index{sampMethods.c@{sampMethods.c}!samp\_\-receiveCall@{samp\_\-receiveCall}} +\index{samp\_\-receiveCall@{samp\_\-receiveCall}!sampMethods.c@{sampMethods.c}} +\subsubsection[{samp\_\-receiveCall}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-receiveCall (void $\ast$ {\em data})}} +\label{sampMethods_8c_59f85e0fce4c9ae7121c98e137d3f743} + + +test.echo method + +receiveCall () client method. + +SAMP\_\-TESTECHO -- test.echo method + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno\end{Desc} +SAMP\_\-RECEIVECALL -- receiveCall() client method. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno \end{Desc} + + +References Samp::defaultUserFunc, OK\_\-Map, samp\_\-execUserHandler(), samp\_\-getHandlerReply(), samp\_\-getSampHandler(), samp\_\-getUserHandler(), samp\_\-Reply(), sampH, and Samp::trace.\hypertarget{sampMethods_8c_03be7cc9e154a6ccdd499286df640936}{ +\index{sampMethods.c@{sampMethods.c}!samp\_\-receiveNotification@{samp\_\-receiveNotification}} +\index{samp\_\-receiveNotification@{samp\_\-receiveNotification}!sampMethods.c@{sampMethods.c}} +\subsubsection[{samp\_\-receiveNotification}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-receiveNotification (void $\ast$ {\em data})}} +\label{sampMethods_8c_03be7cc9e154a6ccdd499286df640936} + + +receiveNotification () client method. + +SAMP\_\-RECEIVENOTIFICATION -- receiveNotification() client method. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno \end{Desc} + + +References Samp::defaultUserFunc, OK\_\-Map, samp\_\-execUserHandler(), samp\_\-getHandlerReply(), samp\_\-getSampHandler(), samp\_\-getUserHandler(), samp\_\-processHubEvent(), and Samp::trace.\hypertarget{sampMethods_8c_754b50ad59145c7fd1e4c8f4277f11e4}{ +\index{sampMethods.c@{sampMethods.c}!samp\_\-receiveResponse@{samp\_\-receiveResponse}} +\index{samp\_\-receiveResponse@{samp\_\-receiveResponse}!sampMethods.c@{sampMethods.c}} +\subsubsection[{samp\_\-receiveResponse}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-receiveResponse (void $\ast$ {\em data})}} +\label{sampMethods_8c_754b50ad59145c7fd1e4c8f4277f11e4} + + +receiveResponse () client method. + +SAMP\_\-RECEIVERESPONSE -- receiveResponse() client method. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno \end{Desc} + + +References Samp::defaultUserFunc, OK\_\-Map, samp\_\-execUserHandler(), and Samp::trace.\hypertarget{sampMethods_8c_82fec51207e326e6373e174bb6855634}{ +\index{sampMethods.c@{sampMethods.c}!samp\_\-setHandlerReply@{samp\_\-setHandlerReply}} +\index{samp\_\-setHandlerReply@{samp\_\-setHandlerReply}!sampMethods.c@{sampMethods.c}} +\subsubsection[{samp\_\-setHandlerReply}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setHandlerReply ({\bf Map} {\em resp})}} +\label{sampMethods_8c_82fec51207e326e6373e174bb6855634} + + +Set the \hyperlink{structSamp}{Samp} Handler reply map. + +SAMP\_\-SETHANDLERREPLY -- Set the \hyperlink{structSamp}{Samp} Handler reply map. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em resp}]response map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-envGetHandler(), and samp\_\-paramGetHandler(). + +\subsection{Variable Documentation} +\hypertarget{sampMethods_8c_a2106c7fe3a5747178c046238fbd5d55}{ +\index{sampMethods.c@{sampMethods.c}!nullList@{nullList}} +\index{nullList@{nullList}!sampMethods.c@{sampMethods.c}} +\subsubsection[{nullList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} {\bf nullList}}} +\label{sampMethods_8c_a2106c7fe3a5747178c046238fbd5d55} + + +SAMP\_\-OK Map struct + +Referenced by sampInit().\hypertarget{sampMethods_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e}{ +\index{sampMethods.c@{sampMethods.c}!nullMap@{nullMap}} +\index{nullMap@{nullMap}!sampMethods.c@{sampMethods.c}} +\subsubsection[{nullMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} {\bf nullMap}}} +\label{sampMethods_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e} + + +SAMP handle + +Referenced by samp\_\-getHandlerReply(), samp\_\-getOKMap(), samp\_\-hubDeclareSubscriptions(), and sampInit().\hypertarget{sampMethods_8c_b04b61ee02d86e15b02b861699ae7424}{ +\index{sampMethods.c@{sampMethods.c}!sampH@{sampH}} +\index{sampH@{sampH}!sampMethods.c@{sampMethods.c}} +\subsubsection[{sampH}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t {\bf sampH}}} +\label{sampMethods_8c_b04b61ee02d86e15b02b861699ae7424} + + +SAMP struct pointer + +Referenced by samp\_\-processHubEvent(), samp\_\-receiveCall(), and sampInit().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampMsg_8c.tex b/vendor/voclient/libsamp/doc/latex/sampMsg_8c.tex new file mode 100644 index 00000000..51d4292b --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampMsg_8c.tex @@ -0,0 +1,105 @@ +\hypertarget{sampMsg_8c}{ +\section{sampMsg.c File Reference} +\label{sampMsg_8c}\index{sampMsg.c@{sampMsg.c}} +} +(Internal) Interface to Message objects. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} \hyperlink{sampMsg_8c_d6dfdab2715ea070713515754dd499dd}{samp\_\-newMsg} () +\begin{CompactList}\small\item\em Create a new Msg object. \item\end{CompactList}\item +void \hyperlink{sampMsg_8c_adf2979a5fad0c9a855740330b7fd9ce}{samp\_\-freeMsg} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg) +\begin{CompactList}\small\item\em Free the given Msg object. \item\end{CompactList}\item +\hypertarget{sampMsg_8c_34c9e29fa57216f19a70764df8e5826b}{ +void \textbf{samp\_\-msgMType} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype)} +\label{sampMsg_8c_34c9e29fa57216f19a70764df8e5826b} + +\item +\hypertarget{sampMsg_8c_b6887edd7c0924460bcee0282544c82f}{ +char $\ast$ \textbf{samp\_\-msgTag} ()} +\label{sampMsg_8c_b6887edd7c0924460bcee0282544c82f} + +\item +void \hyperlink{sampMsg_8c_281c8f7f8b21a74704dd200d5aaed481}{samp\_\-msgParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, \hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} param) +\begin{CompactList}\small\item\em Add a parameter to the Msg. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +(Internal) Interface to Message objects. + +SAMPMSG.C -- (Internal) Interface to Message objects. + +msg = samp\_\-newMsg () samp\_\-msgMType (Msg msg, String mtype) samp\_\-msgParam (Msg msg, Param param) samp\_\-msgTag () samp\_\-freeMsg (Msg msg) + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/11 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampMsg_8c_adf2979a5fad0c9a855740330b7fd9ce}{ +\index{sampMsg.c@{sampMsg.c}!samp\_\-freeMsg@{samp\_\-freeMsg}} +\index{samp\_\-freeMsg@{samp\_\-freeMsg}!sampMsg.c@{sampMsg.c}} +\subsubsection[{samp\_\-freeMsg}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeMsg ({\bf Msg} {\em msg})}} +\label{sampMsg_8c_adf2979a5fad0c9a855740330b7fd9ce} + + +Free the given Msg object. + +SAMP\_\-FREEMSG -- Free the given Msg object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]Msg object to free \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envGet(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Ping(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().\hypertarget{sampMsg_8c_281c8f7f8b21a74704dd200d5aaed481}{ +\index{sampMsg.c@{sampMsg.c}!samp\_\-msgParam@{samp\_\-msgParam}} +\index{samp\_\-msgParam@{samp\_\-msgParam}!sampMsg.c@{sampMsg.c}} +\subsubsection[{samp\_\-msgParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-msgParam ({\bf Msg} {\em msg}, \/ {\bf Param} {\em param})}} +\label{sampMsg_8c_281c8f7f8b21a74704dd200d5aaed481} + + +Add a parameter to the Msg. + +SAMP\_\-MSGPARAM -- Add a parameter to the Msg. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em param}]parameter map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envGet(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Ping(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().\hypertarget{sampMsg_8c_d6dfdab2715ea070713515754dd499dd}{ +\index{sampMsg.c@{sampMsg.c}!samp\_\-newMsg@{samp\_\-newMsg}} +\index{samp\_\-newMsg@{samp\_\-newMsg}!sampMsg.c@{sampMsg.c}} +\subsubsection[{samp\_\-newMsg}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Msg} samp\_\-newMsg (void)}} +\label{sampMsg_8c_d6dfdab2715ea070713515754dd499dd} + + +Create a new Msg object. + +SAMP\_\-NEWMSG -- Create a new Msg object + +\begin{Desc} +\item[Returns:]handle to new Msg \end{Desc} + + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envGet(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Ping(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/sampParam_8c.tex b/vendor/voclient/libsamp/doc/latex/sampParam_8c.tex new file mode 100644 index 00000000..b6eca42b --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampParam_8c.tex @@ -0,0 +1,215 @@ +\hypertarget{sampParam_8c}{ +\section{sampParam.c File Reference} +\label{sampParam_8c}\index{sampParam.c@{sampParam.c}} +} +(Internal) Interface to Param objects. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Functions} +\begin{CompactItemize} +\item +\hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} \hyperlink{sampParam_8c_8750d9db641826f700973dae3fcdc920}{samp\_\-newParam} () +\begin{CompactList}\small\item\em Create a new Param object. \item\end{CompactList}\item +void \hyperlink{sampParam_8c_5a6fbf3ac37164268afae80c35666c5e}{samp\_\-freeParam} (\hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} param) +\begin{CompactList}\small\item\em Free the given Msg object. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} \hyperlink{sampParam_8c_d8c5669be313874fef1c484643683f49}{samp\_\-paramInit} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg) +\begin{CompactList}\small\item\em Get number of Params. \item\end{CompactList}\item +\hypertarget{sampParam_8c_62c2d0b887252730fd6f7bdaa7211403}{ +void \textbf{samp\_\-addStringParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} val)} +\label{sampParam_8c_62c2d0b887252730fd6f7bdaa7211403} + +\item +void \hyperlink{sampParam_8c_e3e90c84dd6b1a08d8af18ca9e168b37}{samp\_\-addMapParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} val) +\begin{CompactList}\small\item\em Add a parameter to the Param. \item\end{CompactList}\item +void \hyperlink{sampParam_8c_24f72c4ed033ed2f219b420e491b3c0f}{samp\_\-addListParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} val) +\begin{CompactList}\small\item\em Add a parameter to the Param. \item\end{CompactList}\item +void \hyperlink{sampParam_8c_6897da75444209fc1819042bde906aa6}{samp\_\-addIntParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, int val) +\begin{CompactList}\small\item\em Add a $<$SAMP int$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. \item\end{CompactList}\item +void \hyperlink{sampParam_8c_d297770f4ab1338697d69b2705d6c1d9}{samp\_\-addFloatParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, float val) +\begin{CompactList}\small\item\em Add a $<$SAMP float$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. \item\end{CompactList}\item +int \hyperlink{sampParam_8c_7680995e5d4f26ea3d91bf72c9c72e51}{samp\_\-paramLen} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg) +\begin{CompactList}\small\item\em Get number of Params. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +(Internal) Interface to Param objects. + +SAMPPARAM.C -- (Internal) Interface to Param objects. + +param = samp\_\-newParam () samp\_\-freeParam (Param param) + +param = samp\_\-paramInit (Msg msg); samp\_\-addStringParam (Msg msg, char $\ast$keyw, String val) samp\_\-addListParam (Msg msg, char $\ast$keyw, List val) samp\_\-addMapParam (Msg msg, char $\ast$keyw, Map val) N = samp\_\-paramLen (Msg msg) + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/11 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampParam_8c_d297770f4ab1338697d69b2705d6c1d9}{ +\index{sampParam.c@{sampParam.c}!samp\_\-addFloatParam@{samp\_\-addFloatParam}} +\index{samp\_\-addFloatParam@{samp\_\-addFloatParam}!sampParam.c@{sampParam.c}} +\subsubsection[{samp\_\-addFloatParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addFloatParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ float {\em val})}} +\label{sampParam_8c_d297770f4ab1338697d69b2705d6c1d9} + + +Add a $<$SAMP float$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +SAMP\_\-ADDFLOATPARAM -- Add a $<$SAMP float$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]floating point value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References samp\_\-paramInit(). + +Referenced by samp\_\-coordPointAtSky(), and samp\_\-sendGeneric().\hypertarget{sampParam_8c_6897da75444209fc1819042bde906aa6}{ +\index{sampParam.c@{sampParam.c}!samp\_\-addIntParam@{samp\_\-addIntParam}} +\index{samp\_\-addIntParam@{samp\_\-addIntParam}!sampParam.c@{sampParam.c}} +\subsubsection[{samp\_\-addIntParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addIntParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ int {\em val})}} +\label{sampParam_8c_6897da75444209fc1819042bde906aa6} + + +Add a $<$SAMP int$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +SAMP\_\-ADDINTPARAM -- Add a $<$SAMP int$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]integer value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References samp\_\-paramInit(). + +Referenced by samp\_\-sendGeneric(), and samp\_\-tableHighlightRow().\hypertarget{sampParam_8c_24f72c4ed033ed2f219b420e491b3c0f}{ +\index{sampParam.c@{sampParam.c}!samp\_\-addListParam@{samp\_\-addListParam}} +\index{samp\_\-addListParam@{samp\_\-addListParam}!sampParam.c@{sampParam.c}} +\subsubsection[{samp\_\-addListParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addListParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ {\bf List} {\em val})}} +\label{sampParam_8c_24f72c4ed033ed2f219b420e491b3c0f} + + +Add a parameter to the Param. + +SAMP\_\-ADDLISTPARAM -- Add a List parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]value list \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References samp\_\-paramInit(). + +Referenced by samp\_\-tableSelectRowList().\hypertarget{sampParam_8c_e3e90c84dd6b1a08d8af18ca9e168b37}{ +\index{sampParam.c@{sampParam.c}!samp\_\-addMapParam@{samp\_\-addMapParam}} +\index{samp\_\-addMapParam@{samp\_\-addMapParam}!sampParam.c@{sampParam.c}} +\subsubsection[{samp\_\-addMapParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addMapParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ {\bf Map} {\em val})}} +\label{sampParam_8c_e3e90c84dd6b1a08d8af18ca9e168b37} + + +Add a parameter to the Param. + +SAMP\_\-ADDMAPPARAM -- Add a Map parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]value map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References samp\_\-paramInit(). + +Referenced by samp\_\-resourceLoad(), and samp\_\-specLoadSSAGeneric().\hypertarget{sampParam_8c_5a6fbf3ac37164268afae80c35666c5e}{ +\index{sampParam.c@{sampParam.c}!samp\_\-freeParam@{samp\_\-freeParam}} +\index{samp\_\-freeParam@{samp\_\-freeParam}!sampParam.c@{sampParam.c}} +\subsubsection[{samp\_\-freeParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeParam ({\bf Param} {\em param})}} +\label{sampParam_8c_5a6fbf3ac37164268afae80c35666c5e} + + +Free the given Msg object. + +SAMP\_\-FREEPARAM -- Free the given Param object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em param}]Param object to free \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{sampParam_8c_8750d9db641826f700973dae3fcdc920}{ +\index{sampParam.c@{sampParam.c}!samp\_\-newParam@{samp\_\-newParam}} +\index{samp\_\-newParam@{samp\_\-newParam}!sampParam.c@{sampParam.c}} +\subsubsection[{samp\_\-newParam}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Param} samp\_\-newParam (void)}} +\label{sampParam_8c_8750d9db641826f700973dae3fcdc920} + + +Create a new Param object. + +SAMP\_\-NEWPARAM -- Create a new Param object + +\begin{Desc} +\item[Returns:]handle to new Param \end{Desc} + + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envGet(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Ping(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().\hypertarget{sampParam_8c_d8c5669be313874fef1c484643683f49}{ +\index{sampParam.c@{sampParam.c}!samp\_\-paramInit@{samp\_\-paramInit}} +\index{samp\_\-paramInit@{samp\_\-paramInit}!sampParam.c@{sampParam.c}} +\subsubsection[{samp\_\-paramInit}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Param} samp\_\-paramInit ({\bf Msg} {\em msg})}} +\label{sampParam_8c_d8c5669be313874fef1c484643683f49} + + +Get number of Params. + +SAMP\_\-PARAMINIT -- Get number of Params. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-addFloatParam(), samp\_\-addIntParam(), samp\_\-addListParam(), and samp\_\-addMapParam().\hypertarget{sampParam_8c_7680995e5d4f26ea3d91bf72c9c72e51}{ +\index{sampParam.c@{sampParam.c}!samp\_\-paramLen@{samp\_\-paramLen}} +\index{samp\_\-paramLen@{samp\_\-paramLen}!sampParam.c@{sampParam.c}} +\subsubsection[{samp\_\-paramLen}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramLen ({\bf Msg} {\em msg})}} +\label{sampParam_8c_7680995e5d4f26ea3d91bf72c9c72e51} + + +Get number of Params. + +SAMP\_\-PARAMLEN -- Get number of Params. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} diff --git a/vendor/voclient/libsamp/doc/latex/sampUtil_8c.tex b/vendor/voclient/libsamp/doc/latex/sampUtil_8c.tex new file mode 100644 index 00000000..d97dea87 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/sampUtil_8c.tex @@ -0,0 +1,182 @@ +\hypertarget{sampUtil_8c}{ +\section{sampUtil.c File Reference} +\label{sampUtil_8c}\index{sampUtil.c@{sampUtil.c}} +} +Utility methods to convert struct pointers to user handles. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include $<$time.h$>$}\par +{\tt \#include $<$ctype.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Defines} +\begin{CompactItemize} +\item +\hypertarget{sampUtil_8c_23ed8e629c0a28eab14f92c888c8d7ef}{ +\#define \textbf{MAX\_\-HANDLES}~128} +\label{sampUtil_8c_23ed8e629c0a28eab14f92c888c8d7ef} + +\end{CompactItemize} +\subsection*{Functions} +\begin{CompactItemize} +\item +\hypertarget{sampUtil_8c_4d0aef2f09b9cce38d4ea8024831c6e5}{ +handle\_\-t \textbf{samp\_\-P2H} (void $\ast$ptr)} +\label{sampUtil_8c_4d0aef2f09b9cce38d4ea8024831c6e5} + +\item +\hypertarget{sampUtil_8c_909310a995650c224515c9ca0a3ef582}{ +void $\ast$ \textbf{samp\_\-H2P} (handle\_\-t handle)} +\label{sampUtil_8c_909310a995650c224515c9ca0a3ef582} + +\item +\hypertarget{sampUtil_8c_711aa545f55e9307f662062deefd5903}{ +handle\_\-t \textbf{samp\_\-newHandle} (void $\ast$ptr)} +\label{sampUtil_8c_711aa545f55e9307f662062deefd5903} + +\item +\hypertarget{sampUtil_8c_f02a7c646a9ed56e545d8bf33434c207}{ +void \textbf{samp\_\-freeHandle} (handle\_\-t handle)} +\label{sampUtil_8c_f02a7c646a9ed56e545d8bf33434c207} + +\item +char $\ast$ \hyperlink{sampUtil_8c_aed9017996a8361f8abf5b5c6a954414}{samp\_\-app2id} (handle\_\-t handle, char $\ast$appName) +\begin{CompactList}\small\item\em Convert an application name to a public-ID. \item\end{CompactList}\item +char $\ast$ \hyperlink{sampUtil_8c_a75368198ec8cd2fff6ad304806862b8}{samp\_\-id2app} (handle\_\-t handle, char $\ast$pubId) +\begin{CompactList}\small\item\em Convert a public-ID to the application name. \item\end{CompactList}\item +int \hyperlink{sampUtil_8c_0fb77074a0a38a4eab5dcf4e397dfef3}{samp\_\-serverPort} () +\begin{CompactList}\small\item\em Return a unique port number for the server. \item\end{CompactList}\item +void \hyperlink{sampUtil_8c_c7538c339e59556bfd0a87973ad61a43}{samp\_\-printMetadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Print the metadata for the application. \item\end{CompactList}\item +char $\ast$ \hyperlink{sampUtil_8c_ed777ec70a7f11254f04a2ee11be391b}{samp\_\-getMetadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Get the metadata item for the application. \item\end{CompactList}\end{CompactItemize} +\subsection*{Variables} +\begin{CompactItemize} +\item +\hypertarget{sampUtil_8c_ef3481f5da99207929f0c0c5ee4c328b}{ +int \textbf{numHandles} = 0} +\label{sampUtil_8c_ef3481f5da99207929f0c0c5ee4c328b} + +\item +\hypertarget{sampUtil_8c_c3d68c02a974f30f9150b4556e5e00d4}{ +long \textbf{sampHandles} \mbox{[}MAX\_\-HANDLES\mbox{]}} +\label{sampUtil_8c_c3d68c02a974f30f9150b4556e5e00d4} + +\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +Utility methods to convert struct pointers to user handles. + +SAMPUTIL.C -- Utility methods to convert struct pointers to user handles. + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/09 \end{Desc} + + +\subsection{Function Documentation} +\hypertarget{sampUtil_8c_aed9017996a8361f8abf5b5c6a954414}{ +\index{sampUtil.c@{sampUtil.c}!samp\_\-app2id@{samp\_\-app2id}} +\index{samp\_\-app2id@{samp\_\-app2id}!sampUtil.c@{sampUtil.c}} +\subsubsection[{samp\_\-app2id}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-app2id (handle\_\-t {\em handle}, \/ char $\ast$ {\em appName})}} +\label{sampUtil_8c_aed9017996a8361f8abf5b5c6a954414} + + +Convert an application name to a public-ID. + +SAMP\_\-APP2ID -- Convert an application name to a public-ID. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em appName}]name of registered application \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]public ID of application \end{Desc} + + +References Samp::clients, Client::name, and Samp::nclients. + +Referenced by samp\_\-call(), samp\_\-callAndWait(), samp\_\-envGet(), samp\_\-notify(), samp\_\-paramGet(), samp\_\-Ping(), and samp\_\-sendMsg().\hypertarget{sampUtil_8c_ed777ec70a7f11254f04a2ee11be391b}{ +\index{sampUtil.c@{sampUtil.c}!samp\_\-getMetadata@{samp\_\-getMetadata}} +\index{samp\_\-getMetadata@{samp\_\-getMetadata}!sampUtil.c@{sampUtil.c}} +\subsubsection[{samp\_\-getMetadata}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-getMetadata (handle\_\-t {\em handle}, \/ {\bf String} {\em name})}} +\label{sampUtil_8c_ed777ec70a7f11254f04a2ee11be391b} + + +Get the metadata item for the application. + +SAMP\_\-GETMETADATA -- Get the metadata item for the application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References appMD::aKey, appMD::aVal, Samp::description, appMD::docURL, appMD::iconURL, Samp::meta, and appMD::nkeys.\hypertarget{sampUtil_8c_a75368198ec8cd2fff6ad304806862b8}{ +\index{sampUtil.c@{sampUtil.c}!samp\_\-id2app@{samp\_\-id2app}} +\index{samp\_\-id2app@{samp\_\-id2app}!sampUtil.c@{sampUtil.c}} +\subsubsection[{samp\_\-id2app}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ samp\_\-id2app (handle\_\-t {\em handle}, \/ char $\ast$ {\em pubId})}} +\label{sampUtil_8c_a75368198ec8cd2fff6ad304806862b8} + + +Convert a public-ID to the application name. + +SAMP\_\-ID2APP -- Convert a public-ID to the application name. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em pubId}]public ID of application \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]name of registered application \end{Desc} + + +References Samp::clients, Client::name, and Samp::nclients.\hypertarget{sampUtil_8c_c7538c339e59556bfd0a87973ad61a43}{ +\index{sampUtil.c@{sampUtil.c}!samp\_\-printMetadata@{samp\_\-printMetadata}} +\index{samp\_\-printMetadata@{samp\_\-printMetadata}!sampUtil.c@{sampUtil.c}} +\subsubsection[{samp\_\-printMetadata}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-printMetadata (handle\_\-t {\em handle}, \/ {\bf String} {\em name})}} +\label{sampUtil_8c_c7538c339e59556bfd0a87973ad61a43} + + +Print the metadata for the application. + +SAMP\_\-PRINTMETADATA -- Print the metadata for the application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References appMD::aKey, appMD::aVal, Samp::description, appMD::docURL, appMD::iconURL, Samp::meta, and appMD::nkeys.\hypertarget{sampUtil_8c_0fb77074a0a38a4eab5dcf4e397dfef3}{ +\index{sampUtil.c@{sampUtil.c}!samp\_\-serverPort@{samp\_\-serverPort}} +\index{samp\_\-serverPort@{samp\_\-serverPort}!sampUtil.c@{sampUtil.c}} +\subsubsection[{samp\_\-serverPort}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-serverPort (void)}} +\label{sampUtil_8c_0fb77074a0a38a4eab5dcf4e397dfef3} + + +Return a unique port number for the server. + +SAMP\_\-SERVERPORT -- Return a unique port number for the server. + +\begin{Desc} +\item[Returns:]port number \end{Desc} + + +Referenced by samp\_\-hubSetXmlrpcCallback(), and sampInit().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/samp_8c.tex b/vendor/voclient/libsamp/doc/latex/samp_8c.tex new file mode 100644 index 00000000..dca7fc6e --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/samp_8c.tex @@ -0,0 +1,733 @@ +\hypertarget{samp_8c}{ +\section{samp.c File Reference} +\label{samp_8c}\index{samp.c@{samp.c}} +} +Top-level interface to the SAMP library. + + +{\tt \#include $<$stdlib.h$>$}\par +{\tt \#include $<$stdio.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include $<$string.h$>$}\par +{\tt \#include $<$time.h$>$}\par +{\tt \#include $<$signal.h$>$}\par +{\tt \#include $<$ctype.h$>$}\par +{\tt \#include \char`\"{}samp.h\char`\"{}}\par +\subsection*{Defines} +\begin{CompactItemize} +\item +\#define \hyperlink{samp_8c_92d198f56296c0b6a531ce4bce977185}{SZ\_\-CLIENT\_\-LIST}~1024 +\end{CompactItemize} +\subsection*{Functions} +\begin{CompactItemize} +\item +handle\_\-t \hyperlink{samp_8c_db03c60f2933ed9785bfb4457c359af2}{sampInit} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} appName, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} description) +\begin{CompactList}\small\item\em Initialize the SAMP interface. \item\end{CompactList}\item +void \hyperlink{samp_8c_f861f637942c5f971bab824708581f82}{sampClose} (handle\_\-t handle) +\begin{CompactList}\small\item\em Close the SAMP interface and free resources. \item\end{CompactList}\item +int \hyperlink{samp_8c_6bfd947988e5dbc846af7f99bcd99ee7}{sampDebug} (handle\_\-t handle, int value) +\begin{CompactList}\small\item\em Set interface debug level. \item\end{CompactList}\item +int \hyperlink{samp_8c_e3a6e918b3fe22db2fe014da16f81aad}{sampVerbose} (handle\_\-t handle, int value) +\begin{CompactList}\small\item\em Set interface debug level. \item\end{CompactList}\item +int \hyperlink{samp_8c_1f6d544576fec785be1acfeaf3f2cf63}{sampStartup} (handle\_\-t handle) +\begin{CompactList}\small\item\em Startup the SAMP interface to send/receive messages. \item\end{CompactList}\item +int \hyperlink{samp_8c_d634392fbb12cf4e1b2eb05da34759c5}{sampShutdown} (handle\_\-t handle) +\begin{CompactList}\small\item\em Shut down the active SAMP interface. \item\end{CompactList}\item +int \hyperlink{samp_8c_b2f9c71819e1956e1c29e969968f453c}{samp\_\-hubActive} (handle\_\-t handle) +\begin{CompactList}\small\item\em Determine if the \hyperlink{structHub}{Hub} is active (i.e. connected). \item\end{CompactList}\item +\hypertarget{samp_8c_d4ecb0b92b749647d1c3af8a1d11d5d4}{ +int \textbf{samp\_\-setOpt} (handle\_\-t handle, char $\ast$opt, int value)} +\label{samp_8c_d4ecb0b92b749647d1c3af8a1d11d5d4} + +\item +void \hyperlink{samp_8c_1428f653b9502c6e6d540f873de2b24f}{samp\_\-Metadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} field, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} value) +\begin{CompactList}\small\item\em Set a metadata field value for the application. \item\end{CompactList}\item +void \hyperlink{samp_8c_ed050606c5076a4a34eb8f0f982a25d4}{samp\_\-Subscribe} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, void $\ast$userFunc) +\begin{CompactList}\small\item\em Subscribe to a given mtype. \item\end{CompactList}\item +void \hyperlink{samp_8c_dc0e418fbaee507e661260c4480ecfcd}{samp\_\-Unsubscribe} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Unsubscribe to a given mtype. \item\end{CompactList}\item +void \hyperlink{samp_8c_3e01437224c73b91e49c6428cb69735d}{samp\_\-setCallMode} (handle\_\-t handle, int mode) +\begin{CompactList}\small\item\em Set the default calling mode (synch or asynch). \item\end{CompactList}\item +void \hyperlink{samp_8c_d636ae12dd05df43a077f91882a197ec}{samp\_\-setSyncMode} (handle\_\-t handle) +\begin{CompactList}\small\item\em Set the calling mode to use synchronous messaging. \item\end{CompactList}\item +void \hyperlink{samp_8c_9b2292b819e590b1f7c63bbdfaa09e31}{samp\_\-setASyncMode} (handle\_\-t handle) +\begin{CompactList}\small\item\em Set the calling mode to use asynchronous messaging. \item\end{CompactList}\item +void \hyperlink{samp_8c_7bfbc2e767fe234f83c13b8316a09ecd}{samp\_\-setNotifyMode} (handle\_\-t handle) +\begin{CompactList}\small\item\em Set the calling mode to use notification messaging. \item\end{CompactList}\item +void \hyperlink{samp_8c_01721eabf3e664bae3bea0c2b72268e2}{samp\_\-setMsgMode} (handle\_\-t handle, int mode) +\begin{CompactList}\small\item\em Set the message pattern to the specified mode. \item\end{CompactList}\item +void \hyperlink{samp_8c_b6b49029386c3efd0520daa93a4ab3eb}{samp\_\-setCallByRef} (handle\_\-t handle) +\begin{CompactList}\small\item\em Have interface call user handlers by reference. \item\end{CompactList}\item +void \hyperlink{samp_8c_a3c0bdb4c512357dbc53b0ad7a7d5b01}{samp\_\-setReplyCallback} (handle\_\-t handle, int $\ast$func) +\begin{CompactList}\small\item\em Set the Reply callback. samp\_\-setReplyCallback (handle\_\-t handle, int $\ast$func). \item\end{CompactList}\item +void \hyperlink{samp_8c_3db66f28546459327665f8491ea97f4d}{samp\_\-setResponseCallback} (handle\_\-t handle, int $\ast$func) +\begin{CompactList}\small\item\em Set the Response callback. samp\_\-setResponseCallback (handle\_\-t handle, int $\ast$func). \item\end{CompactList}\item +void \hyperlink{samp_8c_114bf9fb0d3e6eabd8bb93f3c87f5233}{samp\_\-defaultReplyHandler} (handle\_\-t handle) +\begin{CompactList}\small\item\em The interface's default Reply handler. \item\end{CompactList}\item +\hypertarget{samp_8c_cd506ac12f25f64ada7c9859af3f857f}{ +void \textbf{samp\_\-deaultfResponseHandler} (handle\_\-t handle)} +\label{samp_8c_cd506ac12f25f64ada7c9859af3f857f} + +\item +int \hyperlink{samp_8c_985afa0baeb135c9ee72d09394314ff1}{samp\_\-replyStatus} (handle\_\-t handle) +\begin{CompactList}\small\item\em Reply with the status of the last message sent. \item\end{CompactList}\item +void \hyperlink{samp_8c_c057d32437a96a527c63f938757099af}{samp\_\-setTimeout} (handle\_\-t handle, int timeout) +\begin{CompactList}\small\item\em Set the message timeout value (in seconds). \item\end{CompactList}\item +\hypertarget{samp_8c_7731da5bec549e7554d1bdc11b13eaf6}{ +void \textbf{samp\_\-setAppName} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name)} +\label{samp_8c_7731da5bec549e7554d1bdc11b13eaf6} + +\item +void \hyperlink{samp_8c_0f50f8dbae701aa6b19912fc99f6475a}{samp\_\-setAppVersion} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} version) +\begin{CompactList}\small\item\em Set the application name string. \item\end{CompactList}\item +int \hyperlink{samp_8c_ff4d125fc9594be25984989fad2fd3c8}{samp\_\-mapClients} (handle\_\-t handle) +\item +int \hyperlink{samp_8c_8a2111bbe4c88cef635e3bf67e899563}{samp\_\-addClient} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} id) +\item +int \hyperlink{samp_8c_1e494e73abe2ddfd946fb39e84da42a9}{samp\_\-listClients} (handle\_\-t handle) +\item +\hypertarget{samp_8c_61e09b672e5f610dae0f242ea8256328}{ +char $\ast$ \textbf{samp\_\-getClients} (handle\_\-t handle)} +\label{samp_8c_61e09b672e5f610dae0f242ea8256328} + +\item +int \hyperlink{samp_8c_e30e492f306a40f853a454faf60ab479}{samp\_\-removeClient} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} id) +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8c_f299ea13607279f60f16b8639a00658f}{samp\_\-getOKMap} () +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8c_6bb8b1f5c6268ad8c7f165733d4af86d}{samp\_\-getNullMap} () +\end{CompactItemize} +\subsection*{Variables} +\begin{CompactItemize} +\item +\hypertarget{samp_8c_12abcaf1a16a8a7c2ef6358cdbf4d705}{ +\hyperlink{structSamp}{Samp} $\ast$ \textbf{sampP}} +\label{samp_8c_12abcaf1a16a8a7c2ef6358cdbf4d705} + +\item +handle\_\-t \hyperlink{samp_8c_b04b61ee02d86e15b02b861699ae7424}{sampH} +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e}{nullMap} +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8c_a68efe925f0d8f29fa203c0f3747a6e2}{OK\_\-Map} +\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{samp_8c_a2106c7fe3a5747178c046238fbd5d55}{nullList} +\item +\hyperlink{structHub}{Hub} $\ast$ \hyperlink{samp_8c_d702b07240de0e0cf9e4b781a38317ad}{hub} +\item +int \hyperlink{samp_8c_037f00cb1101b007b4bf45e8bee1bd3e}{numHubs} +\item +long \hyperlink{samp_8c_dbf72aff0293f6556c1c6a2f4a62e2b9}{hubHandles} \mbox{[}MAX\_\-HUBS\mbox{]} +\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +Top-level interface to the SAMP library. + +SAMP.C -- Top-level interface to the SAMP library. + +samp = sampInit (appName, descr) sampClose (samp) + +stat = sampStartup (samp) sampShutdown (samp) + +samp\_\-Metadata (samp, field, value) samp\_\-Subscribe (samp, mtype, handler) samp\_\-Unsubscribe (samp, mtype) + +samp\_\-setReplyCallback (samp, func) samp\_\-setResponseCallback (samp, func) stat = samp\_\-replyStatus (samp) + +Utility Methods: samp\_\-setSyncMode (samp) // Default samp\_\-setASyncMode (samp) samp\_\-setNotifyMode (samp) samp\_\-setCallByRef (samp) + +samp\_\-setTimeout (samp, timeout) samp\_\-setAppNmae (samp, version) samp\_\-setAppVersion (samp, name) + +samp\_\-mapClients (handle\_\-t handle) samp\_\-addClient (handle\_\-t handle, String name, String id) samp\_\-removeClient (handle\_\-t handle, String id) + +\begin{Desc} +\item[Author:]Mike Fitzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/09 \end{Desc} + + +\subsection{Define Documentation} +\hypertarget{samp_8c_92d198f56296c0b6a531ce4bce977185}{ +\index{samp.c@{samp.c}!SZ\_\-CLIENT\_\-LIST@{SZ\_\-CLIENT\_\-LIST}} +\index{SZ\_\-CLIENT\_\-LIST@{SZ\_\-CLIENT\_\-LIST}!samp.c@{samp.c}} +\subsubsection[{SZ\_\-CLIENT\_\-LIST}]{\setlength{\rightskip}{0pt plus 5cm}\#define SZ\_\-CLIENT\_\-LIST~1024}} +\label{samp_8c_92d198f56296c0b6a531ce4bce977185} + + +SAMP\_\-GETCLIENTS -- Get a list of clients as a character string as the PubID and Name separated by a space, one client per line. + +\subsection{Function Documentation} +\hypertarget{samp_8c_8a2111bbe4c88cef635e3bf67e899563}{ +\index{samp.c@{samp.c}!samp\_\-addClient@{samp\_\-addClient}} +\index{samp\_\-addClient@{samp\_\-addClient}!samp.c@{samp.c}} +\subsubsection[{samp\_\-addClient}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-addClient (handle\_\-t {\em handle}, \/ {\bf String} {\em name}, \/ {\bf String} {\em id})}} +\label{samp_8c_8a2111bbe4c88cef635e3bf67e899563} + + +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().\hypertarget{samp_8c_114bf9fb0d3e6eabd8bb93f3c87f5233}{ +\index{samp.c@{samp.c}!samp\_\-defaultReplyHandler@{samp\_\-defaultReplyHandler}} +\index{samp\_\-defaultReplyHandler@{samp\_\-defaultReplyHandler}!samp.c@{samp.c}} +\subsubsection[{samp\_\-defaultReplyHandler}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-defaultReplyHandler (handle\_\-t {\em handle})}} +\label{samp_8c_114bf9fb0d3e6eabd8bb93f3c87f5233} + + +The interface's default Reply handler. + +SAMP\_\-DEFAULTREPLYHANDLER -- The interface's default Reply handler. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8c_6bb8b1f5c6268ad8c7f165733d4af86d}{ +\index{samp.c@{samp.c}!samp\_\-getNullMap@{samp\_\-getNullMap}} +\index{samp\_\-getNullMap@{samp\_\-getNullMap}!samp.c@{samp.c}} +\subsubsection[{samp\_\-getNullMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getNullMap (void)}} +\label{samp_8c_6bb8b1f5c6268ad8c7f165733d4af86d} + + +SAMP\_\-GETNULLMAP -- Generate a 'Null' map we can return to the \hyperlink{structHub}{Hub}. + +References samp\_\-newMap().\hypertarget{samp_8c_f299ea13607279f60f16b8639a00658f}{ +\index{samp.c@{samp.c}!samp\_\-getOKMap@{samp\_\-getOKMap}} +\index{samp\_\-getOKMap@{samp\_\-getOKMap}!samp.c@{samp.c}} +\subsubsection[{samp\_\-getOKMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getOKMap (void)}} +\label{samp_8c_f299ea13607279f60f16b8639a00658f} + + +SAMP\_\-GETOKMAP -- Generate an 'OK' map we can return to the \hyperlink{structHub}{Hub}. + +References nullMap, samp\_\-newMap(), samp\_\-setMapInMap(), and samp\_\-setStringInMap().\hypertarget{samp_8c_b2f9c71819e1956e1c29e969968f453c}{ +\index{samp.c@{samp.c}!samp\_\-hubActive@{samp\_\-hubActive}} +\index{samp\_\-hubActive@{samp\_\-hubActive}!samp.c@{samp.c}} +\subsubsection[{samp\_\-hubActive}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-hubActive (handle\_\-t {\em handle})}} +\label{samp_8c_b2f9c71819e1956e1c29e969968f453c} + + +Determine if the \hyperlink{structHub}{Hub} is active (i.e. connected). + +SAMP\_\-HUBACTIVE -- Determine if the \hyperlink{structHub}{Hub} is active (i.e. connected). + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::active.\hypertarget{samp_8c_1e494e73abe2ddfd946fb39e84da42a9}{ +\index{samp.c@{samp.c}!samp\_\-listClients@{samp\_\-listClients}} +\index{samp\_\-listClients@{samp\_\-listClients}!samp.c@{samp.c}} +\subsubsection[{samp\_\-listClients}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-listClients (handle\_\-t {\em handle})}} +\label{samp_8c_1e494e73abe2ddfd946fb39e84da42a9} + + +SAMP\_\-LISTCLIENTS -- List the available clients to stdout. + +References Samp::clients, Client::name, and Samp::nclients.\hypertarget{samp_8c_ff4d125fc9594be25984989fad2fd3c8}{ +\index{samp.c@{samp.c}!samp\_\-mapClients@{samp\_\-mapClients}} +\index{samp\_\-mapClients@{samp\_\-mapClients}!samp.c@{samp.c}} +\subsubsection[{samp\_\-mapClients}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-mapClients (handle\_\-t {\em handle})}} +\label{samp_8c_ff4d125fc9594be25984989fad2fd3c8} + + +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().\hypertarget{samp_8c_1428f653b9502c6e6d540f873de2b24f}{ +\index{samp.c@{samp.c}!samp\_\-Metadata@{samp\_\-Metadata}} +\index{samp\_\-Metadata@{samp\_\-Metadata}!samp.c@{samp.c}} +\subsubsection[{samp\_\-Metadata}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-Metadata (handle\_\-t {\em handle}, \/ {\bf String} {\em field}, \/ {\bf String} {\em value})}} +\label{samp_8c_1428f653b9502c6e6d540f873de2b24f} + + +Set a metadata field value for the application. + +SAMP\_\-METADATA -- Set a metadata field for the application. This will be sent to the \hyperlink{structHub}{Hub} later in a declareMetadata() call. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em field}]metadata field to set (name, author, etc) \item[{\em samp}]value of field \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +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().\hypertarget{samp_8c_e30e492f306a40f853a454faf60ab479}{ +\index{samp.c@{samp.c}!samp\_\-removeClient@{samp\_\-removeClient}} +\index{samp\_\-removeClient@{samp\_\-removeClient}!samp.c@{samp.c}} +\subsubsection[{samp\_\-removeClient}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-removeClient (handle\_\-t {\em handle}, \/ {\bf String} {\em id})}} +\label{samp_8c_e30e492f306a40f853a454faf60ab479} + + +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().\hypertarget{samp_8c_985afa0baeb135c9ee72d09394314ff1}{ +\index{samp.c@{samp.c}!samp\_\-replyStatus@{samp\_\-replyStatus}} +\index{samp\_\-replyStatus@{samp\_\-replyStatus}!samp.c@{samp.c}} +\subsubsection[{samp\_\-replyStatus}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-replyStatus (handle\_\-t {\em handle})}} +\label{samp_8c_985afa0baeb135c9ee72d09394314ff1} + + +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 + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em samp}]samp struct ptr \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]message status \end{Desc} + + +Referenced by samp\_\-Register().\hypertarget{samp_8c_0f50f8dbae701aa6b19912fc99f6475a}{ +\index{samp.c@{samp.c}!samp\_\-setAppVersion@{samp\_\-setAppVersion}} +\index{samp\_\-setAppVersion@{samp\_\-setAppVersion}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setAppVersion}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setAppVersion (handle\_\-t {\em handle}, \/ {\bf String} {\em version})}} +\label{samp_8c_0f50f8dbae701aa6b19912fc99f6475a} + + +Set the application name string. + +Set the application version string. + +SAMP\_\-SETAPPNAME -- Set the application name string. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em name}]application name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing\end{Desc} +SAMP\_\-SETAPPVERSION -- Set the application version string. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em name}]application version \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Hub::appVer, Samp::appVer, and Samp::hub.\hypertarget{samp_8c_9b2292b819e590b1f7c63bbdfaa09e31}{ +\index{samp.c@{samp.c}!samp\_\-setASyncMode@{samp\_\-setASyncMode}} +\index{samp\_\-setASyncMode@{samp\_\-setASyncMode}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setASyncMode}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setASyncMode (handle\_\-t {\em handle})}} +\label{samp_8c_9b2292b819e590b1f7c63bbdfaa09e31} + + +Set the calling mode to use asynchronous messaging. + +SAMP\_\-SETASYNCMODE -- Set the calling mode to use asynchronous messaging. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{samp_8c_b6b49029386c3efd0520daa93a4ab3eb}{ +\index{samp.c@{samp.c}!samp\_\-setCallByRef@{samp\_\-setCallByRef}} +\index{samp\_\-setCallByRef@{samp\_\-setCallByRef}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setCallByRef}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setCallByRef (handle\_\-t {\em handle})}} +\label{samp_8c_b6b49029386c3efd0520daa93a4ab3eb} + + +Have interface call user handlers by reference. + +SAMP\_\-SETCALLBYREF -- Have interface call user handlers by reference. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::handlerMode.\hypertarget{samp_8c_3e01437224c73b91e49c6428cb69735d}{ +\index{samp.c@{samp.c}!samp\_\-setCallMode@{samp\_\-setCallMode}} +\index{samp\_\-setCallMode@{samp\_\-setCallMode}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setCallMode}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setCallMode (handle\_\-t {\em handle}, \/ int {\em mode})}} +\label{samp_8c_3e01437224c73b91e49c6428cb69735d} + + +Set the default calling mode (synch or asynch). + +SAMP\_\-SETCALLMODE -- Set the default calling mode (synch or asynch) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em mode}]call mode (synch or asynch) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{samp_8c_01721eabf3e664bae3bea0c2b72268e2}{ +\index{samp.c@{samp.c}!samp\_\-setMsgMode@{samp\_\-setMsgMode}} +\index{samp\_\-setMsgMode@{samp\_\-setMsgMode}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setMsgMode}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setMsgMode (handle\_\-t {\em handle}, \/ int {\em mode})}} +\label{samp_8c_01721eabf3e664bae3bea0c2b72268e2} + + +Set the message pattern to the specified mode. + +SAMP\_\-SETMSGMODE -- Set the message pattern to the specified mode. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em mode}]message mode \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{samp_8c_7bfbc2e767fe234f83c13b8316a09ecd}{ +\index{samp.c@{samp.c}!samp\_\-setNotifyMode@{samp\_\-setNotifyMode}} +\index{samp\_\-setNotifyMode@{samp\_\-setNotifyMode}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setNotifyMode}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setNotifyMode (handle\_\-t {\em handle})}} +\label{samp_8c_7bfbc2e767fe234f83c13b8316a09ecd} + + +Set the calling mode to use notification messaging. + +SAMP\_\-SETNOTIFYMODE -- Set the calling mode to use notification messaging. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{samp_8c_a3c0bdb4c512357dbc53b0ad7a7d5b01}{ +\index{samp.c@{samp.c}!samp\_\-setReplyCallback@{samp\_\-setReplyCallback}} +\index{samp\_\-setReplyCallback@{samp\_\-setReplyCallback}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setReplyCallback}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setReplyCallback (handle\_\-t {\em handle}, \/ int $\ast$ {\em func})}} +\label{samp_8c_a3c0bdb4c512357dbc53b0ad7a7d5b01} + + +Set the Reply callback. samp\_\-setReplyCallback (handle\_\-t handle, int $\ast$func). + +SAMP\_\-SETREPLYCALLBACK -- Set the Reply callback. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em func}]callback for Reply message \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8c_3db66f28546459327665f8491ea97f4d}{ +\index{samp.c@{samp.c}!samp\_\-setResponseCallback@{samp\_\-setResponseCallback}} +\index{samp\_\-setResponseCallback@{samp\_\-setResponseCallback}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setResponseCallback}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setResponseCallback (handle\_\-t {\em handle}, \/ int $\ast$ {\em func})}} +\label{samp_8c_3db66f28546459327665f8491ea97f4d} + + +Set the Response callback. samp\_\-setResponseCallback (handle\_\-t handle, int $\ast$func). + +SAMP\_\-SETRESPONSECALLBACK -- Set the Response callback. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em func}]callback for message response \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8c_d636ae12dd05df43a077f91882a197ec}{ +\index{samp.c@{samp.c}!samp\_\-setSyncMode@{samp\_\-setSyncMode}} +\index{samp\_\-setSyncMode@{samp\_\-setSyncMode}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setSyncMode}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setSyncMode (handle\_\-t {\em handle})}} +\label{samp_8c_d636ae12dd05df43a077f91882a197ec} + + +Set the calling mode to use synchronous messaging. + +SAMP\_\-SETSYNCMODE -- Set the calling mode to use synchronous messaging. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{samp_8c_c057d32437a96a527c63f938757099af}{ +\index{samp.c@{samp.c}!samp\_\-setTimeout@{samp\_\-setTimeout}} +\index{samp\_\-setTimeout@{samp\_\-setTimeout}!samp.c@{samp.c}} +\subsubsection[{samp\_\-setTimeout}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setTimeout (handle\_\-t {\em handle}, \/ int {\em timeout})}} +\label{samp_8c_c057d32437a96a527c63f938757099af} + + +Set the message timeout value (in seconds). + +SAMP\_\-SETTIMEOUT -- Set the message timeout value (in seconds). + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em name}]application name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::hub, and Hub::timeout.\hypertarget{samp_8c_ed050606c5076a4a34eb8f0f982a25d4}{ +\index{samp.c@{samp.c}!samp\_\-Subscribe@{samp\_\-Subscribe}} +\index{samp\_\-Subscribe@{samp\_\-Subscribe}!samp.c@{samp.c}} +\subsubsection[{samp\_\-Subscribe}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-Subscribe (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype}, \/ void $\ast$ {\em func})}} +\label{samp_8c_ed050606c5076a4a34eb8f0f982a25d4} + + +Subscribe to a given mtype. + +SAMP\_\-SUBSCRIBE -- Subscribe to a given mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \item[{\em func}]callback function \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::nsubs, samp\_\-getSampHandler(), samp\_\-setSampHandler(), and samp\_\-setUserHandler().\hypertarget{samp_8c_dc0e418fbaee507e661260c4480ecfcd}{ +\index{samp.c@{samp.c}!samp\_\-Unsubscribe@{samp\_\-Unsubscribe}} +\index{samp\_\-Unsubscribe@{samp\_\-Unsubscribe}!samp.c@{samp.c}} +\subsubsection[{samp\_\-Unsubscribe}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-Unsubscribe (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype})}} +\label{samp_8c_dc0e418fbaee507e661260c4480ecfcd} + + +Unsubscribe to a given mtype. + +SAMP\_\-UNSUBSCRIBE -- Unsubscribe to a given mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::nsubs, samp\_\-DeclareSubscriptions(), Subs::sampFunc, and Subs::userFunc.\hypertarget{samp_8c_f861f637942c5f971bab824708581f82}{ +\index{samp.c@{samp.c}!sampClose@{sampClose}} +\index{sampClose@{sampClose}!samp.c@{samp.c}} +\subsubsection[{sampClose}]{\setlength{\rightskip}{0pt plus 5cm}sampClose (handle\_\-t {\em handle})}} +\label{samp_8c_f861f637942c5f971bab824708581f82} + + +Close the SAMP interface and free resources. + +SAMP\_\-CLOSE -- Close the SAMP interface. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::hub, Samp::hubHandle, samp\_\-freeHandle(), samp\_\-hubClose(), sampTrace(), and Samp::verbose.\hypertarget{samp_8c_6bfd947988e5dbc846af7f99bcd99ee7}{ +\index{samp.c@{samp.c}!sampDebug@{sampDebug}} +\index{sampDebug@{sampDebug}!samp.c@{samp.c}} +\subsubsection[{sampDebug}]{\setlength{\rightskip}{0pt plus 5cm}sampDebug (handle\_\-t {\em handle}, \/ int {\em value})}} +\label{samp_8c_6bfd947988e5dbc846af7f99bcd99ee7} + + +Set interface debug level. + +SAMPDEBUG -- Set interface debug level. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em value}]debug value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::debug, and Samp::verbose.\hypertarget{samp_8c_db03c60f2933ed9785bfb4457c359af2}{ +\index{samp.c@{samp.c}!sampInit@{sampInit}} +\index{sampInit@{sampInit}!samp.c@{samp.c}} +\subsubsection[{sampInit}]{\setlength{\rightskip}{0pt plus 5cm}handle sampInit ({\bf String} {\em name}, \/ {\bf String} {\em descr})}} +\label{samp_8c_db03c60f2933ed9785bfb4457c359af2} + + +Initialize the SAMP interface. + +SAMP\_\-INIT -- Initialize the SAMP interface. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em appName}]application name \item[{\em description}]description of application \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]samp handle \end{Desc} + + +References nullList, nullMap, OK\_\-Map, samp\_\-hubOpen(), samp\_\-newHandle(), samp\_\-newList(), samp\_\-newMap(), samp\_\-serverPort(), samp\_\-setMapInMap(), samp\_\-setStringInMap(), sampH, and sampTrace().\hypertarget{samp_8c_d634392fbb12cf4e1b2eb05da34759c5}{ +\index{samp.c@{samp.c}!sampShutdown@{sampShutdown}} +\index{sampShutdown@{sampShutdown}!samp.c@{samp.c}} +\subsubsection[{sampShutdown}]{\setlength{\rightskip}{0pt plus 5cm}sampShutdown (handle\_\-t {\em handle})}} +\label{samp_8c_d634392fbb12cf4e1b2eb05da34759c5} + + +Shut down the active SAMP interface. + +SAMP\_\-SHUTDOWN -- Shut down the active SAMP interface. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::active, Samp::hubHandle, samp\_\-hubClose(), Samp::svrThread, and Samp::verbose. + +Referenced by samp\_\-processHubEvent().\hypertarget{samp_8c_1f6d544576fec785be1acfeaf3f2cf63}{ +\index{samp.c@{samp.c}!sampStartup@{sampStartup}} +\index{sampStartup@{sampStartup}!samp.c@{samp.c}} +\subsubsection[{sampStartup}]{\setlength{\rightskip}{0pt plus 5cm}sampStartup (handle\_\-t {\em handle})}} +\label{samp_8c_1f6d544576fec785be1acfeaf3f2cf63} + + +Startup the SAMP interface to send/receive messages. + +SAMP\_\-STARTUP -- Startup the SAMP interface to send/receive messages. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +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.\hypertarget{samp_8c_e3a6e918b3fe22db2fe014da16f81aad}{ +\index{samp.c@{samp.c}!sampVerbose@{sampVerbose}} +\index{sampVerbose@{sampVerbose}!samp.c@{samp.c}} +\subsubsection[{sampVerbose}]{\setlength{\rightskip}{0pt plus 5cm}sampVerbose (handle\_\-t {\em handle}, \/ int {\em value})}} +\label{samp_8c_e3a6e918b3fe22db2fe014da16f81aad} + + +Set interface debug level. + +SAMPVERBOSE -- Set interface verbose level. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em value}]verbose value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::verbose. + +\subsection{Variable Documentation} +\hypertarget{samp_8c_d702b07240de0e0cf9e4b781a38317ad}{ +\index{samp.c@{samp.c}!hub@{hub}} +\index{hub@{hub}!samp.c@{samp.c}} +\subsubsection[{hub}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Hub}$\ast$ {\bf hub}}} +\label{samp_8c_d702b07240de0e0cf9e4b781a38317ad} + + +empty List struct + +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\_\-imageLoadFITS(), samp\_\-notify(), samp\_\-notifyAll(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Register(), samp\_\-Reply(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), samp\_\-tableSelectRowList(), and samp\_\-UnRegister().\hypertarget{samp_8c_dbf72aff0293f6556c1c6a2f4a62e2b9}{ +\index{samp.c@{samp.c}!hubHandles@{hubHandles}} +\index{hubHandles@{hubHandles}!samp.c@{samp.c}} +\subsubsection[{hubHandles}]{\setlength{\rightskip}{0pt plus 5cm}long {\bf hubHandles}\mbox{[}MAX\_\-HUBS\mbox{]}}} +\label{samp_8c_dbf72aff0293f6556c1c6a2f4a62e2b9} + + +No. of available hubs \hypertarget{samp_8c_a2106c7fe3a5747178c046238fbd5d55}{ +\index{samp.c@{samp.c}!nullList@{nullList}} +\index{nullList@{nullList}!samp.c@{samp.c}} +\subsubsection[{nullList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} {\bf nullList}}} +\label{samp_8c_a2106c7fe3a5747178c046238fbd5d55} + + +SAMP\_\-OK Map struct + +Referenced by sampInit().\hypertarget{samp_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e}{ +\index{samp.c@{samp.c}!nullMap@{nullMap}} +\index{nullMap@{nullMap}!samp.c@{samp.c}} +\subsubsection[{nullMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} {\bf nullMap}}} +\label{samp_8c_68bf22a5b3f2531242f5c6d6ecf2ea1e} + + +SAMP handle + +Referenced by samp\_\-getHandlerReply(), samp\_\-getOKMap(), samp\_\-hubDeclareSubscriptions(), and sampInit().\hypertarget{samp_8c_037f00cb1101b007b4bf45e8bee1bd3e}{ +\index{samp.c@{samp.c}!numHubs@{numHubs}} +\index{numHubs@{numHubs}!samp.c@{samp.c}} +\subsubsection[{numHubs}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf numHubs}}} +\label{samp_8c_037f00cb1101b007b4bf45e8bee1bd3e} + + +HUB connection \hypertarget{samp_8c_a68efe925f0d8f29fa203c0f3747a6e2}{ +\index{samp.c@{samp.c}!OK\_\-Map@{OK\_\-Map}} +\index{OK\_\-Map@{OK\_\-Map}!samp.c@{samp.c}} +\subsubsection[{OK\_\-Map}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} {\bf OK\_\-Map}}} +\label{samp_8c_a68efe925f0d8f29fa203c0f3747a6e2} + + +empty Map struct + +Referenced by samp\_\-getHandlerReply(), samp\_\-receiveCall(), samp\_\-receiveNotification(), samp\_\-receiveResponse(), and sampInit().\hypertarget{samp_8c_b04b61ee02d86e15b02b861699ae7424}{ +\index{samp.c@{samp.c}!sampH@{sampH}} +\index{sampH@{sampH}!samp.c@{samp.c}} +\subsubsection[{sampH}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t {\bf sampH}}} +\label{samp_8c_b04b61ee02d86e15b02b861699ae7424} + + +SAMP struct pointer + +Referenced by samp\_\-processHubEvent(), samp\_\-receiveCall(), and sampInit().
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/samp_8h.tex b/vendor/voclient/libsamp/doc/latex/samp_8h.tex new file mode 100644 index 00000000..954d05cb --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/samp_8h.tex @@ -0,0 +1,3583 @@ +\hypertarget{samp_8h}{ +\section{samp.h File Reference} +\label{samp_8h}\index{samp.h@{samp.h}} +} +SAMP interface include file. + + +{\tt \#include $<$xmlrpc-c/base.h$>$}\par +{\tt \#include $<$xmlrpc-c/client.h$>$}\par +{\tt \#include $<$xmlrpc-c/server.h$>$}\par +{\tt \#include $<$xmlrpc-c/server\_\-abyss.h$>$}\par +{\tt \#include $<$sys/types.h$>$}\par +{\tt \#include $<$sys/stat.h$>$}\par +{\tt \#include $<$unistd.h$>$}\par +{\tt \#include \char`\"{}xrpc.h\char`\"{}}\par +\subsection*{Data Structures} +\begin{CompactItemize} +\item +struct \hyperlink{structappMD}{appMD} +\item +struct \hyperlink{structSubs}{Subs} +\item +struct \hyperlink{structClient}{Client} +\item +struct \hyperlink{structHub}{Hub} +\item +struct \hyperlink{structSamp}{Samp} +\end{CompactItemize} +\subsection*{Defines} +\begin{CompactItemize} +\item +\hypertarget{samp_8h_6fc88d7dbc85d8d10379f58c910ce847}{ +\#define \textbf{SZ\_\-NAME}~256} +\label{samp_8h_6fc88d7dbc85d8d10379f58c910ce847} + +\item +\hypertarget{samp_8h_32108415ff44b6f7537b9516f4a84be7}{ +\#define \textbf{SZ\_\-LINE}~256} +\label{samp_8h_32108415ff44b6f7537b9516f4a84be7} + +\item +\hypertarget{samp_8h_7b6cc171ab550fcd6c34d92e010fcec3}{ +\#define \textbf{SZ\_\-SECRET}~64} +\label{samp_8h_7b6cc171ab550fcd6c34d92e010fcec3} + +\item +\hypertarget{samp_8h_3e01a6ceff717c54fca995bb444611a8}{ +\#define \textbf{SZ\_\-DESC}~8192} +\label{samp_8h_3e01a6ceff717c54fca995bb444611a8} + +\item +\hypertarget{samp_8h_76e806c1a560659f0c849d427b64644a}{ +\#define \textbf{SZ\_\-URL}~1024} +\label{samp_8h_76e806c1a560659f0c849d427b64644a} + +\item +\hypertarget{samp_8h_08329a2ecb12005e4089db9f336bde2a}{ +\#define \textbf{SZ\_\-CMD}~1024} +\label{samp_8h_08329a2ecb12005e4089db9f336bde2a} + +\item +\hypertarget{samp_8h_c9c1311707cba8abcf575d13a527bc7b}{ +\#define \textbf{SZ\_\-SBUF}~65536} +\label{samp_8h_c9c1311707cba8abcf575d13a527bc7b} + +\item +\hypertarget{samp_8h_85a4ed506c27f31c98227e3683fb4394}{ +\#define \textbf{SZ\_\-RESSTR}~1024} +\label{samp_8h_85a4ed506c27f31c98227e3683fb4394} + +\item +\hypertarget{samp_8h_3aaff003637cf49539879ebf960c7764}{ +\#define \textbf{DEF\_\-PORT}~9876} +\label{samp_8h_3aaff003637cf49539879ebf960c7764} + +\item +\hypertarget{samp_8h_53712d3c054c04a805c2a09b075a898f}{ +\#define \textbf{DEF\_\-TIMEOUT}~\char`\"{}15\char`\"{}} +\label{samp_8h_53712d3c054c04a805c2a09b075a898f} + +\item +\hypertarget{samp_8h_6e5a1caf522da4cb934712482b0aed5b}{ +\#define \textbf{MAX\_\-SAMPS}~16} +\label{samp_8h_6e5a1caf522da4cb934712482b0aed5b} + +\item +\hypertarget{samp_8h_aeadc2a66777c5ca1a67bca1bc4648c5}{ +\#define \textbf{MAX\_\-HUBS}~16} +\label{samp_8h_aeadc2a66777c5ca1a67bca1bc4648c5} + +\item +\hypertarget{samp_8h_0543164fb84dcec0c53c79671c473519}{ +\#define \textbf{MAX\_\-MDATTRS}~32} +\label{samp_8h_0543164fb84dcec0c53c79671c473519} + +\item +\hypertarget{samp_8h_4cecb71b936e9c443f548540fb7a54ff}{ +\#define \textbf{MAX\_\-SUBS}~256} +\label{samp_8h_4cecb71b936e9c443f548540fb7a54ff} + +\item +\hypertarget{samp_8h_0a8f91f93d75a07f0ae45077db45b3eb}{ +\#define \textbf{MAX\_\-CLIENTS}~32} +\label{samp_8h_0a8f91f93d75a07f0ae45077db45b3eb} + +\item +\hypertarget{samp_8h_3b94af9dcb0358f28d175d80eed98330}{ +\#define \textbf{MAX\_\-ROWS}~256} +\label{samp_8h_3b94af9dcb0358f28d175d80eed98330} + +\item +\hypertarget{samp_8h_2b30409909356bb21b32a71574cc5ed4}{ +\#define \textbf{SAMP\_\-ERR}~-1} +\label{samp_8h_2b30409909356bb21b32a71574cc5ed4} + +\item +\hypertarget{samp_8h_2aa93712e218c9a6aa47726222da2ea8}{ +\#define \textbf{SAMP\_\-PENDING}~0} +\label{samp_8h_2aa93712e218c9a6aa47726222da2ea8} + +\item +\hypertarget{samp_8h_118ac4276b5889bad5aefbf8d976dc65}{ +\#define \textbf{SAMP\_\-OK}~1} +\label{samp_8h_118ac4276b5889bad5aefbf8d976dc65} + +\item +\hypertarget{samp_8h_82bc77041ac33dba80902508e0e67cb1}{ +\#define \textbf{SAMP\_\-CBR}~0} +\label{samp_8h_82bc77041ac33dba80902508e0e67cb1} + +\item +\hypertarget{samp_8h_8c1d67de0da93f180a22f4aa0a6c791e}{ +\#define \textbf{SAMP\_\-CBV}~1} +\label{samp_8h_8c1d67de0da93f180a22f4aa0a6c791e} + +\item +\hypertarget{samp_8h_6f3ff8853aee2ab95b5b95bc6118e089}{ +\#define \textbf{SAMP\_\-SYNCH}~0} +\label{samp_8h_6f3ff8853aee2ab95b5b95bc6118e089} + +\item +\hypertarget{samp_8h_b0ce138af3ddf15f2f260970f61334aa}{ +\#define \textbf{SAMP\_\-ASYNCH}~1} +\label{samp_8h_b0ce138af3ddf15f2f260970f61334aa} + +\item +\hypertarget{samp_8h_4e57045e053a2de9ff90f33e2d5f8c96}{ +\#define \textbf{SAMP\_\-NOTIFY}~2} +\label{samp_8h_4e57045e053a2de9ff90f33e2d5f8c96} + +\item +\hypertarget{samp_8h_37bd37c1c7194b07b5c741deaa9bc067}{ +\#define \textbf{SAMP\_\-INT}~TY\_\-INT} +\label{samp_8h_37bd37c1c7194b07b5c741deaa9bc067} + +\item +\hypertarget{samp_8h_27a60dff10f0bce5fe7e901eab813b5a}{ +\#define \textbf{SAMP\_\-DOUBLE}~TY\_\-DOUBLE} +\label{samp_8h_27a60dff10f0bce5fe7e901eab813b5a} + +\item +\hypertarget{samp_8h_315222074686150aef1320e4024706cd}{ +\#define \textbf{SAMP\_\-BOOL}~TY\_\-BOOL} +\label{samp_8h_315222074686150aef1320e4024706cd} + +\item +\hypertarget{samp_8h_3f3753974db5c38ecf207e8c194e5327}{ +\#define \textbf{SAMP\_\-STRING}~TY\_\-STRING} +\label{samp_8h_3f3753974db5c38ecf207e8c194e5327} + +\item +\hypertarget{samp_8h_179ebb149a064e82a5989ec4278e5533}{ +\#define \textbf{SAMP\_\-DATETIME}~TY\_\-DATETIME} +\label{samp_8h_179ebb149a064e82a5989ec4278e5533} + +\item +\hypertarget{samp_8h_268da1193f3e31a3835123617a606a11}{ +\#define \textbf{SAMP\_\-SAMPRUCT}~TY\_\-STRUCT} +\label{samp_8h_268da1193f3e31a3835123617a606a11} + +\item +\hypertarget{samp_8h_ba4e9235f0d88ec1a557a37e499a82e7}{ +\#define \textbf{SAMP\_\-ARRAY}~TY\_\-ARRAY} +\label{samp_8h_ba4e9235f0d88ec1a557a37e499a82e7} + +\item +\hypertarget{samp_8h_725ce7161437542f8e767ef6742a7aef}{ +\#define \textbf{SAMP\_\-TRACE}~0} +\label{samp_8h_725ce7161437542f8e767ef6742a7aef} + +\item +\#define \hyperlink{samp_8h_fc367e0d449c3afa2d429eedc85407aa}{HUB\_\-SHUTDOWN}~0 +\item +\hypertarget{samp_8h_9f7120104f528bcad4d3c35451b466fa}{ +\#define \textbf{HUB\_\-REGISTER}~1} +\label{samp_8h_9f7120104f528bcad4d3c35451b466fa} + +\item +\hypertarget{samp_8h_87abcce3ae8ebd84eaf49765275737cd}{ +\#define \textbf{HUB\_\-UNREGISTER}~2} +\label{samp_8h_87abcce3ae8ebd84eaf49765275737cd} + +\item +\hypertarget{samp_8h_dacba3969403cc030f9942696d48f226}{ +\#define \textbf{HUB\_\-SUBSCRIPTIONS}~3} +\label{samp_8h_dacba3969403cc030f9942696d48f226} + +\item +\hypertarget{samp_8h_3deb0e45988e39beaad0b05ed31d958b}{ +\#define \textbf{HUB\_\-METADATA}~4} +\label{samp_8h_3deb0e45988e39beaad0b05ed31d958b} + +\item +\hypertarget{samp_8h_5aa908cb222be1b5df868c96a440236c}{ +\#define \textbf{HUB\_\-DISCONNECT}~5} +\label{samp_8h_5aa908cb222be1b5df868c96a440236c} + +\item +\hypertarget{samp_8h_2e76b1116a74dcd3fbc695ebaa01bd3d}{ +\#define \textbf{LEN\_\-DESC}~32768} +\label{samp_8h_2e76b1116a74dcd3fbc695ebaa01bd3d} + +\item +\hypertarget{samp_8h_c6afabdc09a49a433ee19d8a9486056d}{ +\#define \textbf{min}(a, b)~(a$<$b?a:b)} +\label{samp_8h_c6afabdc09a49a433ee19d8a9486056d} + +\item +\hypertarget{samp_8h_ffe776513b24d84b39af8ab0930fef7f}{ +\#define \textbf{max}(a, b)~(a$>$b?a:b)} +\label{samp_8h_ffe776513b24d84b39af8ab0930fef7f} + +\item +\hypertarget{samp_8h_400c6ad9a4514ac728ef6f26c41e26df}{ +\#define \textbf{MSG\_\-SYNC}~0} +\label{samp_8h_400c6ad9a4514ac728ef6f26c41e26df} + +\item +\hypertarget{samp_8h_f38b71e9d650543379f59e8f7ade60c8}{ +\#define \textbf{MSG\_\-ASYNC}~1} +\label{samp_8h_f38b71e9d650543379f59e8f7ade60c8} + +\item +\hypertarget{samp_8h_ee5730f808625a70be4589312bd6c9ab}{ +\#define \textbf{MSG\_\-NOTIFY}~2} +\label{samp_8h_ee5730f808625a70be4589312bd6c9ab} + +\item +\hypertarget{samp_8h_5ce6908d24bcc91b57bc9ac9923a3855}{ +\#define \textbf{DEF\_\-CALLMODE}~MSG\_\-ASYNC} +\label{samp_8h_5ce6908d24bcc91b57bc9ac9923a3855} + +\end{CompactItemize} +\subsection*{Typedefs} +\begin{CompactItemize} +\item +\hypertarget{samp_8h_0e421d328f66b7f783a4c746afc1d017}{ +typedef long \textbf{handle\_\-t}} +\label{samp_8h_0e421d328f66b7f783a4c746afc1d017} + +\item +typedef int \hyperlink{samp_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} +\item +typedef int \hyperlink{samp_8h_39f9d235896a8fd920f319105eb82791}{List} +\item +typedef int \hyperlink{samp_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} +\item +typedef int \hyperlink{samp_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} +\item +typedef char $\ast$ \hyperlink{samp_8h_2efe6d463d80744789f228f5dc4baa39}{String} +\item +\hypertarget{samp_8h_cc13f9a2430a2e5b4d08f22a005c28ca}{ +typedef struct \hyperlink{structappMD}{appMD} $\ast$ \textbf{appMDP}} +\label{samp_8h_cc13f9a2430a2e5b4d08f22a005c28ca} + +\item +\hypertarget{samp_8h_5f6c3b3319ba8bd60a15bac1b8fe9a96}{ +typedef struct \hyperlink{structSubs}{Subs} $\ast$ \textbf{SubsP}} +\label{samp_8h_5f6c3b3319ba8bd60a15bac1b8fe9a96} + +\item +\hypertarget{samp_8h_46ebb9354eb637730c6acd2818807321}{ +typedef struct \hyperlink{structClient}{Client} $\ast$ \textbf{ClientP}} +\label{samp_8h_46ebb9354eb637730c6acd2818807321} + +\item +\hypertarget{samp_8h_cf8156b03ce4e66cd90203b1038112a8}{ +typedef struct \hyperlink{structHub}{Hub} $\ast$ \textbf{HubP}} +\label{samp_8h_cf8156b03ce4e66cd90203b1038112a8} + +\item +\hypertarget{samp_8h_159006987ca77a172c19bd254cb6f1c5}{ +typedef struct \hyperlink{structSamp}{Samp} $\ast$ \textbf{SampP}} +\label{samp_8h_159006987ca77a172c19bd254cb6f1c5} + +\end{CompactItemize} +\subsection*{Functions} +\begin{CompactItemize} +\item +handle\_\-t \hyperlink{samp_8h_30f39c72c3783055faa82ad3860f3d1d}{sampInit} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} appName, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} description) +\begin{CompactList}\small\item\em Initialize the SAMP interface. \item\end{CompactList}\item +void \hyperlink{samp_8h_2e77115e730e95b31d897b8c50999b74}{samp\_\-Metadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} field, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} value) +\begin{CompactList}\small\item\em Set a metadata field value for the application. \item\end{CompactList}\item +void \hyperlink{samp_8h_c6b76655d73825acdacfac8b5a1139ee}{samp\_\-Subscribe} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, void $\ast$func) +\begin{CompactList}\small\item\em Subscribe to a given mtype. \item\end{CompactList}\item +void \hyperlink{samp_8h_b3fded97bbbf3751c4916543959f16a5}{samp\_\-Unsubscribe} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Unsubscribe to a given mtype. \item\end{CompactList}\item +int \hyperlink{samp_8h_8e18ae12df031094ace47863f93b3634}{sampStartup} (handle\_\-t handle) +\begin{CompactList}\small\item\em Startup the SAMP interface to send/receive messages. \item\end{CompactList}\item +int \hyperlink{samp_8h_65908d088c8b917d10db38c147590ad9}{sampShutdown} (handle\_\-t handle) +\begin{CompactList}\small\item\em Shut down the active SAMP interface. \item\end{CompactList}\item +int \hyperlink{samp_8h_124214f79e99619b377d98ed2fd93eb9}{sampDebug} (handle\_\-t handle, int value) +\begin{CompactList}\small\item\em Set interface debug level. \item\end{CompactList}\item +int \hyperlink{samp_8h_c0c812e5d3f2c9ee6c54067e4c81b3dd}{sampVerbose} (handle\_\-t handle, int value) +\begin{CompactList}\small\item\em Set interface debug level. \item\end{CompactList}\item +void \hyperlink{samp_8h_123413db26ad50a84bd41863af5deae5}{sampClose} (handle\_\-t handle) +\begin{CompactList}\small\item\em Close the SAMP interface and free resources. \item\end{CompactList}\item +int \hyperlink{samp_8h_14a1f14f60ac385c758346aed0f0272b}{samp\_\-hubActive} (handle\_\-t handle) +\begin{CompactList}\small\item\em Determine if the \hyperlink{structHub}{Hub} is active (i.e. connected). \item\end{CompactList}\item +\hypertarget{samp_8h_d4ecb0b92b749647d1c3af8a1d11d5d4}{ +int \textbf{samp\_\-setOpt} (handle\_\-t handle, char $\ast$opt, int value)} +\label{samp_8h_d4ecb0b92b749647d1c3af8a1d11d5d4} + +\item +void \hyperlink{samp_8h_1d00dc78292cfbc01262ef65ab055063}{samp\_\-setSyncMode} (handle\_\-t handle) +\begin{CompactList}\small\item\em Set the calling mode to use synchronous messaging. \item\end{CompactList}\item +void \hyperlink{samp_8h_a9aef12dd82bfd38a2382a4ac88c54af}{samp\_\-setASyncMode} (handle\_\-t handle) +\begin{CompactList}\small\item\em Set the calling mode to use asynchronous messaging. \item\end{CompactList}\item +void \hyperlink{samp_8h_9056a8601300892f918835259c7fdb3b}{samp\_\-setNotifyMode} (handle\_\-t handle) +\begin{CompactList}\small\item\em Set the calling mode to use notification messaging. \item\end{CompactList}\item +void \hyperlink{samp_8h_68b51d70127bbff10fd30396e40a482d}{samp\_\-setMsgMode} (handle\_\-t handle, int mode) +\begin{CompactList}\small\item\em Set the message pattern to the specified mode. \item\end{CompactList}\item +void \hyperlink{samp_8h_d4c1514e94c9ef511cfcd27004c38c4d}{samp\_\-setCallByRef} (handle\_\-t handle) +\begin{CompactList}\small\item\em Have interface call user handlers by reference. \item\end{CompactList}\item +void \hyperlink{samp_8h_fc27715ec9a5cb60cf0b5415eb7f9a48}{samp\_\-setCallMode} (handle\_\-t handle, int mode) +\begin{CompactList}\small\item\em Set the default calling mode (synch or asynch). \item\end{CompactList}\item +void \hyperlink{samp_8h_a3c0bdb4c512357dbc53b0ad7a7d5b01}{samp\_\-setReplyCallback} (handle\_\-t handle, int $\ast$func) +\begin{CompactList}\small\item\em Set the Reply callback. samp\_\-setReplyCallback (handle\_\-t handle, int $\ast$func). \item\end{CompactList}\item +void \hyperlink{samp_8h_3db66f28546459327665f8491ea97f4d}{samp\_\-setResponseCallback} (handle\_\-t handle, int $\ast$func) +\begin{CompactList}\small\item\em Set the Response callback. samp\_\-setResponseCallback (handle\_\-t handle, int $\ast$func). \item\end{CompactList}\item +void \hyperlink{samp_8h_e11a97c262ab5ab4438eca6c60c0d8cf}{samp\_\-setTimeout} (handle\_\-t handle, int timeout) +\begin{CompactList}\small\item\em Set the message timeout value (in seconds). \item\end{CompactList}\item +\hypertarget{samp_8h_7731da5bec549e7554d1bdc11b13eaf6}{ +void \textbf{samp\_\-setAppName} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name)} +\label{samp_8h_7731da5bec549e7554d1bdc11b13eaf6} + +\item +void \hyperlink{samp_8h_8fbfdc550ede5d52840300ab33639c49}{samp\_\-setAppVersion} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} version) +\begin{CompactList}\small\item\em Set the application name string. \item\end{CompactList}\item +void \hyperlink{samp_8h_96851f1c15e4baf67949d86d15f2568d}{samp\_\-defaultReplyHandler} (handle\_\-t handle) +\begin{CompactList}\small\item\em The interface's default Reply handler. \item\end{CompactList}\item +\hypertarget{samp_8h_cd506ac12f25f64ada7c9859af3f857f}{ +void \textbf{samp\_\-deaultfResponseHandler} (handle\_\-t handle)} +\label{samp_8h_cd506ac12f25f64ada7c9859af3f857f} + +\item +int \hyperlink{samp_8h_d47754f3b9fceff4d3019821519432b4}{samp\_\-replyStatus} (handle\_\-t handle) +\begin{CompactList}\small\item\em Reply with the status of the last message sent. \item\end{CompactList}\item +int \hyperlink{samp_8h_ff4d125fc9594be25984989fad2fd3c8}{samp\_\-mapClients} (handle\_\-t handle) +\item +int \hyperlink{samp_8h_1e494e73abe2ddfd946fb39e84da42a9}{samp\_\-listClients} (handle\_\-t handle) +\item +\hypertarget{samp_8h_61e09b672e5f610dae0f242ea8256328}{ +char $\ast$ \textbf{samp\_\-getClients} (handle\_\-t handle)} +\label{samp_8h_61e09b672e5f610dae0f242ea8256328} + +\item +int \hyperlink{samp_8h_8a2111bbe4c88cef635e3bf67e899563}{samp\_\-addClient} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} id) +\item +int \hyperlink{samp_8h_e30e492f306a40f853a454faf60ab479}{samp\_\-removeClient} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} id) +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8h_cbf9b52550a9ab0b3515c32e692c46fb}{samp\_\-getOKMap} (void) +\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8h_27baec44edb57136951b5f86ae893246}{samp\_\-getNullMap} (void) +\item +int \hyperlink{samp_8h_aef9c2f86c7e4f49fe3df343ef06f3ba}{samp\_\-Register} (handle\_\-t handle) +\begin{CompactList}\small\item\em Register with the \hyperlink{structHub}{Hub} using the currently stored metadata. \item\end{CompactList}\item +int \hyperlink{samp_8h_5e3a44429f332694cc2cedc2e38856ce}{samp\_\-UnRegister} (handle\_\-t handle) +\begin{CompactList}\small\item\em Un-Register from the hub. \item\end{CompactList}\item +int \hyperlink{samp_8h_94cdccbcfa524fa515de77544b6c6eaa}{samp\_\-DeclareMetadata} (handle\_\-t handle) +\begin{CompactList}\small\item\em (Re)Declare all of our metadata. \item\end{CompactList}\item +int \hyperlink{samp_8h_7688cbf8ef852483c077be96151763a6}{samp\_\-Ping} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} appName) +\begin{CompactList}\small\item\em Ping the hub/app to see if it is alive (returns $>$0). \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8h_636e11796b78ae9881e7c61df8516d2a}{samp\_\-GetMetadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} pubId) +\begin{CompactList}\small\item\em Get the metadata for a specified app. \item\end{CompactList}\item +int \hyperlink{samp_8h_ef695801c121c6191d3af4574569ab8c}{samp\_\-DeclareSubscriptions} (handle\_\-t handle) +\begin{CompactList}\small\item\em Declare the messages we're interested in. \item\end{CompactList}\item +\hypertarget{samp_8h_c4f65b6315c8bd7380176d2b97462354}{ +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \textbf{samp\_\-GetSubscriptions} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} pubId)} +\label{samp_8h_c4f65b6315c8bd7380176d2b97462354} + +\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{samp_8h_2c532e076dd6446f079691ed02197a57}{samp\_\-GetRegisteredClients} (handle\_\-t handle) +\begin{CompactList}\small\item\em Get public-ids of the registered clients. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{samp_8h_d28a9085ab8cacbe978e300ac99f6ae5}{samp\_\-GetSubscribedClients} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Get clients matching the mtype subscription. \item\end{CompactList}\item +int \hyperlink{samp_8h_45c2023312cd2adfa40feb2eb8a3e143}{samp\_\-tableLoadVOTable} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Tell an app to load a VOTable. \item\end{CompactList}\item +int \hyperlink{samp_8h_6b950e53c7fdf481a13c8a2ec353dca1}{samp\_\-tableLoadFITS} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Tell an app to load a FITS table. \item\end{CompactList}\item +int \hyperlink{samp_8h_2ec386ef5bd7dee20ffa1fead0b0210a}{samp\_\-imageLoadFITS} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} imageId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Tell an app to load a FITS image. \item\end{CompactList}\item +int \hyperlink{samp_8h_0503d3ee247a6a962a2a8da672261ab7}{samp\_\-tableHighlightRow} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, int row) +\begin{CompactList}\small\item\em Tell an app to highlight a table row. \item\end{CompactList}\item +int \hyperlink{samp_8h_a410ef908863f7c5b2c99844ebb73d35}{samp\_\-tableSelectRowList} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tableId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, int rows\mbox{[}$\,$\mbox{]}, int nrows) +\begin{CompactList}\small\item\em Tell an app to select a list of table rows. \item\end{CompactList}\item +int \hyperlink{samp_8h_0651eec8ddc8707bb8fbc4dfdcfff5e2}{samp\_\-coordPointAtSky} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, float ra, float dec) +\begin{CompactList}\small\item\em Tell an app to point at an RA/Dec coordinate. \item\end{CompactList}\item +int \hyperlink{samp_8h_4869a1bb04a96514f153dc5bfbed8e6e}{samp\_\-specLoadSSAGeneric} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} url, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} meta, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} spectrumId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Load a generic spectrum from an SSA service. \item\end{CompactList}\item +int \hyperlink{samp_8h_be012673358bfd254e2c6ad9f6e92240}{samp\_\-cmdExec} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} cmd) +\begin{CompactList}\small\item\em Execute a command in a remote application. \item\end{CompactList}\item +char $\ast$ \hyperlink{samp_8h_ba313c7608a7658c673065c83113ec5b}{samp\_\-envGet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Get an environment variable in a remote application. \item\end{CompactList}\item +int \hyperlink{samp_8h_e842347910a3cfd746def74b0fd564aa}{samp\_\-envSet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} value) +\begin{CompactList}\small\item\em Set an environment variable in a remote application. \item\end{CompactList}\item +char $\ast$ \hyperlink{samp_8h_4c75de6ddcffde6e3dde7beea68de81c}{samp\_\-paramGet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Get a parameter variable in a remote application. \item\end{CompactList}\item +int \hyperlink{samp_8h_7a5c9f092b57dfb3206c8decc8558fd3}{samp\_\-paramSet} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} value) +\begin{CompactList}\small\item\em Set an parameter variable in a remote application. \item\end{CompactList}\item +int \hyperlink{samp_8h_abeaa1ac9d09a666a9fa34a7d274483d}{samp\_\-bibLoad} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} bibcode) +\begin{CompactList}\small\item\em Exchange a bibcode. \item\end{CompactList}\item +int \hyperlink{samp_8h_a0bb33d232fcb52aaa470d1f1b1a89d7}{samp\_\-resourceLoad} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} type, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resMap) +\begin{CompactList}\small\item\em Exchange a resource list. \item\end{CompactList}\item +int \hyperlink{samp_8h_5837826e5b4e86b2dda0892c48b96faf}{samp\_\-sendGeneric} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} args\mbox{[}$\,$\mbox{]}) +\begin{CompactList}\small\item\em Send a geenric message. \item\end{CompactList}\item +int \hyperlink{samp_8h_4607721d55904450d4066c360d3dcddd}{samp\_\-sendMsg} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recip, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Send the specified message. \item\end{CompactList}\item +void \hyperlink{samp_8h_c73788ae17493c4042948f6b861ddd74}{samp\_\-notify} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recipId, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a notify() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{samp_8h_a046d61f43fce831a71621f98b6d9741}{samp\_\-notifyAll} (handle\_\-t handle, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a notifyAll() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} \hyperlink{samp_8h_919cca4cfc557e0c05914b805401fbd3}{samp\_\-call} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recipId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} tag, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a call() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{samp_8h_2cbf26c662884a4ae9587f7b9f4113a6}{samp\_\-callAll} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-tag, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a callAll() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{samp_8h_c69c39e8ee091c006289b486dee10711}{samp\_\-callAndWait} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} recipId, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-tag, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg) +\begin{CompactList}\small\item\em Make a callAndWait() call to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{samp_8h_89fc488147fe2e08b4f3c044c7079962}{samp\_\-Reply} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resp) +\begin{CompactList}\small\item\em Reply to a message. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} \hyperlink{samp_8h_0a61726448d9b1a026b20ff6beead44e}{samp\_\-clientName} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} pubId) +\begin{CompactList}\small\item\em Get the \hyperlink{structClient}{Client} name from a pubic-id. \item\end{CompactList}\item +int \hyperlink{samp_8h_3c026895e4d28567eb63c3b9cc16cd40}{samp\_\-setErr} (handle\_\-t handle, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resp) +\begin{CompactList}\small\item\em Set the error response string. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} \hyperlink{samp_8h_fd8a4da020cd2fedaf70ae8af0b6a1c8}{samp\_\-getErr} (handle\_\-t handle) +\begin{CompactList}\small\item\em Get the error response string. \item\end{CompactList}\item +int \hyperlink{samp_8h_59f85e0fce4c9ae7121c98e137d3f743}{samp\_\-receiveCall} (void $\ast$data) +\begin{CompactList}\small\item\em test.echo method \item\end{CompactList}\item +int \hyperlink{samp_8h_03be7cc9e154a6ccdd499286df640936}{samp\_\-receiveNotification} (void $\ast$data) +\begin{CompactList}\small\item\em receiveNotification () client method. \item\end{CompactList}\item +int \hyperlink{samp_8h_754b50ad59145c7fd1e4c8f4277f11e4}{samp\_\-receiveResponse} (void $\ast$data) +\begin{CompactList}\small\item\em receiveResponse () client method. \item\end{CompactList}\item +void \hyperlink{samp_8h_1cd88b9e964d61403d6aad89dddce591}{samp\_\-setHandlerReply} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} resp) +\begin{CompactList}\small\item\em Set the \hyperlink{structSamp}{Samp} Handler reply map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8h_0a0d9e41bebb554869f099dcf142a7bf}{samp\_\-getHandlerReply} (void) +\begin{CompactList}\small\item\em Get the \hyperlink{structSamp}{Samp} Handler reply map. \item\end{CompactList}\item +void \hyperlink{samp_8h_b969017f97d850b092bde60a2d445a2b}{samp\_\-setUserHandler} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, void $\ast$func) +\begin{CompactList}\small\item\em Set the user-interface handler for the mtype. \item\end{CompactList}\item +void \hyperlink{samp_8h_8b83cf8a75c16c45c547be68f0bf9f64}{samp\_\-setSampHandler} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, void $\ast$func) +\begin{CompactList}\small\item\em Set the SAMP interface handler for the mtype. \item\end{CompactList}\item +void $\ast$ \hyperlink{samp_8h_ce2ea31b9bd82db4c5040ffd0511bd8b}{samp\_\-getUserHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Get the User handler for the named mtype. \item\end{CompactList}\item +void $\ast$ \hyperlink{samp_8h_f295f9e7746644f834ac54b1deb95b4c}{samp\_\-getSampHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Get the Samphandler for the named mtype. \item\end{CompactList}\item +void \hyperlink{samp_8h_e09217f0e615e01dfcffbdebda2516e8}{samp\_\-execUserHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} params) +\begin{CompactList}\small\item\em Execute the user-defined handler for the mtype. \item\end{CompactList}\item +\hypertarget{samp_8h_1b7812ba89eebe15ad24f36a3d439a0a}{ +int \textbf{samp\_\-genericMsgHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map)} +\label{samp_8h_1b7812ba89eebe15ad24f36a3d439a0a} + +\item +int \hyperlink{samp_8h_16d8b8822d169107b8702ae753797923}{samp\_\-PingHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Is app alive and responding to messages? \item\end{CompactList}\item +int \hyperlink{samp_8h_2e342b672e77e012cc98a6f5506a44be}{samp\_\-StatusHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Return status of the task. \item\end{CompactList}\item +int \hyperlink{samp_8h_9bd8036dd65dc4f874f39568b691a123}{samp\_\-imLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle an image.load.fits message. \item\end{CompactList}\item +int \hyperlink{samp_8h_26f96dc6cbf72283e2ee9cb8b4619ed3}{samp\_\-tbLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a generic table.load.$\ast$ message. \item\end{CompactList}\item +int \hyperlink{samp_8h_750c0fee0c7a99e135299c08751f288c}{samp\_\-tbLoadFITSHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a generic table.load.fits message. \item\end{CompactList}\item +int \hyperlink{samp_8h_144ec2329355d91022d5ea38736c0093}{samp\_\-tbLoadVOTHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a generic table.load.votable message. \item\end{CompactList}\item +int \hyperlink{samp_8h_d9184eb45a5bc93b5205fd5b1c6ef688}{samp\_\-tbHighlightHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a table.highlight.row message. \item\end{CompactList}\item +int \hyperlink{samp_8h_98d68d7091c0b7790631bb53e0ace656}{samp\_\-tbSelectHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a table.select.rowList message. \item\end{CompactList}\item +int \hyperlink{samp_8h_3f5632858a2b09759ffe98cd2e183cfb}{samp\_\-pointAtHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a coord.pointAt.sky message. \item\end{CompactList}\item +int \hyperlink{samp_8h_bc319b97b3dbea29bd79c4f723db5438}{samp\_\-specLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a spectrum.load.$\ast$ message. \item\end{CompactList}\item +int \hyperlink{samp_8h_dd2bca8fa3bf3b4ebbf449edc6b65d85}{samp\_\-specSSAHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a spectrum.load.ssa-generic message. \item\end{CompactList}\item +int \hyperlink{samp_8h_c57d19afc6fa0b4bc9c7a0fd50d0f54b}{samp\_\-cmdExecHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.cmd.exec message. \item\end{CompactList}\item +int \hyperlink{samp_8h_e25a92f57babd71d43653d7fcb81025c}{samp\_\-envGetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.env.set message. \item\end{CompactList}\item +int \hyperlink{samp_8h_0910e6b9d11cdd3111c1f18450de394a}{samp\_\-envSetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.env.set message. \item\end{CompactList}\item +int \hyperlink{samp_8h_659c272ce881662c1826a04728dc06f6}{samp\_\-paramGetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.param.set message. \item\end{CompactList}\item +int \hyperlink{samp_8h_071aa9e32f2e94d5b667e87cf65d2bdf}{samp\_\-paramSetHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a client.param.set message. \item\end{CompactList}\item +int \hyperlink{samp_8h_262bf09278c61b60b5189fef7f26d26b}{samp\_\-bibcodeHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em Handle a bibcode.load message. \item\end{CompactList}\item +int \hyperlink{samp_8h_c0bf7cf7fea362c0c82ad7bc3f267c48}{samp\_\-resLoadHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{samp_8h_287569451dc1bf59d1f9f6d13b56716d}{samp\_\-resConeHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{samp_8h_8b2300222d7b11f144eb4385412e69a5}{samp\_\-resSiapHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{samp_8h_866578a01c3b762435823b1b11869c42}{samp\_\-resSsapHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{samp_8h_ad42ca17cbaf23012ad497559ea45e4c}{samp\_\-resTapHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +int \hyperlink{samp_8h_fa207ebdc587ba5eeab60fbf79b635d4}{samp\_\-resVOSpaceHandler} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} msg\_\-map) +\begin{CompactList}\small\item\em handle a voresource.loadlist message \item\end{CompactList}\item +\hypertarget{samp_8h_e743048f5b1f903496b2a8a2e9666367}{ +void \textbf{samp\_\-printMessage} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} sender, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} msg\_\-id, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} params)} +\label{samp_8h_e743048f5b1f903496b2a8a2e9666367} + +\item +void \hyperlink{samp_8h_a8a947c24f2c9333adf4e5d7fa11d134}{samp\_\-printMap} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\item +int \hyperlink{samp_8h_5361571754505eaefdf5739cd3e9519e}{samp\_\-nullResponse} (void $\ast$data) +\item +\hypertarget{samp_8h_cc687f745f400b41c9af4f6419bf9bf8}{ +int \textbf{samp\_\-testEcho} (void $\ast$data)} +\label{samp_8h_cc687f745f400b41c9af4f6419bf9bf8} + +\item +handle\_\-t \hyperlink{samp_8h_ef92557afa5ed6731ac0a0a1ba6dfd7c}{samp\_\-hubOpen} (\hyperlink{structSamp}{Samp} $\ast$samp) +\begin{CompactList}\small\item\em Discover and open a connection to the SAMP \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{samp_8h_39a580ced499e50d39d327f7709834e7}{samp\_\-hubClose} (handle\_\-t handle) +\begin{CompactList}\small\item\em Close a connection to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{samp_8h_d0343ad884d5a958d7d91928ad06a369}{samp\_\-getAvailableHubs} (handle\_\-t handle) +\begin{CompactList}\small\item\em Get a list of available Hubs. \item\end{CompactList}\item +\hypertarget{samp_8h_4b4292d136520c3d276d655e2093dd30}{ +char $\ast$ \textbf{samp\_\-getActiveHubName} (handle\_\-t handle)} +\label{samp_8h_4b4292d136520c3d276d655e2093dd30} + +\item +\hypertarget{samp_8h_bf266e81b16f556e2f42cad5a2eb9157}{ +int \textbf{samp\_\-getActiveHub} (handle\_\-t handle)} +\label{samp_8h_bf266e81b16f556e2f42cad5a2eb9157} + +\item +int \hyperlink{samp_8h_a927eb8dcb67e245aeb5a8a4feeb6230}{samp\_\-hubRunning} (void) +\item +\hypertarget{samp_8h_12c4307b544d66d57d54cbc4c031dd35}{ +int \textbf{samp\_\-hubInit} (handle\_\-t samp, char $\ast$appName, char $\ast$descr)} +\label{samp_8h_12c4307b544d66d57d54cbc4c031dd35} + +\item +int \hyperlink{samp_8h_265b5d07cce485a6979fe5f4a2217624}{samp\_\-processHubEvent} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} params) +\begin{CompactList}\small\item\em Determine the type of \hyperlink{structHub}{Hub} event mtype. \item\end{CompactList}\item +int \hyperlink{samp_8h_a48b9a99f22537127df46a94dfa9ae4a}{samp\_\-hubEvent} (\hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype) +\begin{CompactList}\small\item\em Determine the type of \hyperlink{structHub}{Hub} event mtype. \item\end{CompactList}\item +int \hyperlink{samp_8h_77a14721e2373c805b58f69a018ea69c}{samp\_\-hubRegister} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Send a Register message to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{samp_8h_b0c37311ca30e1fdadfdd1fd16ff3ab4}{samp\_\-hubUnRegister} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Send a UnRegister message to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{samp_8h_6c7b8a8ff1f3c2435d153bc08da87dce}{samp\_\-hubSendShutdown} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Send a samp.app.event.shutdown message to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{samp_8h_fc0bfbd699ab2cbce2f755a0506ca6dc}{samp\_\-hubSetXmlrpcCallback} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Set the client callback and send to \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{samp_8h_155739318fa72883a3e32fccf8a6d5c9}{samp\_\-hubPing} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Ping the \hyperlink{structHub}{Hub} to see if it is alive. \item\end{CompactList}\item +int \hyperlink{samp_8h_bf1ae8a1c9c8cf520a22e6ea4d815712}{samp\_\-hubDeclareMetadata} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Declare \char`\"{}standard\char`\"{} metadata to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +int \hyperlink{samp_8h_a6c0f67a76bd1f27898a66fe26b53fdd}{samp\_\-hubDeclareSubscriptions} (\hyperlink{structHub}{Hub} $\ast$\hyperlink{sampHub_8c_d702b07240de0e0cf9e4b781a38317ad}{hub}) +\begin{CompactList}\small\item\em Declare mtype subscriptions to the \hyperlink{structHub}{Hub}. \item\end{CompactList}\item +handle\_\-t \hyperlink{samp_8h_cdc925da798ee7a1ce30427d47812bd2}{samp\_\-newList} () +\begin{CompactList}\small\item\em Create a new List object. \item\end{CompactList}\item +void \hyperlink{samp_8h_b162ae9b9f98da80f6bb5c34b5cbcbf6}{samp\_\-freeList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list) +\begin{CompactList}\small\item\em Free the given List object. \item\end{CompactList}\item +int \hyperlink{samp_8h_c260afb0cbf19b427e3eba96a2341e52}{samp\_\-listLen} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list) +\begin{CompactList}\small\item\em Get number of elements in a List. \item\end{CompactList}\item +void \hyperlink{samp_8h_5b69180b036e58528c98b1cf5a42825a}{samp\_\-setStringInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, char $\ast$value) +\begin{CompactList}\small\item\em Set a string in a List (append). \item\end{CompactList}\item +void \hyperlink{samp_8h_ea188bb711f3b5549d11204b0ff2da08}{samp\_\-setMapInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\begin{CompactList}\small\item\em Set a Map in a List (append). \item\end{CompactList}\item +void \hyperlink{samp_8h_0ff97d44e62b7c88a046a29324552400}{samp\_\-setListInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list1, \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list2) +\begin{CompactList}\small\item\em Set a List in another List (append). \item\end{CompactList}\item +void \hyperlink{samp_8h_2d8a8a26d7284bb211a933895cddd29c}{samp\_\-setIntInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int value) +\begin{CompactList}\small\item\em Set an Int in a List (append). \item\end{CompactList}\item +void \hyperlink{samp_8h_041a551aff57ca03f3ff72a9803e2b58}{samp\_\-setFloatInList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, float value) +\begin{CompactList}\small\item\em Set a Float in a List (append). \item\end{CompactList}\item +char $\ast$ \hyperlink{samp_8h_b101c5b1175490474e41ac9060bdaabf}{samp\_\-getStringFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a string from the List. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8h_33ca96ee3a8e7d26356c7b66f469da74}{samp\_\-getMapFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a Map from the List. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{samp_8h_b74e90fdfe79b1c4f7668fdb28d041a1}{samp\_\-getListFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a List from the List. \item\end{CompactList}\item +\hypertarget{samp_8h_1174e001b2d16ed0aa1b317cfc883af1}{ +int \textbf{samp\_\-getIntFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index)} +\label{samp_8h_1174e001b2d16ed0aa1b317cfc883af1} + +\item +float \hyperlink{samp_8h_cf9b570dd76203d2299ed7bdba048bb9}{samp\_\-getFloatFromList} (\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list, int index) +\begin{CompactList}\small\item\em Get a Float from the List. \item\end{CompactList}\item +handle\_\-t \hyperlink{samp_8h_d88b5d5e9014deba8071f7defd220dbb}{samp\_\-newMap} (void) +\begin{CompactList}\small\item\em Create a new Map object. \item\end{CompactList}\item +void \hyperlink{samp_8h_fe80438de542c6657d623993360b37d1}{samp\_\-freeMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\begin{CompactList}\small\item\em Free the given Map object. \item\end{CompactList}\item +\hypertarget{samp_8h_1c99f7146ad3acd3e381a02d5df1234f}{ +int \textbf{samp\_\-getMapSize} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map)} +\label{samp_8h_1c99f7146ad3acd3e381a02d5df1234f} + +\item +\hypertarget{samp_8h_4c8a1b402743b52f2837e97cf41e9e34}{ +char $\ast$ \textbf{samp\_\-getMapKey} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, int index)} +\label{samp_8h_4c8a1b402743b52f2837e97cf41e9e34} + +\item +\hypertarget{samp_8h_7dcdf07dd7f3252f3bf2dd5002c62251}{ +char $\ast$ \textbf{samp\_\-getMapVal} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, int index)} +\label{samp_8h_7dcdf07dd7f3252f3bf2dd5002c62251} + +\item +void \hyperlink{samp_8h_b9b2157de89369eb5cd95bfe804eb89a}{samp\_\-setStringInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, char $\ast$value) +\begin{CompactList}\small\item\em Set a string in a Map (append). \item\end{CompactList}\item +void \hyperlink{samp_8h_f102490efe1b92d99b67f244dc498c7b}{samp\_\-setMapInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map1, char $\ast$key, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map2) +\begin{CompactList}\small\item\em Set a Map in a Map (append). \item\end{CompactList}\item +void \hyperlink{samp_8h_362c2f670c98dd6a3ef69debd1871604}{samp\_\-setListInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} list) +\begin{CompactList}\small\item\em Set a List in a Map (append). \item\end{CompactList}\item +void \hyperlink{samp_8h_c22ec42dbf9a01c9b4e00cf011e7eb9d}{samp\_\-setIntInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, int value) +\begin{CompactList}\small\item\em Set a Int in a Map (append). \item\end{CompactList}\item +void \hyperlink{samp_8h_0f07ae542f5b317311b3799bd96a88fd}{samp\_\-setFloatInMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key, float value) +\begin{CompactList}\small\item\em Set a string in a Map (append). \item\end{CompactList}\item +char $\ast$ \hyperlink{samp_8h_e615ad9482fa88705b2488a37c987c2a}{samp\_\-getStringFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a string from the Map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} \hyperlink{samp_8h_525e8ffdfa32867f392f2c1340215453}{samp\_\-getMapFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a Map from the Map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} \hyperlink{samp_8h_31ddb90cf2184ae0151b9e7ec8c1a51f}{samp\_\-getListFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a LIST from the Map. \item\end{CompactList}\item +int \hyperlink{samp_8h_594a51772e9b0693a3c77006eb88c96a}{samp\_\-getIntFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a integer from the Map. \item\end{CompactList}\item +float \hyperlink{samp_8h_89c38f762afd50c85f6ff659bdf0a923}{samp\_\-getFloatFromMap} (\hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map, char $\ast$key) +\begin{CompactList}\small\item\em Get a float from the Map. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} \hyperlink{samp_8h_d343c08e241ff4e17a0eb8fa3d9f4781}{samp\_\-newMsg} (void) +\begin{CompactList}\small\item\em Create a new Msg object. \item\end{CompactList}\item +void \hyperlink{samp_8h_adf2979a5fad0c9a855740330b7fd9ce}{samp\_\-freeMsg} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg) +\begin{CompactList}\small\item\em Free the given Msg object. \item\end{CompactList}\item +\hypertarget{samp_8h_34c9e29fa57216f19a70764df8e5826b}{ +void \textbf{samp\_\-msgMType} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} mtype)} +\label{samp_8h_34c9e29fa57216f19a70764df8e5826b} + +\item +void \hyperlink{samp_8h_281c8f7f8b21a74704dd200d5aaed481}{samp\_\-msgParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, \hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} param) +\begin{CompactList}\small\item\em Add a parameter to the Msg. \item\end{CompactList}\item +\hypertarget{samp_8h_cb9eff6a0f442a1c9fde13c1e9fc097d}{ +char $\ast$ \textbf{samp\_\-msgTag} (void)} +\label{samp_8h_cb9eff6a0f442a1c9fde13c1e9fc097d} + +\item +\hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} \hyperlink{samp_8h_3e2fe98bee9ac2b0c882de78e9b5085f}{samp\_\-newParam} (void) +\begin{CompactList}\small\item\em Create a new Param object. \item\end{CompactList}\item +void \hyperlink{samp_8h_5a6fbf3ac37164268afae80c35666c5e}{samp\_\-freeParam} (\hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} param) +\begin{CompactList}\small\item\em Free the given Msg object. \item\end{CompactList}\item +\hyperlink{sampDecl_8h_4c5a7aff173725461e76e5f0183d7ed8}{Param} \hyperlink{samp_8h_f2953eb691b695482ffbbea71948374f}{samp\_\-paramInit} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg) +\begin{CompactList}\small\item\em Get number of Params. \item\end{CompactList}\item +\hypertarget{samp_8h_62c2d0b887252730fd6f7bdaa7211403}{ +void \textbf{samp\_\-addStringParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} val)} +\label{samp_8h_62c2d0b887252730fd6f7bdaa7211403} + +\item +void \hyperlink{samp_8h_e3e90c84dd6b1a08d8af18ca9e168b37}{samp\_\-addMapParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} val) +\begin{CompactList}\small\item\em Add a parameter to the Param. \item\end{CompactList}\item +void \hyperlink{samp_8h_24f72c4ed033ed2f219b420e491b3c0f}{samp\_\-addListParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, \hyperlink{sampDecl_8h_39f9d235896a8fd920f319105eb82791}{List} val) +\begin{CompactList}\small\item\em Add a parameter to the Param. \item\end{CompactList}\item +void \hyperlink{samp_8h_6897da75444209fc1819042bde906aa6}{samp\_\-addIntParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, int val) +\begin{CompactList}\small\item\em Add a $<$SAMP int$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. \item\end{CompactList}\item +void \hyperlink{samp_8h_d297770f4ab1338697d69b2705d6c1d9}{samp\_\-addFloatParam} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg, char $\ast$keyw, float val) +\begin{CompactList}\small\item\em Add a $<$SAMP float$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. \item\end{CompactList}\item +int \hyperlink{samp_8h_5a44618b7681acff67b3883341494d2d}{samp\_\-paramLen} (\hyperlink{sampDecl_8h_eb3d03dd240212c044285bdd522e3b2b}{Msg} msg) +\begin{CompactList}\small\item\em Get number of Params. \item\end{CompactList}\item +void \hyperlink{samp_8h_329a8a5f83162ed49baa28f008131d45}{sampLog} (handle\_\-t handle, char $\ast$format,...) +\begin{CompactList}\small\item\em SAMP message logger. \item\end{CompactList}\item +void \hyperlink{samp_8h_65e3987c9b510018dcdd91203b437e40}{sampTrace} (handle\_\-t handle, char $\ast$format,...) +\begin{CompactList}\small\item\em SAMP tracer. \item\end{CompactList}\item +handle\_\-t \hyperlink{samp_8h_711aa545f55e9307f662062deefd5903}{samp\_\-newHandle} (void $\ast$ptr) +\begin{CompactList}\small\item\em Get an unused object handle. \item\end{CompactList}\item +void \hyperlink{samp_8h_f02a7c646a9ed56e545d8bf33434c207}{samp\_\-freeHandle} (handle\_\-t handle) +\begin{CompactList}\small\item\em Free the handle for later re-use. \item\end{CompactList}\item +handle\_\-t \hyperlink{samp_8h_4d0aef2f09b9cce38d4ea8024831c6e5}{samp\_\-P2H} (void $\ast$ptr) +\begin{CompactList}\small\item\em Convert a pointer to a handle. \item\end{CompactList}\item +\hypertarget{samp_8h_598e10661c7c7f4d13ae721c03056497}{ +void $\ast$ \textbf{samp\_\-H2P} (handle\_\-t handle)} +\label{samp_8h_598e10661c7c7f4d13ae721c03056497} + +\item +char $\ast$ \hyperlink{samp_8h_5e555288172e59ccf28c901c6bc10793}{samp\_\-app2id} (handle\_\-t handle, char $\ast$appName) +\begin{CompactList}\small\item\em Convert an application name to a public-ID. \item\end{CompactList}\item +char $\ast$ \hyperlink{samp_8h_343e25bf33431d973d9f81bc25eddcf7}{samp\_\-id2app} (handle\_\-t handle, char $\ast$pubId) +\begin{CompactList}\small\item\em Convert a public-ID to the application name. \item\end{CompactList}\item +int \hyperlink{samp_8h_6157dc4b47c65323a3015a434cd02e69}{samp\_\-serverPort} (void) +\begin{CompactList}\small\item\em Return a unique port number for the server. \item\end{CompactList}\item +void \hyperlink{samp_8h_5b2ef060b3adb18aea7a5a6099c4d0d0}{samp\_\-printMetadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Print the metadata for the application. \item\end{CompactList}\item +char $\ast$ \hyperlink{samp_8h_def0598aa30c5c1a2276cdddf705de69}{samp\_\-getMetadata} (handle\_\-t handle, \hyperlink{sampDecl_8h_2efe6d463d80744789f228f5dc4baa39}{String} name) +\begin{CompactList}\small\item\em Get the metadata item for the application. \item\end{CompactList}\end{CompactItemize} + + +\label{_details} +\hypertarget{_details}{} +\subsection{Detailed Description} +SAMP interface include file. + +SAMP.H -- SAMP interface include file. + +\begin{Desc} +\item[Author:]Mike FItzpatrick \end{Desc} +\begin{Desc} +\item[Date:]7/10/09 \end{Desc} + + +\subsection{Define Documentation} +\hypertarget{samp_8h_fc367e0d449c3afa2d429eedc85407aa}{ +\index{samp.h@{samp.h}!HUB\_\-SHUTDOWN@{HUB\_\-SHUTDOWN}} +\index{HUB\_\-SHUTDOWN@{HUB\_\-SHUTDOWN}!samp.h@{samp.h}} +\subsubsection[{HUB\_\-SHUTDOWN}]{\setlength{\rightskip}{0pt plus 5cm}\#define HUB\_\-SHUTDOWN~0}} +\label{samp_8h_fc367e0d449c3afa2d429eedc85407aa} + + +Special \hyperlink{structHub}{Hub} events + +Referenced by samp\_\-hubEvent(), and samp\_\-processHubEvent(). + +\subsection{Typedef Documentation} +\hypertarget{samp_8h_39f9d235896a8fd920f319105eb82791}{ +\index{samp.h@{samp.h}!List@{List}} +\index{List@{List}!samp.h@{samp.h}} +\subsubsection[{List}]{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf List}}} +\label{samp_8h_39f9d235896a8fd920f319105eb82791} + + +SAMP Map datatype \hypertarget{samp_8h_39a90bc041db57e1a6ba736ba91eee30}{ +\index{samp.h@{samp.h}!Map@{Map}} +\index{Map@{Map}!samp.h@{samp.h}} +\subsubsection[{Map}]{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf Map}}} +\label{samp_8h_39a90bc041db57e1a6ba736ba91eee30} + + +generic object handle \hypertarget{samp_8h_eb3d03dd240212c044285bdd522e3b2b}{ +\index{samp.h@{samp.h}!Msg@{Msg}} +\index{Msg@{Msg}!samp.h@{samp.h}} +\subsubsection[{Msg}]{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf Msg}}} +\label{samp_8h_eb3d03dd240212c044285bdd522e3b2b} + + +SAMP List datatype \hypertarget{samp_8h_4c5a7aff173725461e76e5f0183d7ed8}{ +\index{samp.h@{samp.h}!Param@{Param}} +\index{Param@{Param}!samp.h@{samp.h}} +\subsubsection[{Param}]{\setlength{\rightskip}{0pt plus 5cm}typedef int {\bf Param}}} +\label{samp_8h_4c5a7aff173725461e76e5f0183d7ed8} + + +SAMP Msg datatype \hypertarget{samp_8h_2efe6d463d80744789f228f5dc4baa39}{ +\index{samp.h@{samp.h}!String@{String}} +\index{String@{String}!samp.h@{samp.h}} +\subsubsection[{String}]{\setlength{\rightskip}{0pt plus 5cm}typedef char$\ast$ {\bf String}}} +\label{samp_8h_2efe6d463d80744789f228f5dc4baa39} + + +SAMP Param datatype + +\subsection{Function Documentation} +\hypertarget{samp_8h_8a2111bbe4c88cef635e3bf67e899563}{ +\index{samp.h@{samp.h}!samp\_\-addClient@{samp\_\-addClient}} +\index{samp\_\-addClient@{samp\_\-addClient}!samp.h@{samp.h}} +\subsubsection[{samp\_\-addClient}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-addClient (handle\_\-t {\em handle}, \/ {\bf String} {\em name}, \/ {\bf String} {\em id})}} +\label{samp_8h_8a2111bbe4c88cef635e3bf67e899563} + + +SAMP\_\-ADDCLIENT -- Add a newly registered client to the list of known apps so we can do the public-private name translation. \hypertarget{samp_8h_d297770f4ab1338697d69b2705d6c1d9}{ +\index{samp.h@{samp.h}!samp\_\-addFloatParam@{samp\_\-addFloatParam}} +\index{samp\_\-addFloatParam@{samp\_\-addFloatParam}!samp.h@{samp.h}} +\subsubsection[{samp\_\-addFloatParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addFloatParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ float {\em val})}} +\label{samp_8h_d297770f4ab1338697d69b2705d6c1d9} + + +Add a $<$SAMP float$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +SAMP\_\-ADDFLOATPARAM -- Add a $<$SAMP float$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]floating point value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-coordPointAtSky(), and samp\_\-sendGeneric().\hypertarget{samp_8h_6897da75444209fc1819042bde906aa6}{ +\index{samp.h@{samp.h}!samp\_\-addIntParam@{samp\_\-addIntParam}} +\index{samp\_\-addIntParam@{samp\_\-addIntParam}!samp.h@{samp.h}} +\subsubsection[{samp\_\-addIntParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addIntParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ int {\em val})}} +\label{samp_8h_6897da75444209fc1819042bde906aa6} + + +Add a $<$SAMP int$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +SAMP\_\-ADDINTPARAM -- Add a $<$SAMP int$>$=\char`\"{}\char`\"{}$>$ parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]integer value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-sendGeneric(), and samp\_\-tableHighlightRow().\hypertarget{samp_8h_24f72c4ed033ed2f219b420e491b3c0f}{ +\index{samp.h@{samp.h}!samp\_\-addListParam@{samp\_\-addListParam}} +\index{samp\_\-addListParam@{samp\_\-addListParam}!samp.h@{samp.h}} +\subsubsection[{samp\_\-addListParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addListParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ {\bf List} {\em val})}} +\label{samp_8h_24f72c4ed033ed2f219b420e491b3c0f} + + +Add a parameter to the Param. + +SAMP\_\-ADDLISTPARAM -- Add a List parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]value list \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-tableSelectRowList().\hypertarget{samp_8h_e3e90c84dd6b1a08d8af18ca9e168b37}{ +\index{samp.h@{samp.h}!samp\_\-addMapParam@{samp\_\-addMapParam}} +\index{samp\_\-addMapParam@{samp\_\-addMapParam}!samp.h@{samp.h}} +\subsubsection[{samp\_\-addMapParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-addMapParam ({\bf Msg} {\em msg}, \/ char $\ast$ {\em keyw}, \/ {\bf Map} {\em val})}} +\label{samp_8h_e3e90c84dd6b1a08d8af18ca9e168b37} + + +Add a parameter to the Param. + +SAMP\_\-ADDMAPPARAM -- Add a Map parameter to the Param. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em val}]value map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-resourceLoad(), and samp\_\-specLoadSSAGeneric().\hypertarget{samp_8h_5e555288172e59ccf28c901c6bc10793}{ +\index{samp.h@{samp.h}!samp\_\-app2id@{samp\_\-app2id}} +\index{samp\_\-app2id@{samp\_\-app2id}!samp.h@{samp.h}} +\subsubsection[{samp\_\-app2id}]{\setlength{\rightskip}{0pt plus 5cm}pubId samp\_\-app2id (handle\_\-t {\em handle}, \/ char $\ast$ {\em appName})}} +\label{samp_8h_5e555288172e59ccf28c901c6bc10793} + + +Convert an application name to a public-ID. + +SAMP\_\-APP2ID -- Convert an application name to a public-ID. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em appName}]name of registered application \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]public ID of application \end{Desc} + + +Referenced by samp\_\-call(), samp\_\-callAndWait(), samp\_\-envGet(), samp\_\-notify(), samp\_\-paramGet(), samp\_\-Ping(), and samp\_\-sendMsg().\hypertarget{samp_8h_262bf09278c61b60b5189fef7f26d26b}{ +\index{samp.h@{samp.h}!samp\_\-bibcodeHandler@{samp\_\-bibcodeHandler}} +\index{samp\_\-bibcodeHandler@{samp\_\-bibcodeHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-bibcodeHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-bibcodeHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_262bf09278c61b60b5189fef7f26d26b} + + +Handle a bibcode.load message. + +SAMP\_\-BIBCODEHANDLER -- Handle a bibcode.load message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_abeaa1ac9d09a666a9fa34a7d274483d}{ +\index{samp.h@{samp.h}!samp\_\-bibLoad@{samp\_\-bibLoad}} +\index{samp\_\-bibLoad@{samp\_\-bibLoad}!samp.h@{samp.h}} +\subsubsection[{samp\_\-bibLoad}]{\setlength{\rightskip}{0pt plus 5cm}val samp\_\-bibLoad (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em bibcode})}} +\label{samp_8h_abeaa1ac9d09a666a9fa34a7d274483d} + + +Exchange a bibcode. + +SAMP\_\-BIBLOAD -- Exchange a bibcode. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em bibcode}]Bibcode string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_919cca4cfc557e0c05914b805401fbd3}{ +\index{samp.h@{samp.h}!samp\_\-call@{samp\_\-call}} +\index{samp\_\-call@{samp\_\-call}!samp.h@{samp.h}} +\subsubsection[{samp\_\-call}]{\setlength{\rightskip}{0pt plus 5cm}{\bf String} msg id samp\_\-call (handle\_\-t {\em handle}, \/ {\bf String} {\em recipId}, \/ {\bf String} {\em msg\_\-tag}, \/ {\bf Map} {\em msg})}} +\label{samp_8h_919cca4cfc557e0c05914b805401fbd3} + + +Make a call() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-CALL -- Make a call() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recipId}]recipient ID \item[{\em msg\_\-tag}]message tag \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]message ID \end{Desc} + + +Referenced by samp\_\-sendMsg().\hypertarget{samp_8h_2cbf26c662884a4ae9587f7b9f4113a6}{ +\index{samp.h@{samp.h}!samp\_\-callAll@{samp\_\-callAll}} +\index{samp\_\-callAll@{samp\_\-callAll}!samp.h@{samp.h}} +\subsubsection[{samp\_\-callAll}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} calls samp\_\-callAll (handle\_\-t {\em handle}, \/ {\bf String} {\em msg\_\-tag}, \/ {\bf Map} {\em msg})}} +\label{samp_8h_2cbf26c662884a4ae9587f7b9f4113a6} + + +Make a callAll() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-CALLALL -- Make a callAll() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em msg\_\-tag}]message tag \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +Referenced by samp\_\-Ping(), and samp\_\-sendMsg().\hypertarget{samp_8h_c69c39e8ee091c006289b486dee10711}{ +\index{samp.h@{samp.h}!samp\_\-callAndWait@{samp\_\-callAndWait}} +\index{samp\_\-callAndWait@{samp\_\-callAndWait}!samp.h@{samp.h}} +\subsubsection[{samp\_\-callAndWait}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-callAndWait (handle\_\-t {\em handle}, \/ {\bf String} {\em recipId}, \/ {\bf String} {\em msg\_\-tag}, \/ {\bf Map} {\em msg})}} +\label{samp_8h_c69c39e8ee091c006289b486dee10711} + + +Make a callAndWait() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-CALLANDWAIT -- Make a callAndWait() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recipId}]recipient ID \item[{\em msg\_\-tag}]message tag \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +Referenced by samp\_\-Ping(), and samp\_\-sendMsg().\hypertarget{samp_8h_0a61726448d9b1a026b20ff6beead44e}{ +\index{samp.h@{samp.h}!samp\_\-clientName@{samp\_\-clientName}} +\index{samp\_\-clientName@{samp\_\-clientName}!samp.h@{samp.h}} +\subsubsection[{samp\_\-clientName}]{\setlength{\rightskip}{0pt plus 5cm}name samp\_\-clientName (handle\_\-t {\em handle}, \/ {\bf String} {\em pubId})}} +\label{samp_8h_0a61726448d9b1a026b20ff6beead44e} + + +Get the \hyperlink{structClient}{Client} name from a pubic-id. + +SAMP\_\-CLIENTNAME -- Get the \hyperlink{structClient}{Client} name from a pubic-id. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em pubId}]public ID \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]declared application name \end{Desc} +\hypertarget{samp_8h_be012673358bfd254e2c6ad9f6e92240}{ +\index{samp.h@{samp.h}!samp\_\-cmdExec@{samp\_\-cmdExec}} +\index{samp\_\-cmdExec@{samp\_\-cmdExec}!samp.h@{samp.h}} +\subsubsection[{samp\_\-cmdExec}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-cmdExec (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em cmd})}} +\label{samp_8h_be012673358bfd254e2c6ad9f6e92240} + + +Execute a command in a remote application. + +SAMP\_\-CMDEXEC -- Execute a command in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em cmd}]Command string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_c57d19afc6fa0b4bc9c7a0fd50d0f54b}{ +\index{samp.h@{samp.h}!samp\_\-cmdExecHandler@{samp\_\-cmdExecHandler}} +\index{samp\_\-cmdExecHandler@{samp\_\-cmdExecHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-cmdExecHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-cmdExecHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_c57d19afc6fa0b4bc9c7a0fd50d0f54b} + + +Handle a client.cmd.exec message. + +SAMP\_\-CMDEXECHANDLER -- Handle a client.cmd.exec message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_0651eec8ddc8707bb8fbc4dfdcfff5e2}{ +\index{samp.h@{samp.h}!samp\_\-coordPointAtSky@{samp\_\-coordPointAtSky}} +\index{samp\_\-coordPointAtSky@{samp\_\-coordPointAtSky}!samp.h@{samp.h}} +\subsubsection[{samp\_\-coordPointAtSky}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-coordPointAtSky (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ float {\em ra}, \/ float {\em dec})}} +\label{samp_8h_0651eec8ddc8707bb8fbc4dfdcfff5e2} + + +Tell an app to point at an RA/Dec coordinate. + +SAMP\_\-COORDPOINTATSKY -- Tell an app to point at an RA/Dec coordinate. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em ra}]RA of coord in degrees \item[{\em dec}]Dec of coord in degrees \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_94cdccbcfa524fa515de77544b6c6eaa}{ +\index{samp.h@{samp.h}!samp\_\-DeclareMetadata@{samp\_\-DeclareMetadata}} +\index{samp\_\-DeclareMetadata@{samp\_\-DeclareMetadata}!samp.h@{samp.h}} +\subsubsection[{samp\_\-DeclareMetadata}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-DeclareMetadata (handle\_\-t {\em handle})}} +\label{samp_8h_94cdccbcfa524fa515de77544b6c6eaa} + + +(Re)Declare all of our metadata. + +SAMP\_\-DECLAREMETATA -- (Re)Declare all of our metadata. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_ef695801c121c6191d3af4574569ab8c}{ +\index{samp.h@{samp.h}!samp\_\-DeclareSubscriptions@{samp\_\-DeclareSubscriptions}} +\index{samp\_\-DeclareSubscriptions@{samp\_\-DeclareSubscriptions}!samp.h@{samp.h}} +\subsubsection[{samp\_\-DeclareSubscriptions}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-DeclareSubscriptions (handle\_\-t {\em handle})}} +\label{samp_8h_ef695801c121c6191d3af4574569ab8c} + + +Declare the messages we're interested in. + +SAMP\_\-DECLARESUBSCRIPIONS -- Declare the messages we're interested in. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +Referenced by samp\_\-Unsubscribe().\hypertarget{samp_8h_96851f1c15e4baf67949d86d15f2568d}{ +\index{samp.h@{samp.h}!samp\_\-defaultReplyHandler@{samp\_\-defaultReplyHandler}} +\index{samp\_\-defaultReplyHandler@{samp\_\-defaultReplyHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-defaultReplyHandler}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-defaultReplyHandler (handle\_\-t {\em handle})}} +\label{samp_8h_96851f1c15e4baf67949d86d15f2568d} + + +The interface's default Reply handler. + +SAMP\_\-DEFAULTREPLYHANDLER -- The interface's default Reply handler. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_ba313c7608a7658c673065c83113ec5b}{ +\index{samp.h@{samp.h}!samp\_\-envGet@{samp\_\-envGet}} +\index{samp\_\-envGet@{samp\_\-envGet}!samp.h@{samp.h}} +\subsubsection[{samp\_\-envGet}]{\setlength{\rightskip}{0pt plus 5cm}val samp\_\-envGet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name})}} +\label{samp_8h_ba313c7608a7658c673065c83113ec5b} + + +Get an environment variable in a remote application. + +SAMP\_\-ENVGET -- Get an environment variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]NULL, Value of variable, or list of values \end{Desc} +\hypertarget{samp_8h_e25a92f57babd71d43653d7fcb81025c}{ +\index{samp.h@{samp.h}!samp\_\-envGetHandler@{samp\_\-envGetHandler}} +\index{samp\_\-envGetHandler@{samp\_\-envGetHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-envGetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-envGetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_e25a92f57babd71d43653d7fcb81025c} + + +Handle a client.env.set message. + +SAMP\_\-ENVGETHANDLER -- Handle a client.env.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_e842347910a3cfd746def74b0fd564aa}{ +\index{samp.h@{samp.h}!samp\_\-envSet@{samp\_\-envSet}} +\index{samp\_\-envSet@{samp\_\-envSet}!samp.h@{samp.h}} +\subsubsection[{samp\_\-envSet}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-envSet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name}, \/ {\bf String} {\em value})}} +\label{samp_8h_e842347910a3cfd746def74b0fd564aa} + + +Set an environment variable in a remote application. + +SAMP\_\-ENVSET -- Set an environment variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \item[{\em value}]Value of variable or NULL \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_0910e6b9d11cdd3111c1f18450de394a}{ +\index{samp.h@{samp.h}!samp\_\-envSetHandler@{samp\_\-envSetHandler}} +\index{samp\_\-envSetHandler@{samp\_\-envSetHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-envSetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-envSetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_0910e6b9d11cdd3111c1f18450de394a} + + +Handle a client.env.set message. + +SAMP\_\-ENVSETHANDLER -- Handle a client.env.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_e09217f0e615e01dfcffbdebda2516e8}{ +\index{samp.h@{samp.h}!samp\_\-execUserHandler@{samp\_\-execUserHandler}} +\index{samp\_\-execUserHandler@{samp\_\-execUserHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-execUserHandler}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-execUserHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em params})}} +\label{samp_8h_e09217f0e615e01dfcffbdebda2516e8} + + +Execute the user-defined handler for the mtype. + +SAMP\_\-EXECUSERHANDLER -- Execute the user-defined handler for the mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message-id string \item[{\em params}]Mtype parameter Map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-receiveCall(), samp\_\-receiveNotification(), and samp\_\-receiveResponse().\hypertarget{samp_8h_f02a7c646a9ed56e545d8bf33434c207}{ +\index{samp.h@{samp.h}!samp\_\-freeHandle@{samp\_\-freeHandle}} +\index{samp\_\-freeHandle@{samp\_\-freeHandle}!samp.h@{samp.h}} +\subsubsection[{samp\_\-freeHandle}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeHandle (handle\_\-t {\em handle})}} +\label{samp_8h_f02a7c646a9ed56e545d8bf33434c207} + + +Free the handle for later re-use. + +SAMP\_\-FREEHANDLE -- Free the handle for later re-use. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]object handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-hubClose(), and sampClose().\hypertarget{samp_8h_b162ae9b9f98da80f6bb5c34b5cbcbf6}{ +\index{samp.h@{samp.h}!samp\_\-freeList@{samp\_\-freeList}} +\index{samp\_\-freeList@{samp\_\-freeList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-freeList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeList ({\bf List} {\em list})}} +\label{samp_8h_b162ae9b9f98da80f6bb5c34b5cbcbf6} + + +Free the given List object. + +SAMP\_\-FREELIST -- Free the given List object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-mapClients(), and samp\_\-tableSelectRowList().\hypertarget{samp_8h_fe80438de542c6657d623993360b37d1}{ +\index{samp.h@{samp.h}!samp\_\-freeMap@{samp\_\-freeMap}} +\index{samp\_\-freeMap@{samp\_\-freeMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-freeMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeMap ({\bf Map} {\em map})}} +\label{samp_8h_fe80438de542c6657d623993360b37d1} + + +Free the given Map object. + +SAMP\_\-FREEMAP -- Free the given Map object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]Map object to free \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-envGetHandler(), samp\_\-hubDeclareSubscriptions(), samp\_\-paramGetHandler(), and samp\_\-Ping().\hypertarget{samp_8h_adf2979a5fad0c9a855740330b7fd9ce}{ +\index{samp.h@{samp.h}!samp\_\-freeMsg@{samp\_\-freeMsg}} +\index{samp\_\-freeMsg@{samp\_\-freeMsg}!samp.h@{samp.h}} +\subsubsection[{samp\_\-freeMsg}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeMsg ({\bf Msg} {\em msg})}} +\label{samp_8h_adf2979a5fad0c9a855740330b7fd9ce} + + +Free the given Msg object. + +SAMP\_\-FREEMSG -- Free the given Msg object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]Msg object to free \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envGet(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Ping(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().\hypertarget{samp_8h_5a6fbf3ac37164268afae80c35666c5e}{ +\index{samp.h@{samp.h}!samp\_\-freeParam@{samp\_\-freeParam}} +\index{samp\_\-freeParam@{samp\_\-freeParam}!samp.h@{samp.h}} +\subsubsection[{samp\_\-freeParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-freeParam ({\bf Param} {\em param})}} +\label{samp_8h_5a6fbf3ac37164268afae80c35666c5e} + + +Free the given Msg object. + +SAMP\_\-FREEPARAM -- Free the given Param object + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em param}]Param object to free \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_d0343ad884d5a958d7d91928ad06a369}{ +\index{samp.h@{samp.h}!samp\_\-getAvailableHubs@{samp\_\-getAvailableHubs}} +\index{samp\_\-getAvailableHubs@{samp\_\-getAvailableHubs}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getAvailableHubs}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-getAvailableHubs (handle\_\-t {\em handle})}} +\label{samp_8h_d0343ad884d5a958d7d91928ad06a369} + + +Get a list of available Hubs. + +SAMP\_\-GETAVAILABLEHUBS -- Get a list of available Hubs + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]hub handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]List of hub handles \end{Desc} +\hypertarget{samp_8h_fd8a4da020cd2fedaf70ae8af0b6a1c8}{ +\index{samp.h@{samp.h}!samp\_\-getErr@{samp\_\-getErr}} +\index{samp\_\-getErr@{samp\_\-getErr}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getErr}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-getErr (handle\_\-t {\em handle})}} +\label{samp_8h_fd8a4da020cd2fedaf70ae8af0b6a1c8} + + +Get the error response string. + +SAMP\_\-GETERR -- Get the error response string. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]Error text string \end{Desc} +\hypertarget{samp_8h_cf9b570dd76203d2299ed7bdba048bb9}{ +\index{samp.h@{samp.h}!samp\_\-getFloatFromList@{samp\_\-getFloatFromList}} +\index{samp\_\-getFloatFromList@{samp\_\-getFloatFromList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getFloatFromList}]{\setlength{\rightskip}{0pt plus 5cm}ival samp\_\-getFloatFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{samp_8h_cf9b570dd76203d2299ed7bdba048bb9} + + +Get a Float from the List. + +SAMP\_\-GETFLOATFROMLIST -- Get a Float from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the desired value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]int value \end{Desc} +\hypertarget{samp_8h_89c38f762afd50c85f6ff659bdf0a923}{ +\index{samp.h@{samp.h}!samp\_\-getFloatFromMap@{samp\_\-getFloatFromMap}} +\index{samp\_\-getFloatFromMap@{samp\_\-getFloatFromMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getFloatFromMap}]{\setlength{\rightskip}{0pt plus 5cm}rval samp\_\-getFloatFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{samp_8h_89c38f762afd50c85f6ff659bdf0a923} + + +Get a float from the Map. + +SAMP\_\-GETFLOATFROMMAP -- Get a float from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]floating point value \end{Desc} + + +Referenced by samp\_\-execUserHandler(), and samp\_\-pointAtHandler().\hypertarget{samp_8h_0a0d9e41bebb554869f099dcf142a7bf}{ +\index{samp.h@{samp.h}!samp\_\-getHandlerReply@{samp\_\-getHandlerReply}} +\index{samp\_\-getHandlerReply@{samp\_\-getHandlerReply}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getHandlerReply}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-getHandlerReply (void)}} +\label{samp_8h_0a0d9e41bebb554869f099dcf142a7bf} + + +Get the \hyperlink{structSamp}{Samp} Handler reply map. + +SAMP\_\-GETHANDLERREPLY -- Get the \hyperlink{structSamp}{Samp} Handler reply map. + +\begin{Desc} +\item[Returns:]Map handle for reply map \end{Desc} + + +References nullMap, and OK\_\-Map. + +Referenced by samp\_\-receiveCall(), and samp\_\-receiveNotification().\hypertarget{samp_8h_594a51772e9b0693a3c77006eb88c96a}{ +\index{samp.h@{samp.h}!samp\_\-getIntFromMap@{samp\_\-getIntFromMap}} +\index{samp\_\-getIntFromMap@{samp\_\-getIntFromMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getIntFromMap}]{\setlength{\rightskip}{0pt plus 5cm}ival samp\_\-getIntFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{samp_8h_594a51772e9b0693a3c77006eb88c96a} + + +Get a integer from the Map. + +SAMP\_\-GETINTFROMMAP -- Get a integer from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]integer value \end{Desc} + + +Referenced by samp\_\-execUserHandler(), and samp\_\-tbHighlightHandler().\hypertarget{samp_8h_b74e90fdfe79b1c4f7668fdb28d041a1}{ +\index{samp.h@{samp.h}!samp\_\-getListFromList@{samp\_\-getListFromList}} +\index{samp\_\-getListFromList@{samp\_\-getListFromList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getListFromList}]{\setlength{\rightskip}{0pt plus 5cm}ival samp\_\-getListFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{samp_8h_b74e90fdfe79b1c4f7668fdb28d041a1} + + +Get a List from the List. + +Get an Int from the List. + +SAMP\_\-GETLISTFROMLIST -- Get a List from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the List \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]List handle\end{Desc} +SAMP\_\-GETINTFROMLIST -- Get an Int from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the desired value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]int value \end{Desc} +\hypertarget{samp_8h_31ddb90cf2184ae0151b9e7ec8c1a51f}{ +\index{samp.h@{samp.h}!samp\_\-getListFromMap@{samp\_\-getListFromMap}} +\index{samp\_\-getListFromMap@{samp\_\-getListFromMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getListFromMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf List} samp\_\-getListFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{samp_8h_31ddb90cf2184ae0151b9e7ec8c1a51f} + + +Get a LIST from the Map. + +SAMP\_\-GETLISTFROMMAP -- Get a LIST from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to List value \end{Desc} + + +Referenced by samp\_\-execUserHandler(), and samp\_\-tbSelectHandler().\hypertarget{samp_8h_33ca96ee3a8e7d26356c7b66f469da74}{ +\index{samp.h@{samp.h}!samp\_\-getMapFromList@{samp\_\-getMapFromList}} +\index{samp\_\-getMapFromList@{samp\_\-getMapFromList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getMapFromList}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getMapFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{samp_8h_33ca96ee3a8e7d26356c7b66f469da74} + + +Get a Map from the List. + +SAMP\_\-GETMAPFROMLIST -- Get a Map from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the Map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]Map handle \end{Desc} +\hypertarget{samp_8h_525e8ffdfa32867f392f2c1340215453}{ +\index{samp.h@{samp.h}!samp\_\-getMapFromMap@{samp\_\-getMapFromMap}} +\index{samp\_\-getMapFromMap@{samp\_\-getMapFromMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getMapFromMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getMapFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{samp_8h_525e8ffdfa32867f392f2c1340215453} + + +Get a Map from the Map. + +SAMP\_\-GETMAPFROMMAP -- Get a Map from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to Map value \end{Desc} + + +Referenced by samp\_\-execUserHandler(), samp\_\-resConeHandler(), samp\_\-resLoadHandler(), samp\_\-resSiapHandler(), samp\_\-resSsapHandler(), samp\_\-resTapHandler(), samp\_\-resVOSpaceHandler(), samp\_\-specLoadHandler(), and samp\_\-specSSAHandler().\hypertarget{samp_8h_def0598aa30c5c1a2276cdddf705de69}{ +\index{samp.h@{samp.h}!samp\_\-getMetadata@{samp\_\-getMetadata}} +\index{samp\_\-getMetadata@{samp\_\-getMetadata}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getMetadata}]{\setlength{\rightskip}{0pt plus 5cm}str samp\_\-getMetadata (handle\_\-t {\em handle}, \/ {\bf String} {\em param})}} +\label{samp_8h_def0598aa30c5c1a2276cdddf705de69} + + +Get the metadata item for the application. + +SAMP\_\-GETMETADATA -- Get the metadata item for the application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_636e11796b78ae9881e7c61df8516d2a}{ +\index{samp.h@{samp.h}!samp\_\-GetMetadata@{samp\_\-GetMetadata}} +\index{samp\_\-GetMetadata@{samp\_\-GetMetadata}!samp.h@{samp.h}} +\subsubsection[{samp\_\-GetMetadata}]{\setlength{\rightskip}{0pt plus 5cm}map samp\_\-GetMetadata (handle\_\-t {\em handle}, \/ {\bf String} {\em pubId})}} +\label{samp_8h_636e11796b78ae9881e7c61df8516d2a} + + +Get the metadata for a specified app. + +SAMP\_\-GETMETADATA -- Get the metadata for a specified app. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em pubId}]App public-id \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]Map to message response \end{Desc} + + +Referenced by samp\_\-mapClients().\hypertarget{samp_8h_27baec44edb57136951b5f86ae893246}{ +\index{samp.h@{samp.h}!samp\_\-getNullMap@{samp\_\-getNullMap}} +\index{samp\_\-getNullMap@{samp\_\-getNullMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getNullMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getNullMap ()}} +\label{samp_8h_27baec44edb57136951b5f86ae893246} + + +SAMP\_\-GETNULLMAP -- Generate a 'Null' map we can return to the \hyperlink{structHub}{Hub}. \hypertarget{samp_8h_cbf9b52550a9ab0b3515c32e692c46fb}{ +\index{samp.h@{samp.h}!samp\_\-getOKMap@{samp\_\-getOKMap}} +\index{samp\_\-getOKMap@{samp\_\-getOKMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getOKMap}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Map} samp\_\-getOKMap ()}} +\label{samp_8h_cbf9b52550a9ab0b3515c32e692c46fb} + + +SAMP\_\-GETOKMAP -- Generate an 'OK' map we can return to the \hyperlink{structHub}{Hub}. \hypertarget{samp_8h_2c532e076dd6446f079691ed02197a57}{ +\index{samp.h@{samp.h}!samp\_\-GetRegisteredClients@{samp\_\-GetRegisteredClients}} +\index{samp\_\-GetRegisteredClients@{samp\_\-GetRegisteredClients}!samp.h@{samp.h}} +\subsubsection[{samp\_\-GetRegisteredClients}]{\setlength{\rightskip}{0pt plus 5cm}handle samp\_\-GetRegisteredClients (handle\_\-t {\em handle})}} +\label{samp_8h_2c532e076dd6446f079691ed02197a57} + + +Get public-ids of the registered clients. + +SAMP\_\-GETREGISTEREDCLIENTS -- Get public-ids of the registered clients. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to list of registered clients \end{Desc} + + +Referenced by samp\_\-mapClients().\hypertarget{samp_8h_f295f9e7746644f834ac54b1deb95b4c}{ +\index{samp.h@{samp.h}!samp\_\-getSampHandler@{samp\_\-getSampHandler}} +\index{samp\_\-getSampHandler@{samp\_\-getSampHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getSampHandler}]{\setlength{\rightskip}{0pt plus 5cm}func samp\_\-getSampHandler ({\bf String} {\em mtype})}} +\label{samp_8h_f295f9e7746644f834ac54b1deb95b4c} + + +Get the Samphandler for the named mtype. + +SAMP\_\-GETSAMPHANDLER -- Get the Samphandler for the named mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-receiveCall(), samp\_\-receiveNotification(), and samp\_\-Subscribe().\hypertarget{samp_8h_b101c5b1175490474e41ac9060bdaabf}{ +\index{samp.h@{samp.h}!samp\_\-getStringFromList@{samp\_\-getStringFromList}} +\index{samp\_\-getStringFromList@{samp\_\-getStringFromList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getStringFromList}]{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ samp\_\-getStringFromList ({\bf List} {\em list}, \/ int {\em index})}} +\label{samp_8h_b101c5b1175490474e41ac9060bdaabf} + + +Get a string from the List. + +SAMP\_\-GETSTRINGFROMLIST -- Get a string from the List + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em index}]List index containing the string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]character string \end{Desc} + + +Referenced by samp\_\-mapClients().\hypertarget{samp_8h_e615ad9482fa88705b2488a37c987c2a}{ +\index{samp.h@{samp.h}!samp\_\-getStringFromMap@{samp\_\-getStringFromMap}} +\index{samp\_\-getStringFromMap@{samp\_\-getStringFromMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getStringFromMap}]{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ samp\_\-getStringFromMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key})}} +\label{samp_8h_e615ad9482fa88705b2488a37c987c2a} + + +Get a string from the Map. + +SAMP\_\-GETSTRINGFROMMAP -- Get a string from the Map + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]string value from Map \end{Desc} + + +Referenced by samp\_\-bibcodeHandler(), samp\_\-cmdExecHandler(), samp\_\-envGetHandler(), samp\_\-envSetHandler(), samp\_\-execUserHandler(), samp\_\-imLoadHandler(), samp\_\-paramGetHandler(), samp\_\-paramSetHandler(), samp\_\-resConeHandler(), samp\_\-resLoadHandler(), samp\_\-resSiapHandler(), samp\_\-resSsapHandler(), samp\_\-resTapHandler(), samp\_\-resVOSpaceHandler(), samp\_\-specLoadHandler(), samp\_\-specSSAHandler(), samp\_\-tbHighlightHandler(), samp\_\-tbLoadFITSHandler(), samp\_\-tbLoadHandler(), samp\_\-tbLoadVOTHandler(), and samp\_\-tbSelectHandler().\hypertarget{samp_8h_d28a9085ab8cacbe978e300ac99f6ae5}{ +\index{samp.h@{samp.h}!samp\_\-GetSubscribedClients@{samp\_\-GetSubscribedClients}} +\index{samp\_\-GetSubscribedClients@{samp\_\-GetSubscribedClients}!samp.h@{samp.h}} +\subsubsection[{samp\_\-GetSubscribedClients}]{\setlength{\rightskip}{0pt plus 5cm}list samp\_\-GetSubscribedClients (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype})}} +\label{samp_8h_d28a9085ab8cacbe978e300ac99f6ae5} + + +Get clients matching the mtype subscription. + +SAMP\_\-GETSUBSCRIBEDCLIENTS -- Get clients matching the mtype subscription. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to list of clients having mtype subscription \end{Desc} +\hypertarget{samp_8h_ce2ea31b9bd82db4c5040ffd0511bd8b}{ +\index{samp.h@{samp.h}!samp\_\-getUserHandler@{samp\_\-getUserHandler}} +\index{samp\_\-getUserHandler@{samp\_\-getUserHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-getUserHandler}]{\setlength{\rightskip}{0pt plus 5cm}func samp\_\-getUserHandler ({\bf String} {\em mtype})}} +\label{samp_8h_ce2ea31b9bd82db4c5040ffd0511bd8b} + + +Get the User handler for the named mtype. + +SAMP\_\-GETUSERHANDLER -- Get the User handler for the named mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +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().\hypertarget{samp_8h_14a1f14f60ac385c758346aed0f0272b}{ +\index{samp.h@{samp.h}!samp\_\-hubActive@{samp\_\-hubActive}} +\index{samp\_\-hubActive@{samp\_\-hubActive}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubActive}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubActive (handle\_\-t {\em handle})}} +\label{samp_8h_14a1f14f60ac385c758346aed0f0272b} + + +Determine if the \hyperlink{structHub}{Hub} is active (i.e. connected). + +SAMP\_\-HUBACTIVE -- Determine if the \hyperlink{structHub}{Hub} is active (i.e. connected). + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::active.\hypertarget{samp_8h_39a580ced499e50d39d327f7709834e7}{ +\index{samp.h@{samp.h}!samp\_\-hubClose@{samp\_\-hubClose}} +\index{samp\_\-hubClose@{samp\_\-hubClose}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubClose}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-hubClose (handle\_\-t {\em handle})}} +\label{samp_8h_39a580ced499e50d39d327f7709834e7} + + +Close a connection to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBCLOSE -- Close a connection to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]hub handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]unregister status \end{Desc} + + +Referenced by sampClose(), and sampShutdown().\hypertarget{samp_8h_bf1ae8a1c9c8cf520a22e6ea4d815712}{ +\index{samp.h@{samp.h}!samp\_\-hubDeclareMetadata@{samp\_\-hubDeclareMetadata}} +\index{samp\_\-hubDeclareMetadata@{samp\_\-hubDeclareMetadata}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubDeclareMetadata}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-hubDeclareMetadata ({\bf Hub} $\ast$ {\em hub})}} +\label{samp_8h_bf1ae8a1c9c8cf520a22e6ea4d815712} + + +Declare \char`\"{}standard\char`\"{} metadata to the \hyperlink{structHub}{Hub}. + +SAMP\_\-DECLAREMETADATA -- Declare \char`\"{}standard\char`\"{} metadata to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +Referenced by samp\_\-DeclareMetadata(), and sampStartup().\hypertarget{samp_8h_a6c0f67a76bd1f27898a66fe26b53fdd}{ +\index{samp.h@{samp.h}!samp\_\-hubDeclareSubscriptions@{samp\_\-hubDeclareSubscriptions}} +\index{samp\_\-hubDeclareSubscriptions@{samp\_\-hubDeclareSubscriptions}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubDeclareSubscriptions}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-hubDeclareSubscriptions ({\bf Hub} $\ast$ {\em hub})}} +\label{samp_8h_a6c0f67a76bd1f27898a66fe26b53fdd} + + +Declare mtype subscriptions to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBDECLARESUBSCRIPTIONS -- Declare mtype subscriptions to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +Referenced by samp\_\-DeclareSubscriptions(), and sampStartup().\hypertarget{samp_8h_a48b9a99f22537127df46a94dfa9ae4a}{ +\index{samp.h@{samp.h}!samp\_\-hubEvent@{samp\_\-hubEvent}} +\index{samp\_\-hubEvent@{samp\_\-hubEvent}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubEvent}]{\setlength{\rightskip}{0pt plus 5cm}code samp\_\-hubEvent ({\bf String} {\em mtype})}} +\label{samp_8h_a48b9a99f22537127df46a94dfa9ae4a} + + +Determine the type of \hyperlink{structHub}{Hub} event mtype. + +SAMP\_\-HUBEVENT -- Determine the type of \hyperlink{structHub}{Hub} event mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]\hyperlink{structHub}{Hub} event code or -1 if not found \end{Desc} + + +Referenced by samp\_\-processHubEvent().\hypertarget{samp_8h_ef92557afa5ed6731ac0a0a1ba6dfd7c}{ +\index{samp.h@{samp.h}!samp\_\-hubOpen@{samp\_\-hubOpen}} +\index{samp\_\-hubOpen@{samp\_\-hubOpen}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubOpen}]{\setlength{\rightskip}{0pt plus 5cm}handle samp\_\-hubOpen ({\bf Samp} $\ast$ {\em sampP})}} +\label{samp_8h_ef92557afa5ed6731ac0a0a1ba6dfd7c} + + +Discover and open a connection to the SAMP \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBOPEN -- Discover and open a connection to the SAMP \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em samp}]Same structure \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]hub handle \end{Desc} + + +Referenced by sampInit(), and sampStartup().\hypertarget{samp_8h_155739318fa72883a3e32fccf8a6d5c9}{ +\index{samp.h@{samp.h}!samp\_\-hubPing@{samp\_\-hubPing}} +\index{samp\_\-hubPing@{samp\_\-hubPing}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubPing}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-hubPing ({\bf Hub} $\ast$ {\em hub})}} +\label{samp_8h_155739318fa72883a3e32fccf8a6d5c9} + + +Ping the \hyperlink{structHub}{Hub} to see if it is alive. + +SAMP\_\-HUBPING -- Ping the \hyperlink{structHub}{Hub} to see if it is alive. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +Referenced by samp\_\-Ping().\hypertarget{samp_8h_77a14721e2373c805b58f69a018ea69c}{ +\index{samp.h@{samp.h}!samp\_\-hubRegister@{samp\_\-hubRegister}} +\index{samp\_\-hubRegister@{samp\_\-hubRegister}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubRegister}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-hubRegister ({\bf Hub} $\ast$ {\em hub})}} +\label{samp_8h_77a14721e2373c805b58f69a018ea69c} + + +Send a Register message to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUB\_\-REGISTER -- Send a Register message to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +Referenced by samp\_\-hubOpen().\hypertarget{samp_8h_a927eb8dcb67e245aeb5a8a4feeb6230}{ +\index{samp.h@{samp.h}!samp\_\-hubRunning@{samp\_\-hubRunning}} +\index{samp\_\-hubRunning@{samp\_\-hubRunning}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubRunning}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-hubRunning (void)}} +\label{samp_8h_a927eb8dcb67e245aeb5a8a4feeb6230} + + +SAMP\_\-HUBRUNNING -- See whether a \hyperlink{structHub}{Hub} is running. The test simply checks the existence of a \hyperlink{structHub}{Hub} lockfile. + +References SZ\_\-NAME.\hypertarget{samp_8h_6c7b8a8ff1f3c2435d153bc08da87dce}{ +\index{samp.h@{samp.h}!samp\_\-hubSendShutdown@{samp\_\-hubSendShutdown}} +\index{samp\_\-hubSendShutdown@{samp\_\-hubSendShutdown}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubSendShutdown}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-hubSendShutdown ({\bf Hub} $\ast$ {\em hub})}} +\label{samp_8h_6c7b8a8ff1f3c2435d153bc08da87dce} + + +Send a samp.app.event.shutdown message to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBSENDSHUTDOWN -- Send a samp.app.event.shutdown message to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} +\hypertarget{samp_8h_fc0bfbd699ab2cbce2f755a0506ca6dc}{ +\index{samp.h@{samp.h}!samp\_\-hubSetXmlrpcCallback@{samp\_\-hubSetXmlrpcCallback}} +\index{samp\_\-hubSetXmlrpcCallback@{samp\_\-hubSetXmlrpcCallback}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubSetXmlrpcCallback}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-hubSetXmlrpcCallback ({\bf Hub} $\ast$ {\em hub})}} +\label{samp_8h_fc0bfbd699ab2cbce2f755a0506ca6dc} + + +Set the client callback and send to \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBSETXMLRPCCALLBACK -- Set the client callback and send to \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +Referenced by samp\_\-hubOpen().\hypertarget{samp_8h_b0c37311ca30e1fdadfdd1fd16ff3ab4}{ +\index{samp.h@{samp.h}!samp\_\-hubUnRegister@{samp\_\-hubUnRegister}} +\index{samp\_\-hubUnRegister@{samp\_\-hubUnRegister}!samp.h@{samp.h}} +\subsubsection[{samp\_\-hubUnRegister}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-hubUnRegister ({\bf Hub} $\ast$ {\em hub})}} +\label{samp_8h_b0c37311ca30e1fdadfdd1fd16ff3ab4} + + +Send a UnRegister message to the \hyperlink{structHub}{Hub}. + +SAMP\_\-HUBUNREGISTER -- Send a UnRegister message to the \hyperlink{structHub}{Hub}. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em hub}]hub struct pointer \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status \end{Desc} + + +Referenced by samp\_\-hubClose(), and samp\_\-UnRegister().\hypertarget{samp_8h_343e25bf33431d973d9f81bc25eddcf7}{ +\index{samp.h@{samp.h}!samp\_\-id2app@{samp\_\-id2app}} +\index{samp\_\-id2app@{samp\_\-id2app}!samp.h@{samp.h}} +\subsubsection[{samp\_\-id2app}]{\setlength{\rightskip}{0pt plus 5cm}appName samp\_\-id2app (handle\_\-t {\em handle}, \/ char $\ast$ {\em pubId})}} +\label{samp_8h_343e25bf33431d973d9f81bc25eddcf7} + + +Convert a public-ID to the application name. + +SAMP\_\-ID2APP -- Convert a public-ID to the application name. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em pubId}]public ID of application \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]name of registered application \end{Desc} +\hypertarget{samp_8h_2ec386ef5bd7dee20ffa1fead0b0210a}{ +\index{samp.h@{samp.h}!samp\_\-imageLoadFITS@{samp\_\-imageLoadFITS}} +\index{samp\_\-imageLoadFITS@{samp\_\-imageLoadFITS}!samp.h@{samp.h}} +\subsubsection[{samp\_\-imageLoadFITS}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-imageLoadFITS (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em name})}} +\label{samp_8h_2ec386ef5bd7dee20ffa1fead0b0210a} + + +Tell an app to load a FITS image. + +SAMP\_\-IMAGELOADFITS -- Tell an app to load a FITS image. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em url}]URL to table to be loaded \item[{\em imageId}]ID assigned to image (optional) \item[{\em name}]Name assigned to image (optional) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_9bd8036dd65dc4f874f39568b691a123}{ +\index{samp.h@{samp.h}!samp\_\-imLoadHandler@{samp\_\-imLoadHandler}} +\index{samp\_\-imLoadHandler@{samp\_\-imLoadHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-imLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-imLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_9bd8036dd65dc4f874f39568b691a123} + + +Handle an image.load.fits message. + +SAMP\_\-IMLOADHANDLER -- Handle an image.load.fits message. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_1e494e73abe2ddfd946fb39e84da42a9}{ +\index{samp.h@{samp.h}!samp\_\-listClients@{samp\_\-listClients}} +\index{samp\_\-listClients@{samp\_\-listClients}!samp.h@{samp.h}} +\subsubsection[{samp\_\-listClients}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-listClients (handle\_\-t {\em handle})}} +\label{samp_8h_1e494e73abe2ddfd946fb39e84da42a9} + + +SAMP\_\-LISTCLIENTS -- List the available clients to stdout. \hypertarget{samp_8h_c260afb0cbf19b427e3eba96a2341e52}{ +\index{samp.h@{samp.h}!samp\_\-listLen@{samp\_\-listLen}} +\index{samp\_\-listLen@{samp\_\-listLen}!samp.h@{samp.h}} +\subsubsection[{samp\_\-listLen}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-listLen ({\bf List} {\em list})}} +\label{samp_8h_c260afb0cbf19b427e3eba96a2341e52} + + +Get number of elements in a List. + +SAMP\_\-LISTLEN -- Get number of elements in a List. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-execUserHandler(), samp\_\-GetRegisteredClients(), samp\_\-GetSubscribedClients(), samp\_\-mapClients(), and samp\_\-tbSelectHandler().\hypertarget{samp_8h_ff4d125fc9594be25984989fad2fd3c8}{ +\index{samp.h@{samp.h}!samp\_\-mapClients@{samp\_\-mapClients}} +\index{samp\_\-mapClients@{samp\_\-mapClients}!samp.h@{samp.h}} +\subsubsection[{samp\_\-mapClients}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-mapClients (handle\_\-t {\em handle})}} +\label{samp_8h_ff4d125fc9594be25984989fad2fd3c8} + + +SAMP\_\-MAPCLIENTS -- Map the public-ids of registered clients to the appName. \hypertarget{samp_8h_2e77115e730e95b31d897b8c50999b74}{ +\index{samp.h@{samp.h}!samp\_\-Metadata@{samp\_\-Metadata}} +\index{samp\_\-Metadata@{samp\_\-Metadata}!samp.h@{samp.h}} +\subsubsection[{samp\_\-Metadata}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-Metadata (handle\_\-t {\em handle}, \/ {\bf String} {\em field}, \/ {\bf String} {\em value})}} +\label{samp_8h_2e77115e730e95b31d897b8c50999b74} + + +Set a metadata field value for the application. + +SAMP\_\-METADATA -- Set a metadata field for the application. This will be sent to the \hyperlink{structHub}{Hub} later in a declareMetadata() call. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em field}]metadata field to set (name, author, etc) \item[{\em samp}]value of field \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_281c8f7f8b21a74704dd200d5aaed481}{ +\index{samp.h@{samp.h}!samp\_\-msgParam@{samp\_\-msgParam}} +\index{samp\_\-msgParam@{samp\_\-msgParam}!samp.h@{samp.h}} +\subsubsection[{samp\_\-msgParam}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-msgParam ({\bf Msg} {\em msg}, \/ {\bf Param} {\em param})}} +\label{samp_8h_281c8f7f8b21a74704dd200d5aaed481} + + +Add a parameter to the Msg. + +SAMP\_\-MSGPARAM -- Add a parameter to the Msg. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \item[{\em keyw}]map keyword \item[{\em param}]parameter map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envGet(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Ping(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().\hypertarget{samp_8h_711aa545f55e9307f662062deefd5903}{ +\index{samp.h@{samp.h}!samp\_\-newHandle@{samp\_\-newHandle}} +\index{samp\_\-newHandle@{samp\_\-newHandle}!samp.h@{samp.h}} +\subsubsection[{samp\_\-newHandle}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t samp\_\-newHandle (void $\ast$ {\em ptr})}} +\label{samp_8h_711aa545f55e9307f662062deefd5903} + + +Get an unused object handle. + +SAMP\_\-NEWHANDLE -- Get an unused object handle. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ptr}]pointer to object to be stored \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]new object handle \end{Desc} + + +Referenced by samp\_\-hubOpen(), and sampInit().\hypertarget{samp_8h_cdc925da798ee7a1ce30427d47812bd2}{ +\index{samp.h@{samp.h}!samp\_\-newList@{samp\_\-newList}} +\index{samp\_\-newList@{samp\_\-newList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-newList}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-newList (void)}} +\label{samp_8h_cdc925da798ee7a1ce30427d47812bd2} + + +Create a new List object. + +SAMP\_\-NEWLIST -- Create a new List object + +\begin{Desc} +\item[Returns:]handle to List object \end{Desc} + + +Referenced by samp\_\-GetRegisteredClients(), samp\_\-GetSubscribedClients(), samp\_\-tableSelectRowList(), and sampInit().\hypertarget{samp_8h_d88b5d5e9014deba8071f7defd220dbb}{ +\index{samp.h@{samp.h}!samp\_\-newMap@{samp\_\-newMap}} +\index{samp\_\-newMap@{samp\_\-newMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-newMap}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-newMap (void)}} +\label{samp_8h_d88b5d5e9014deba8071f7defd220dbb} + + +Create a new Map object. + +SAMP\_\-NEWMAP -- Create a new Map object + +\begin{Desc} +\item[Returns:]handle to new Map \end{Desc} + + +Referenced by samp\_\-envGetHandler(), samp\_\-getNullMap(), samp\_\-getOKMap(), samp\_\-paramGetHandler(), and sampInit().\hypertarget{samp_8h_d343c08e241ff4e17a0eb8fa3d9f4781}{ +\index{samp.h@{samp.h}!samp\_\-newMsg@{samp\_\-newMsg}} +\index{samp\_\-newMsg@{samp\_\-newMsg}!samp.h@{samp.h}} +\subsubsection[{samp\_\-newMsg}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-newMsg (void)}} +\label{samp_8h_d343c08e241ff4e17a0eb8fa3d9f4781} + + +Create a new Msg object. + +SAMP\_\-NEWMSG -- Create a new Msg object + +\begin{Desc} +\item[Returns:]handle to new Msg \end{Desc} + + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envGet(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Ping(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().\hypertarget{samp_8h_3e2fe98bee9ac2b0c882de78e9b5085f}{ +\index{samp.h@{samp.h}!samp\_\-newParam@{samp\_\-newParam}} +\index{samp\_\-newParam@{samp\_\-newParam}!samp.h@{samp.h}} +\subsubsection[{samp\_\-newParam}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-newParam (void)}} +\label{samp_8h_3e2fe98bee9ac2b0c882de78e9b5085f} + + +Create a new Param object. + +SAMP\_\-NEWPARAM -- Create a new Param object + +\begin{Desc} +\item[Returns:]handle to new Param \end{Desc} + + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envGet(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramGet(), samp\_\-paramSet(), samp\_\-Ping(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().\hypertarget{samp_8h_c73788ae17493c4042948f6b861ddd74}{ +\index{samp.h@{samp.h}!samp\_\-notify@{samp\_\-notify}} +\index{samp\_\-notify@{samp\_\-notify}!samp.h@{samp.h}} +\subsubsection[{samp\_\-notify}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-notify (handle\_\-t {\em handle}, \/ {\bf String} {\em recipId}, \/ {\bf Map} {\em msg})}} +\label{samp_8h_c73788ae17493c4042948f6b861ddd74} + + +Make a notify() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-NOTIFY -- Make a notify() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recipId}]recipient ID \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-sendMsg().\hypertarget{samp_8h_a046d61f43fce831a71621f98b6d9741}{ +\index{samp.h@{samp.h}!samp\_\-notifyAll@{samp\_\-notifyAll}} +\index{samp\_\-notifyAll@{samp\_\-notifyAll}!samp.h@{samp.h}} +\subsubsection[{samp\_\-notifyAll}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-notifyAll (handle\_\-t {\em handle}, \/ {\bf Map} {\em msg})}} +\label{samp_8h_a046d61f43fce831a71621f98b6d9741} + + +Make a notifyAll() call to the \hyperlink{structHub}{Hub}. + +SAMP\_\-NOTIFYALL -- Make a notifyAll() call to the \hyperlink{structHub}{Hub} + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em msg}]message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-sendMsg().\hypertarget{samp_8h_5361571754505eaefdf5739cd3e9519e}{ +\index{samp.h@{samp.h}!samp\_\-nullResponse@{samp\_\-nullResponse}} +\index{samp\_\-nullResponse@{samp\_\-nullResponse}!samp.h@{samp.h}} +\subsubsection[{samp\_\-nullResponse}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-nullResponse (void $\ast$ {\em data})}} +\label{samp_8h_5361571754505eaefdf5739cd3e9519e} + + +SAMP\_\-NULLRESPONSE -- Handler to ignore async replies. + +Referenced by samp\_\-hubSendShutdown(), samp\_\-notify(), and samp\_\-Reply().\hypertarget{samp_8h_4d0aef2f09b9cce38d4ea8024831c6e5}{ +\index{samp.h@{samp.h}!samp\_\-P2H@{samp\_\-P2H}} +\index{samp\_\-P2H@{samp\_\-P2H}!samp.h@{samp.h}} +\subsubsection[{samp\_\-P2H}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t samp\_\-P2H (void $\ast$ {\em ptr})}} +\label{samp_8h_4d0aef2f09b9cce38d4ea8024831c6e5} + + +Convert a pointer to a handle. + +SAMP\_\-P2H -- Convert a pointer to a handle + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em ptr}]pointer to object \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]handle to object, $<$ 0 on error \end{Desc} + + +Referenced by samp\_\-hubOpen(), and samp\_\-processHubEvent().\hypertarget{samp_8h_4c75de6ddcffde6e3dde7beea68de81c}{ +\index{samp.h@{samp.h}!samp\_\-paramGet@{samp\_\-paramGet}} +\index{samp\_\-paramGet@{samp\_\-paramGet}!samp.h@{samp.h}} +\subsubsection[{samp\_\-paramGet}]{\setlength{\rightskip}{0pt plus 5cm}val samp\_\-paramGet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name})}} +\label{samp_8h_4c75de6ddcffde6e3dde7beea68de81c} + + +Get a parameter variable in a remote application. + +SAMP\_\-PARAMGET -- Get a parameter variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]NULL, Value of variable, or list of values \end{Desc} +\hypertarget{samp_8h_659c272ce881662c1826a04728dc06f6}{ +\index{samp.h@{samp.h}!samp\_\-paramGetHandler@{samp\_\-paramGetHandler}} +\index{samp\_\-paramGetHandler@{samp\_\-paramGetHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-paramGetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramGetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_659c272ce881662c1826a04728dc06f6} + + +Handle a client.param.set message. + +SAMP\_\-PARAMGETHANDLER -- Handle a client.param.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_f2953eb691b695482ffbbea71948374f}{ +\index{samp.h@{samp.h}!samp\_\-paramInit@{samp\_\-paramInit}} +\index{samp\_\-paramInit@{samp\_\-paramInit}!samp.h@{samp.h}} +\subsubsection[{samp\_\-paramInit}]{\setlength{\rightskip}{0pt plus 5cm}nparam samp\_\-paramInit ({\bf Msg} {\em msg})}} +\label{samp_8h_f2953eb691b695482ffbbea71948374f} + + +Get number of Params. + +SAMP\_\-PARAMINIT -- Get number of Params. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-addFloatParam(), samp\_\-addIntParam(), samp\_\-addListParam(), and samp\_\-addMapParam().\hypertarget{samp_8h_5a44618b7681acff67b3883341494d2d}{ +\index{samp.h@{samp.h}!samp\_\-paramLen@{samp\_\-paramLen}} +\index{samp\_\-paramLen@{samp\_\-paramLen}!samp.h@{samp.h}} +\subsubsection[{samp\_\-paramLen}]{\setlength{\rightskip}{0pt plus 5cm}nparam samp\_\-paramLen ({\bf Msg} {\em msg})}} +\label{samp_8h_5a44618b7681acff67b3883341494d2d} + + +Get number of Params. + +SAMP\_\-PARAMLEN -- Get number of Params. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em msg}]handle to Msg object \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_7a5c9f092b57dfb3206c8decc8558fd3}{ +\index{samp.h@{samp.h}!samp\_\-paramSet@{samp\_\-paramSet}} +\index{samp\_\-paramSet@{samp\_\-paramSet}!samp.h@{samp.h}} +\subsubsection[{samp\_\-paramSet}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-paramSet (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em name}, \/ {\bf String} {\em value})}} +\label{samp_8h_7a5c9f092b57dfb3206c8decc8558fd3} + + +Set an parameter variable in a remote application. + +SAMP\_\-PARAMSET -- Set an parameter variable in a remote application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em name}]Name of variable in receiver's environment \item[{\em value}]Value of variable or NULL \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_071aa9e32f2e94d5b667e87cf65d2bdf}{ +\index{samp.h@{samp.h}!samp\_\-paramSetHandler@{samp\_\-paramSetHandler}} +\index{samp\_\-paramSetHandler@{samp\_\-paramSetHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-paramSetHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-paramSetHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_071aa9e32f2e94d5b667e87cf65d2bdf} + + +Handle a client.param.set message. + +SAMP\_\-PARAMSETHANDLER -- Handle a client.param.set message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_7688cbf8ef852483c077be96151763a6}{ +\index{samp.h@{samp.h}!samp\_\-Ping@{samp\_\-Ping}} +\index{samp\_\-Ping@{samp\_\-Ping}!samp.h@{samp.h}} +\subsubsection[{samp\_\-Ping}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-Ping (handle\_\-t {\em handle}, \/ {\bf String} {\em appName})}} +\label{samp_8h_7688cbf8ef852483c077be96151763a6} + + +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). + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em appName}]application name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]OK or ERR if no response \end{Desc} +\hypertarget{samp_8h_16d8b8822d169107b8702ae753797923}{ +\index{samp.h@{samp.h}!samp\_\-PingHandler@{samp\_\-PingHandler}} +\index{samp\_\-PingHandler@{samp\_\-PingHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-PingHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-PingHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_16d8b8822d169107b8702ae753797923} + + +Is app alive and responding to messages? + +SAMP\_\-PINGHANDLER -- Simple aliveness test function. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_3f5632858a2b09759ffe98cd2e183cfb}{ +\index{samp.h@{samp.h}!samp\_\-pointAtHandler@{samp\_\-pointAtHandler}} +\index{samp\_\-pointAtHandler@{samp\_\-pointAtHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-pointAtHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-pointAtHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_3f5632858a2b09759ffe98cd2e183cfb} + + +Handle a coord.pointAt.sky message. + +SAMP\_\-POINTATHANDLER -- Handle a coord.pointAt.sky message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_a8a947c24f2c9333adf4e5d7fa11d134}{ +\index{samp.h@{samp.h}!samp\_\-printMap@{samp\_\-printMap}} +\index{samp\_\-printMap@{samp\_\-printMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-printMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-printMap ({\bf String} {\em name}, \/ {\bf Map} {\em map})}} +\label{samp_8h_a8a947c24f2c9333adf4e5d7fa11d134} + + +SAMP\_\-PRINTMAP -- Print the contents of a Map structure. \hypertarget{samp_8h_5b2ef060b3adb18aea7a5a6099c4d0d0}{ +\index{samp.h@{samp.h}!samp\_\-printMetadata@{samp\_\-printMetadata}} +\index{samp\_\-printMetadata@{samp\_\-printMetadata}!samp.h@{samp.h}} +\subsubsection[{samp\_\-printMetadata}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-printMetadata (handle\_\-t {\em handle}, \/ {\bf String} {\em name})}} +\label{samp_8h_5b2ef060b3adb18aea7a5a6099c4d0d0} + + +Print the metadata for the application. + +SAMP\_\-PRINTMETADATA -- Print the metadata for the application. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_265b5d07cce485a6979fe5f4a2217624}{ +\index{samp.h@{samp.h}!samp\_\-processHubEvent@{samp\_\-processHubEvent}} +\index{samp\_\-processHubEvent@{samp\_\-processHubEvent}!samp.h@{samp.h}} +\subsubsection[{samp\_\-processHubEvent}]{\setlength{\rightskip}{0pt plus 5cm}valid samp\_\-processHubEvent ({\bf String} {\em mtype}, \/ {\bf Map} {\em params})}} +\label{samp_8h_265b5d07cce485a6979fe5f4a2217624} + + +Determine the type of \hyperlink{structHub}{Hub} event mtype. + +SAMP\_\-HUBEVENT -- Determine the type of \hyperlink{structHub}{Hub} event mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em mtype}]mtype string \item[{\em params}]message parameter Map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]non-zero value if a \hyperlink{structHub}{Hub} event was processed \end{Desc} + + +Referenced by samp\_\-receiveNotification().\hypertarget{samp_8h_59f85e0fce4c9ae7121c98e137d3f743}{ +\index{samp.h@{samp.h}!samp\_\-receiveCall@{samp\_\-receiveCall}} +\index{samp\_\-receiveCall@{samp\_\-receiveCall}!samp.h@{samp.h}} +\subsubsection[{samp\_\-receiveCall}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-receiveCall (void $\ast$ {\em data})}} +\label{samp_8h_59f85e0fce4c9ae7121c98e137d3f743} + + +test.echo method + +receiveCall () client method. + +SAMP\_\-TESTECHO -- test.echo method + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno\end{Desc} +SAMP\_\-RECEIVECALL -- receiveCall() client method. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno \end{Desc} +\hypertarget{samp_8h_03be7cc9e154a6ccdd499286df640936}{ +\index{samp.h@{samp.h}!samp\_\-receiveNotification@{samp\_\-receiveNotification}} +\index{samp\_\-receiveNotification@{samp\_\-receiveNotification}!samp.h@{samp.h}} +\subsubsection[{samp\_\-receiveNotification}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-receiveNotification (void $\ast$ {\em data})}} +\label{samp_8h_03be7cc9e154a6ccdd499286df640936} + + +receiveNotification () client method. + +SAMP\_\-RECEIVENOTIFICATION -- receiveNotification() client method. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno \end{Desc} +\hypertarget{samp_8h_754b50ad59145c7fd1e4c8f4277f11e4}{ +\index{samp.h@{samp.h}!samp\_\-receiveResponse@{samp\_\-receiveResponse}} +\index{samp\_\-receiveResponse@{samp\_\-receiveResponse}!samp.h@{samp.h}} +\subsubsection[{samp\_\-receiveResponse}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-receiveResponse (void $\ast$ {\em data})}} +\label{samp_8h_754b50ad59145c7fd1e4c8f4277f11e4} + + +receiveResponse () client method. + +SAMP\_\-RECEIVERESPONSE -- receiveResponse() client method. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em data}]caller param data \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]status code or errno \end{Desc} +\hypertarget{samp_8h_aef9c2f86c7e4f49fe3df343ef06f3ba}{ +\index{samp.h@{samp.h}!samp\_\-Register@{samp\_\-Register}} +\index{samp\_\-Register@{samp\_\-Register}!samp.h@{samp.h}} +\subsubsection[{samp\_\-Register}]{\setlength{\rightskip}{0pt plus 5cm}handle samp\_\-Register (handle\_\-t {\em handle})}} +\label{samp_8h_aef9c2f86c7e4f49fe3df343ef06f3ba} + + +Register with the \hyperlink{structHub}{Hub} using the currently stored metadata. + +SAMP\_\-REGISTER -- Register with the \hyperlink{structHub}{Hub} using the currently stored metadata. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_e30e492f306a40f853a454faf60ab479}{ +\index{samp.h@{samp.h}!samp\_\-removeClient@{samp\_\-removeClient}} +\index{samp\_\-removeClient@{samp\_\-removeClient}!samp.h@{samp.h}} +\subsubsection[{samp\_\-removeClient}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-removeClient (handle\_\-t {\em handle}, \/ {\bf String} {\em id})}} +\label{samp_8h_e30e492f306a40f853a454faf60ab479} + + +SAMP\_\-REMOVECLIENT -- Remove a registered client from the list of known apps that do the public-private name translation. \hypertarget{samp_8h_89fc488147fe2e08b4f3c044c7079962}{ +\index{samp.h@{samp.h}!samp\_\-Reply@{samp\_\-Reply}} +\index{samp\_\-Reply@{samp\_\-Reply}!samp.h@{samp.h}} +\subsubsection[{samp\_\-Reply}]{\setlength{\rightskip}{0pt plus 5cm}status samp\_\-Reply (handle\_\-t {\em handle}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em response})}} +\label{samp_8h_89fc488147fe2e08b4f3c044c7079962} + + +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. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em msg\_\-id}]message ID \item[{\em response}]response map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +Referenced by samp\_\-receiveCall().\hypertarget{samp_8h_d47754f3b9fceff4d3019821519432b4}{ +\index{samp.h@{samp.h}!samp\_\-replyStatus@{samp\_\-replyStatus}} +\index{samp\_\-replyStatus@{samp\_\-replyStatus}!samp.h@{samp.h}} +\subsubsection[{samp\_\-replyStatus}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-replyStatus (handle\_\-t {\em handle})}} +\label{samp_8h_d47754f3b9fceff4d3019821519432b4} + + +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 + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em samp}]samp struct ptr \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]message status \end{Desc} +\hypertarget{samp_8h_287569451dc1bf59d1f9f6d13b56716d}{ +\index{samp.h@{samp.h}!samp\_\-resConeHandler@{samp\_\-resConeHandler}} +\index{samp\_\-resConeHandler@{samp\_\-resConeHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-resConeHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resConeHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_287569451dc1bf59d1f9f6d13b56716d} + + +handle a voresource.loadlist message + +SAMP\_\-RESCONEHANDLER -- Handle a voresource.loadlist.cone message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_c0bf7cf7fea362c0c82ad7bc3f267c48}{ +\index{samp.h@{samp.h}!samp\_\-resLoadHandler@{samp\_\-resLoadHandler}} +\index{samp\_\-resLoadHandler@{samp\_\-resLoadHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-resLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_c0bf7cf7fea362c0c82ad7bc3f267c48} + + +handle a voresource.loadlist message + +SAMP\_\-RESLOADHANDLER -- handle a voresource.loadlist.$\ast$ message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +Referenced by samp\_\-resConeHandler(), samp\_\-resSiapHandler(), samp\_\-resSsapHandler(), samp\_\-resTapHandler(), and samp\_\-resVOSpaceHandler().\hypertarget{samp_8h_a0bb33d232fcb52aaa470d1f1b1a89d7}{ +\index{samp.h@{samp.h}!samp\_\-resourceLoad@{samp\_\-resourceLoad}} +\index{samp\_\-resourceLoad@{samp\_\-resourceLoad}!samp.h@{samp.h}} +\subsubsection[{samp\_\-resourceLoad}]{\setlength{\rightskip}{0pt plus 5cm}val samp\_\-resourceLoad (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em type}, \/ {\bf String} {\em name}, \/ {\bf Map} {\em resMap})}} +\label{samp_8h_a0bb33d232fcb52aaa470d1f1b1a89d7} + + +Exchange a resource list. + +SAMP\_\-RESOURCELOAD -- Exchange a resource list. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Name of recipient (or 'all') \item[{\em type}]Resource type (or NULL) \item[{\em name}]Descriptive name (optional) \item[{\em resMap}]Resource map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_8b2300222d7b11f144eb4385412e69a5}{ +\index{samp.h@{samp.h}!samp\_\-resSiapHandler@{samp\_\-resSiapHandler}} +\index{samp\_\-resSiapHandler@{samp\_\-resSiapHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-resSiapHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resSiapHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_8b2300222d7b11f144eb4385412e69a5} + + +handle a voresource.loadlist message + +SAMP\_\-RESSIAPHANDLER -- Handle a voresource.loadlist.siap message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_866578a01c3b762435823b1b11869c42}{ +\index{samp.h@{samp.h}!samp\_\-resSsapHandler@{samp\_\-resSsapHandler}} +\index{samp\_\-resSsapHandler@{samp\_\-resSsapHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-resSsapHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resSsapHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_866578a01c3b762435823b1b11869c42} + + +handle a voresource.loadlist message + +SAMP\_\-RESSSAPHANDLER -- Handle a voresource.loadlist.ssap message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_ad42ca17cbaf23012ad497559ea45e4c}{ +\index{samp.h@{samp.h}!samp\_\-resTapHandler@{samp\_\-resTapHandler}} +\index{samp\_\-resTapHandler@{samp\_\-resTapHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-resTapHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resTapHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_ad42ca17cbaf23012ad497559ea45e4c} + + +handle a voresource.loadlist message + +SAMP\_\-RESTAPHANDLER -- Handle a voresource.loadlist.tap message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_fa207ebdc587ba5eeab60fbf79b635d4}{ +\index{samp.h@{samp.h}!samp\_\-resVOSpaceHandler@{samp\_\-resVOSpaceHandler}} +\index{samp\_\-resVOSpaceHandler@{samp\_\-resVOSpaceHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-resVOSpaceHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-resVOSpaceHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_fa207ebdc587ba5eeab60fbf79b635d4} + + +handle a voresource.loadlist message + +SAMP\_\-RESVOSPACEHANDLER -- Handle a voresource.loadlist.vospace message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_5837826e5b4e86b2dda0892c48b96faf}{ +\index{samp.h@{samp.h}!samp\_\-sendGeneric@{samp\_\-sendGeneric}} +\index{samp\_\-sendGeneric@{samp\_\-sendGeneric}!samp.h@{samp.h}} +\subsubsection[{samp\_\-sendGeneric}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-sendGeneric (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em args}\mbox{[}$\,$\mbox{]})}} +\label{samp_8h_5837826e5b4e86b2dda0892c48b96faf} + + +Send a geenric message. + +SAMP\_\-SENDGENERIC -- Send a generic message. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Name of recipient (or 'all') \item[{\em mtype}]Message type \item[{\em args}]Argument list \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR\end{Desc} +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. \hypertarget{samp_8h_4607721d55904450d4066c360d3dcddd}{ +\index{samp.h@{samp.h}!samp\_\-sendMsg@{samp\_\-sendMsg}} +\index{samp\_\-sendMsg@{samp\_\-sendMsg}!samp.h@{samp.h}} +\subsubsection[{samp\_\-sendMsg}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-sendMsg (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf Map} {\em msg})}} +\label{samp_8h_4607721d55904450d4066c360d3dcddd} + + +Send the specified message. + +SAMP\_\-SENDMSG -- Send the specified message. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Name of recipient (or 'all') \item[{\em msg}]Message map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +Referenced by samp\_\-bibLoad(), samp\_\-cmdExec(), samp\_\-coordPointAtSky(), samp\_\-envSet(), samp\_\-imageLoadFITS(), samp\_\-paramSet(), samp\_\-resourceLoad(), samp\_\-sendGeneric(), samp\_\-specLoadSSAGeneric(), samp\_\-tableHighlightRow(), samp\_\-tableLoadFITS(), samp\_\-tableLoadVOTable(), and samp\_\-tableSelectRowList().\hypertarget{samp_8h_6157dc4b47c65323a3015a434cd02e69}{ +\index{samp.h@{samp.h}!samp\_\-serverPort@{samp\_\-serverPort}} +\index{samp\_\-serverPort@{samp\_\-serverPort}!samp.h@{samp.h}} +\subsubsection[{samp\_\-serverPort}]{\setlength{\rightskip}{0pt plus 5cm}port samp\_\-serverPort (void)}} +\label{samp_8h_6157dc4b47c65323a3015a434cd02e69} + + +Return a unique port number for the server. + +SAMP\_\-SERVERPORT -- Return a unique port number for the server. + +\begin{Desc} +\item[Returns:]port number \end{Desc} + + +Referenced by samp\_\-hubSetXmlrpcCallback(), and sampInit().\hypertarget{samp_8h_8fbfdc550ede5d52840300ab33639c49}{ +\index{samp.h@{samp.h}!samp\_\-setAppVersion@{samp\_\-setAppVersion}} +\index{samp\_\-setAppVersion@{samp\_\-setAppVersion}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setAppVersion}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setAppVersion (handle\_\-t {\em handle}, \/ {\bf String} {\em version})}} +\label{samp_8h_8fbfdc550ede5d52840300ab33639c49} + + +Set the application name string. + +Set the application version string. + +SAMP\_\-SETAPPNAME -- Set the application name string. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em name}]application name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing\end{Desc} +SAMP\_\-SETAPPVERSION -- Set the application version string. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em name}]application version \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_a9aef12dd82bfd38a2382a4ac88c54af}{ +\index{samp.h@{samp.h}!samp\_\-setASyncMode@{samp\_\-setASyncMode}} +\index{samp\_\-setASyncMode@{samp\_\-setASyncMode}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setASyncMode}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setASyncMode (handle\_\-t {\em handle})}} +\label{samp_8h_a9aef12dd82bfd38a2382a4ac88c54af} + + +Set the calling mode to use asynchronous messaging. + +SAMP\_\-SETASYNCMODE -- Set the calling mode to use asynchronous messaging. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_d4c1514e94c9ef511cfcd27004c38c4d}{ +\index{samp.h@{samp.h}!samp\_\-setCallByRef@{samp\_\-setCallByRef}} +\index{samp\_\-setCallByRef@{samp\_\-setCallByRef}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setCallByRef}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setCallByRef (handle\_\-t {\em handle})}} +\label{samp_8h_d4c1514e94c9ef511cfcd27004c38c4d} + + +Have interface call user handlers by reference. + +SAMP\_\-SETCALLBYREF -- Have interface call user handlers by reference. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_fc27715ec9a5cb60cf0b5415eb7f9a48}{ +\index{samp.h@{samp.h}!samp\_\-setCallMode@{samp\_\-setCallMode}} +\index{samp\_\-setCallMode@{samp\_\-setCallMode}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setCallMode}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setCallMode (handle\_\-t {\em handle}, \/ int {\em mode})}} +\label{samp_8h_fc27715ec9a5cb60cf0b5415eb7f9a48} + + +Set the default calling mode (synch or asynch). + +SAMP\_\-SETCALLMODE -- Set the default calling mode (synch or asynch) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em mode}]call mode (synch or asynch) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_3c026895e4d28567eb63c3b9cc16cd40}{ +\index{samp.h@{samp.h}!samp\_\-setErr@{samp\_\-setErr}} +\index{samp\_\-setErr@{samp\_\-setErr}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setErr}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-setErr (handle\_\-t {\em handle}, \/ {\bf Map} {\em resp})}} +\label{samp_8h_3c026895e4d28567eb63c3b9cc16cd40} + + +Set the error response string. + +SAMP\_\-SETERR -- Set the error response string/code. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em resp}]Response map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +Referenced by samp\_\-callAll(), samp\_\-callAndWait(), samp\_\-Ping(), and samp\_\-sendMsg().\hypertarget{samp_8h_041a551aff57ca03f3ff72a9803e2b58}{ +\index{samp.h@{samp.h}!samp\_\-setFloatInList@{samp\_\-setFloatInList}} +\index{samp\_\-setFloatInList@{samp\_\-setFloatInList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setFloatInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setFloatInList ({\bf List} {\em list}, \/ float {\em rval})}} +\label{samp_8h_041a551aff57ca03f3ff72a9803e2b58} + + +Set a Float in a List (append). + +SAMP\_\-SETFLOATINLIST -- Set a Float in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list1}]List object handle \item[{\em rval}]Float value to be appended \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_0f07ae542f5b317311b3799bd96a88fd}{ +\index{samp.h@{samp.h}!samp\_\-setFloatInMap@{samp\_\-setFloatInMap}} +\index{samp\_\-setFloatInMap@{samp\_\-setFloatInMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setFloatInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setFloatInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ float {\em value})}} +\label{samp_8h_0f07ae542f5b317311b3799bd96a88fd} + + +Set a string in a Map (append). + +SAMP\_\-SETFLOATINMAP -- Set a Float in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em value}]value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_1cd88b9e964d61403d6aad89dddce591}{ +\index{samp.h@{samp.h}!samp\_\-setHandlerReply@{samp\_\-setHandlerReply}} +\index{samp\_\-setHandlerReply@{samp\_\-setHandlerReply}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setHandlerReply}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setHandlerReply ({\bf Map} {\em resp})}} +\label{samp_8h_1cd88b9e964d61403d6aad89dddce591} + + +Set the \hyperlink{structSamp}{Samp} Handler reply map. + +SAMP\_\-SETHANDLERREPLY -- Set the \hyperlink{structSamp}{Samp} Handler reply map. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em resp}]response map \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-envGetHandler(), and samp\_\-paramGetHandler().\hypertarget{samp_8h_2d8a8a26d7284bb211a933895cddd29c}{ +\index{samp.h@{samp.h}!samp\_\-setIntInList@{samp\_\-setIntInList}} +\index{samp\_\-setIntInList@{samp\_\-setIntInList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setIntInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setIntInList ({\bf List} {\em list}, \/ int {\em ival})}} +\label{samp_8h_2d8a8a26d7284bb211a933895cddd29c} + + +Set an Int in a List (append). + +SAMP\_\-SETINTINLIST -- Set an Int in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list1}]List object handle \item[{\em ival}]Integer value to be appended \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-tableSelectRowList().\hypertarget{samp_8h_c22ec42dbf9a01c9b4e00cf011e7eb9d}{ +\index{samp.h@{samp.h}!samp\_\-setIntInMap@{samp\_\-setIntInMap}} +\index{samp\_\-setIntInMap@{samp\_\-setIntInMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setIntInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setIntInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ int {\em value})}} +\label{samp_8h_c22ec42dbf9a01c9b4e00cf011e7eb9d} + + +Set a Int in a Map (append). + +SAMP\_\-SETINTINMAP -- Set a Int in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em value}]value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_0ff97d44e62b7c88a046a29324552400}{ +\index{samp.h@{samp.h}!samp\_\-setListInList@{samp\_\-setListInList}} +\index{samp\_\-setListInList@{samp\_\-setListInList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setListInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setListInList ({\bf List} {\em list1}, \/ {\bf List} {\em list2})}} +\label{samp_8h_0ff97d44e62b7c88a046a29324552400} + + +Set a List in another List (append). + +SAMP\_\-SETLISTINLIST -- Set a List in another List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list1}]List object handle \item[{\em list2}]List to be appended \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_362c2f670c98dd6a3ef69debd1871604}{ +\index{samp.h@{samp.h}!samp\_\-setListInMap@{samp\_\-setListInMap}} +\index{samp\_\-setListInMap@{samp\_\-setListInMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setListInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setListInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ {\bf List} {\em list})}} +\label{samp_8h_362c2f670c98dd6a3ef69debd1871604} + + +Set a List in a Map (append). + +SAMP\_\-SETLISTINMAP -- Set a List in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em list}]handle to List object to set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_ea188bb711f3b5549d11204b0ff2da08}{ +\index{samp.h@{samp.h}!samp\_\-setMapInList@{samp\_\-setMapInList}} +\index{samp\_\-setMapInList@{samp\_\-setMapInList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setMapInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setMapInList ({\bf List} {\em list}, \/ {\bf Map} {\em map})}} +\label{samp_8h_ea188bb711f3b5549d11204b0ff2da08} + + +Set a Map in a List (append). + +SAMP\_\-SETMAPINLIST -- Set a Map in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em map}]Map object to be set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_f102490efe1b92d99b67f244dc498c7b}{ +\index{samp.h@{samp.h}!samp\_\-setMapInMap@{samp\_\-setMapInMap}} +\index{samp\_\-setMapInMap@{samp\_\-setMapInMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setMapInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setMapInMap ({\bf Map} {\em map1}, \/ char $\ast$ {\em key}, \/ {\bf Map} {\em map2})}} +\label{samp_8h_f102490efe1b92d99b67f244dc498c7b} + + +Set a Map in a Map (append). + +SAMP\_\-SETMAPINMAP -- Set a Map in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map1}]handle to Map object \item[{\em key}]Map key \item[{\em map2}]handle to Map object to set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-envGetHandler(), samp\_\-getOKMap(), samp\_\-paramGetHandler(), and sampInit().\hypertarget{samp_8h_68b51d70127bbff10fd30396e40a482d}{ +\index{samp.h@{samp.h}!samp\_\-setMsgMode@{samp\_\-setMsgMode}} +\index{samp\_\-setMsgMode@{samp\_\-setMsgMode}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setMsgMode}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setMsgMode (handle\_\-t {\em handle}, \/ int {\em mode})}} +\label{samp_8h_68b51d70127bbff10fd30396e40a482d} + + +Set the message pattern to the specified mode. + +SAMP\_\-SETMSGMODE -- Set the message pattern to the specified mode. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em mode}]message mode \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::msgMode.\hypertarget{samp_8h_9056a8601300892f918835259c7fdb3b}{ +\index{samp.h@{samp.h}!samp\_\-setNotifyMode@{samp\_\-setNotifyMode}} +\index{samp\_\-setNotifyMode@{samp\_\-setNotifyMode}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setNotifyMode}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setNotifyMode (handle\_\-t {\em handle})}} +\label{samp_8h_9056a8601300892f918835259c7fdb3b} + + +Set the calling mode to use notification messaging. + +SAMP\_\-SETNOTIFYMODE -- Set the calling mode to use notification messaging. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_a3c0bdb4c512357dbc53b0ad7a7d5b01}{ +\index{samp.h@{samp.h}!samp\_\-setReplyCallback@{samp\_\-setReplyCallback}} +\index{samp\_\-setReplyCallback@{samp\_\-setReplyCallback}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setReplyCallback}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setReplyCallback (handle\_\-t {\em handle}, \/ int $\ast$ {\em func})}} +\label{samp_8h_a3c0bdb4c512357dbc53b0ad7a7d5b01} + + +Set the Reply callback. samp\_\-setReplyCallback (handle\_\-t handle, int $\ast$func). + +SAMP\_\-SETREPLYCALLBACK -- Set the Reply callback. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em func}]callback for Reply message \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_3db66f28546459327665f8491ea97f4d}{ +\index{samp.h@{samp.h}!samp\_\-setResponseCallback@{samp\_\-setResponseCallback}} +\index{samp\_\-setResponseCallback@{samp\_\-setResponseCallback}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setResponseCallback}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setResponseCallback (handle\_\-t {\em handle}, \/ int $\ast$ {\em func})}} +\label{samp_8h_3db66f28546459327665f8491ea97f4d} + + +Set the Response callback. samp\_\-setResponseCallback (handle\_\-t handle, int $\ast$func). + +SAMP\_\-SETRESPONSECALLBACK -- Set the Response callback. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em func}]callback for message response \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_8b83cf8a75c16c45c547be68f0bf9f64}{ +\index{samp.h@{samp.h}!samp\_\-setSampHandler@{samp\_\-setSampHandler}} +\index{samp\_\-setSampHandler@{samp\_\-setSampHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setSampHandler}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setSampHandler (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype}, \/ void $\ast$ {\em func})}} +\label{samp_8h_8b83cf8a75c16c45c547be68f0bf9f64} + + +Set the SAMP interface handler for the mtype. + +SAMP\_\-SETSAMPHANDLER -- Set the SAMP interface handler for the mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \item[{\em func}]callback function \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-Subscribe().\hypertarget{samp_8h_5b69180b036e58528c98b1cf5a42825a}{ +\index{samp.h@{samp.h}!samp\_\-setStringInList@{samp\_\-setStringInList}} +\index{samp\_\-setStringInList@{samp\_\-setStringInList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setStringInList}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setStringInList ({\bf List} {\em list}, \/ char $\ast$ {\em value})}} +\label{samp_8h_5b69180b036e58528c98b1cf5a42825a} + + +Set a string in a List (append). + +SAMP\_\-SETSTRINGINLIST -- Set a string in a List (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em list}]List object handle \item[{\em value}]string value to set \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-GetRegisteredClients(), and samp\_\-GetSubscribedClients().\hypertarget{samp_8h_b9b2157de89369eb5cd95bfe804eb89a}{ +\index{samp.h@{samp.h}!samp\_\-setStringInMap@{samp\_\-setStringInMap}} +\index{samp\_\-setStringInMap@{samp\_\-setStringInMap}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setStringInMap}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setStringInMap ({\bf Map} {\em map}, \/ char $\ast$ {\em key}, \/ char $\ast$ {\em value})}} +\label{samp_8h_b9b2157de89369eb5cd95bfe804eb89a} + + +Set a string in a Map (append). + +SAMP\_\-SETSTRINGINMAP -- Set a string in a Map (append) + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em map}]handle to Map object \item[{\em key}]Map key \item[{\em value}]Map value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-envGetHandler(), samp\_\-getOKMap(), samp\_\-paramGetHandler(), and sampInit().\hypertarget{samp_8h_1d00dc78292cfbc01262ef65ab055063}{ +\index{samp.h@{samp.h}!samp\_\-setSyncMode@{samp\_\-setSyncMode}} +\index{samp\_\-setSyncMode@{samp\_\-setSyncMode}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setSyncMode}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setSyncMode (handle\_\-t {\em handle})}} +\label{samp_8h_1d00dc78292cfbc01262ef65ab055063} + + +Set the calling mode to use synchronous messaging. + +SAMP\_\-SETSYNCMODE -- Set the calling mode to use synchronous messaging. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_e11a97c262ab5ab4438eca6c60c0d8cf}{ +\index{samp.h@{samp.h}!samp\_\-setTimeout@{samp\_\-setTimeout}} +\index{samp\_\-setTimeout@{samp\_\-setTimeout}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setTimeout}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-setTimeout (handle\_\-t {\em handle}, \/ int {\em timeout})}} +\label{samp_8h_e11a97c262ab5ab4438eca6c60c0d8cf} + + +Set the message timeout value (in seconds). + +SAMP\_\-SETTIMEOUT -- Set the message timeout value (in seconds). + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp handle \item[{\em name}]application name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_b969017f97d850b092bde60a2d445a2b}{ +\index{samp.h@{samp.h}!samp\_\-setUserHandler@{samp\_\-setUserHandler}} +\index{samp\_\-setUserHandler@{samp\_\-setUserHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-setUserHandler}]{\setlength{\rightskip}{0pt plus 5cm}samp\_\-setUserHandler (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype}, \/ void $\ast$ {\em func})}} +\label{samp_8h_b969017f97d850b092bde60a2d445a2b} + + +Set the user-interface handler for the mtype. + +SAMP\_\-SETUSERHANDLER -- Set the user-interface handler for the mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \item[{\em func}]callback function \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-Subscribe().\hypertarget{samp_8h_bc319b97b3dbea29bd79c4f723db5438}{ +\index{samp.h@{samp.h}!samp\_\-specLoadHandler@{samp\_\-specLoadHandler}} +\index{samp\_\-specLoadHandler@{samp\_\-specLoadHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-specLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-specLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_bc319b97b3dbea29bd79c4f723db5438} + + +Handle a spectrum.load.$\ast$ message. + +SAMP\_\-SPECLOADHANDLER -- Handle a spectrum.load.$\ast$ message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +Referenced by samp\_\-specSSAHandler().\hypertarget{samp_8h_4869a1bb04a96514f153dc5bfbed8e6e}{ +\index{samp.h@{samp.h}!samp\_\-specLoadSSAGeneric@{samp\_\-specLoadSSAGeneric}} +\index{samp\_\-specLoadSSAGeneric@{samp\_\-specLoadSSAGeneric}!samp.h@{samp.h}} +\subsubsection[{samp\_\-specLoadSSAGeneric}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-specLoadSSAGeneric (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf Map} {\em meta}, \/ {\bf String} {\em spectrumId}, \/ {\bf String} {\em name})}} +\label{samp_8h_4869a1bb04a96514f153dc5bfbed8e6e} + + +Load a generic spectrum from an SSA service. + +SAMP\_\-SPECLOADSSAGENERIC -- Load a generic spectrum from an SSA service. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]name of recipient (or 'all') \item[{\em url}]URL of spectrum to load \item[{\em meta}]Metadata map describing data found at the URL \item[{\em spectrumId}]Identifier for spectrum (optional) \item[{\em name}]Name used to label spectrum (optional); \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_dd2bca8fa3bf3b4ebbf449edc6b65d85}{ +\index{samp.h@{samp.h}!samp\_\-specSSAHandler@{samp\_\-specSSAHandler}} +\index{samp\_\-specSSAHandler@{samp\_\-specSSAHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-specSSAHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-specSSAHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_dd2bca8fa3bf3b4ebbf449edc6b65d85} + + +Handle a spectrum.load.ssa-generic message. + +SAMP\_\-SPECSSAHANDLER -- Handle a spectrum.load.ssa-generic message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_2e342b672e77e012cc98a6f5506a44be}{ +\index{samp.h@{samp.h}!samp\_\-StatusHandler@{samp\_\-StatusHandler}} +\index{samp\_\-StatusHandler@{samp\_\-StatusHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-StatusHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-StatusHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_2e342b672e77e012cc98a6f5506a44be} + + +Return status of the task. + +SAMP\_\-STATUSHANDLER -- Return status of the task. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_c6b76655d73825acdacfac8b5a1139ee}{ +\index{samp.h@{samp.h}!samp\_\-Subscribe@{samp\_\-Subscribe}} +\index{samp\_\-Subscribe@{samp\_\-Subscribe}!samp.h@{samp.h}} +\subsubsection[{samp\_\-Subscribe}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-Subscribe (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype}, \/ void $\ast$ {\em userFunc})}} +\label{samp_8h_c6b76655d73825acdacfac8b5a1139ee} + + +Subscribe to a given mtype. + +SAMP\_\-SUBSCRIBE -- Subscribe to a given mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \item[{\em func}]callback function \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_0503d3ee247a6a962a2a8da672261ab7}{ +\index{samp.h@{samp.h}!samp\_\-tableHighlightRow@{samp\_\-tableHighlightRow}} +\index{samp\_\-tableHighlightRow@{samp\_\-tableHighlightRow}!samp.h@{samp.h}} +\subsubsection[{samp\_\-tableHighlightRow}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-tableHighlightRow (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em url}, \/ int {\em row})}} +\label{samp_8h_0503d3ee247a6a962a2a8da672261ab7} + + +Tell an app to highlight a table row. + +SAMP\_\-TABLEHIGHLIGHTROW -- Tell an app to highlight a table row. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em tableId}]ID associated with a previously loaded table \item[{\em url}]URL to table to be loaded \item[{\em rows}]List of (zero-based) row indices \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_6b950e53c7fdf481a13c8a2ec353dca1}{ +\index{samp.h@{samp.h}!samp\_\-tableLoadFITS@{samp\_\-tableLoadFITS}} +\index{samp\_\-tableLoadFITS@{samp\_\-tableLoadFITS}!samp.h@{samp.h}} +\subsubsection[{samp\_\-tableLoadFITS}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-tableLoadFITS (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em name})}} +\label{samp_8h_6b950e53c7fdf481a13c8a2ec353dca1} + + +Tell an app to load a FITS table. + +SAMP\_\-TABLELOADFITS -- Tell an app to load a FITS table. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em url}]URL to table to be loaded \item[{\em tableId}]ID assigned to table (optional) \item[{\em name}]Name assigned to table (optional) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_45c2023312cd2adfa40feb2eb8a3e143}{ +\index{samp.h@{samp.h}!samp\_\-tableLoadVOTable@{samp\_\-tableLoadVOTable}} +\index{samp\_\-tableLoadVOTable@{samp\_\-tableLoadVOTable}!samp.h@{samp.h}} +\subsubsection[{samp\_\-tableLoadVOTable}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-tableLoadVOTable (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em url}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em name})}} +\label{samp_8h_45c2023312cd2adfa40feb2eb8a3e143} + + +Tell an app to load a VOTable. + +SAMP\_\-TABLELOADVOTABLE -- Tell an app to load a VOTable. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em url}]URL to table to be loaded \item[{\em tableId}]ID assigned to table (optional) \item[{\em name}]Name assigned to table (optional) \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_a410ef908863f7c5b2c99844ebb73d35}{ +\index{samp.h@{samp.h}!samp\_\-tableSelectRowList@{samp\_\-tableSelectRowList}} +\index{samp\_\-tableSelectRowList@{samp\_\-tableSelectRowList}!samp.h@{samp.h}} +\subsubsection[{samp\_\-tableSelectRowList}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-tableSelectRowList (handle\_\-t {\em handle}, \/ {\bf String} {\em recip}, \/ {\bf String} {\em tableId}, \/ {\bf String} {\em url}, \/ int {\em rows}\mbox{[}$\,$\mbox{]}, \/ int {\em nrows})}} +\label{samp_8h_a410ef908863f7c5b2c99844ebb73d35} + + +Tell an app to select a list of table rows. + +SAMP\_\-TABLESELECTROWLIST -- Tell an app to select a list of table rows. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \item[{\em recip}]Message recipient (or \char`\"{}all\char`\"{} for broadcast) \item[{\em tableId}]ID associated with a previously loaded table \item[{\em url}]URL to table to be loaded \item[{\em rows}]Array of (zero-based) row indices \item[{\em nrows}]Number of rows \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_d9184eb45a5bc93b5205fd5b1c6ef688}{ +\index{samp.h@{samp.h}!samp\_\-tbHighlightHandler@{samp\_\-tbHighlightHandler}} +\index{samp\_\-tbHighlightHandler@{samp\_\-tbHighlightHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-tbHighlightHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbHighlightHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_d9184eb45a5bc93b5205fd5b1c6ef688} + + +Handle a table.highlight.row message. + +SAMP\_\-TBHIGHLIGHTHANDLER -- Handle a table.highlight.row message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_750c0fee0c7a99e135299c08751f288c}{ +\index{samp.h@{samp.h}!samp\_\-tbLoadFITSHandler@{samp\_\-tbLoadFITSHandler}} +\index{samp\_\-tbLoadFITSHandler@{samp\_\-tbLoadFITSHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-tbLoadFITSHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbLoadFITSHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_750c0fee0c7a99e135299c08751f288c} + + +Handle a generic table.load.fits message. + +SAMP\_\-TBLOADFITSHANDLER -- Handle a generic table.load.fits message $\ast$\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_26f96dc6cbf72283e2ee9cb8b4619ed3}{ +\index{samp.h@{samp.h}!samp\_\-tbLoadHandler@{samp\_\-tbLoadHandler}} +\index{samp\_\-tbLoadHandler@{samp\_\-tbLoadHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-tbLoadHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbLoadHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_26f96dc6cbf72283e2ee9cb8b4619ed3} + + +Handle a generic table.load.$\ast$ message. + +SAMP\_\-TBLOADHANDLER -- Handle a generic table.load.$\ast$ message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} + + +Referenced by samp\_\-tbLoadFITSHandler(), and samp\_\-tbLoadVOTHandler().\hypertarget{samp_8h_144ec2329355d91022d5ea38736c0093}{ +\index{samp.h@{samp.h}!samp\_\-tbLoadVOTHandler@{samp\_\-tbLoadVOTHandler}} +\index{samp\_\-tbLoadVOTHandler@{samp\_\-tbLoadVOTHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-tbLoadVOTHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbLoadVOTHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_144ec2329355d91022d5ea38736c0093} + + +Handle a generic table.load.votable message. + +SAMP\_\-TBLOADVOTHANDLER -- Handle a generic table.load.votable message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_98d68d7091c0b7790631bb53e0ace656}{ +\index{samp.h@{samp.h}!samp\_\-tbSelectHandler@{samp\_\-tbSelectHandler}} +\index{samp\_\-tbSelectHandler@{samp\_\-tbSelectHandler}!samp.h@{samp.h}} +\subsubsection[{samp\_\-tbSelectHandler}]{\setlength{\rightskip}{0pt plus 5cm}int samp\_\-tbSelectHandler ({\bf String} {\em sender}, \/ {\bf String} {\em mtype}, \/ {\bf String} {\em msg\_\-id}, \/ {\bf Map} {\em msg\_\-map})}} +\label{samp_8h_98d68d7091c0b7790631bb53e0ace656} + + +Handle a table.select.rowList message. + +SAMP\_\-TBSELECTHANDLER -- Handle a table.select.rowList message + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em sender}]sender name \item[{\em mtype}]mtype string \item[{\em msg\_\-id}]message id \item[{\em msg\_\-map}]message map struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_5e3a44429f332694cc2cedc2e38856ce}{ +\index{samp.h@{samp.h}!samp\_\-UnRegister@{samp\_\-UnRegister}} +\index{samp\_\-UnRegister@{samp\_\-UnRegister}!samp.h@{samp.h}} +\subsubsection[{samp\_\-UnRegister}]{\setlength{\rightskip}{0pt plus 5cm}stat samp\_\-UnRegister (handle\_\-t {\em handle})}} +\label{samp_8h_5e3a44429f332694cc2cedc2e38856ce} + + +Un-Register from the hub. + +SAMP\_\-UNREGISTER -- Un-Register from the hub. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]samp struct handle \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]SAMP\_\-OK or SAMP\_\-ERR \end{Desc} +\hypertarget{samp_8h_b3fded97bbbf3751c4916543959f16a5}{ +\index{samp.h@{samp.h}!samp\_\-Unsubscribe@{samp\_\-Unsubscribe}} +\index{samp\_\-Unsubscribe@{samp\_\-Unsubscribe}!samp.h@{samp.h}} +\subsubsection[{samp\_\-Unsubscribe}]{\setlength{\rightskip}{0pt plus 5cm}void samp\_\-Unsubscribe (handle\_\-t {\em handle}, \/ {\bf String} {\em mtype})}} +\label{samp_8h_b3fded97bbbf3751c4916543959f16a5} + + +Unsubscribe to a given mtype. + +SAMP\_\-UNSUBSCRIBE -- Unsubscribe to a given mtype. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em mtype}]mtype name \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_123413db26ad50a84bd41863af5deae5}{ +\index{samp.h@{samp.h}!sampClose@{sampClose}} +\index{sampClose@{sampClose}!samp.h@{samp.h}} +\subsubsection[{sampClose}]{\setlength{\rightskip}{0pt plus 5cm}void sampClose (handle\_\-t {\em handle})}} +\label{samp_8h_123413db26ad50a84bd41863af5deae5} + + +Close the SAMP interface and free resources. + +SAMP\_\-CLOSE -- Close the SAMP interface. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_124214f79e99619b377d98ed2fd93eb9}{ +\index{samp.h@{samp.h}!sampDebug@{sampDebug}} +\index{sampDebug@{sampDebug}!samp.h@{samp.h}} +\subsubsection[{sampDebug}]{\setlength{\rightskip}{0pt plus 5cm}int sampDebug (handle\_\-t {\em handle}, \/ int {\em value})}} +\label{samp_8h_124214f79e99619b377d98ed2fd93eb9} + + +Set interface debug level. + +SAMPDEBUG -- Set interface debug level. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em value}]debug value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::debug, and Samp::verbose.\hypertarget{samp_8h_30f39c72c3783055faa82ad3860f3d1d}{ +\index{samp.h@{samp.h}!sampInit@{sampInit}} +\index{sampInit@{sampInit}!samp.h@{samp.h}} +\subsubsection[{sampInit}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t sampInit ({\bf String} {\em appName}, \/ {\bf String} {\em description})}} +\label{samp_8h_30f39c72c3783055faa82ad3860f3d1d} + + +Initialize the SAMP interface. + +Prototype declarations. + +SAMP\_\-INIT -- Initialize the SAMP interface. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em appName}]application name \item[{\em description}]description of application \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]samp handle \end{Desc} +\hypertarget{samp_8h_329a8a5f83162ed49baa28f008131d45}{ +\index{samp.h@{samp.h}!sampLog@{sampLog}} +\index{sampLog@{sampLog}!samp.h@{samp.h}} +\subsubsection[{sampLog}]{\setlength{\rightskip}{0pt plus 5cm}sampLog (handle\_\-t {\em handle}, \/ char $\ast$ {\em format}, \/ {\em ...})}} +\label{samp_8h_329a8a5f83162ed49baa28f008131d45} + + +SAMP message logger. + +SAMPLOG -- SAMP message logger. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]SAMP handle \item[{\em format}]message format string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_65908d088c8b917d10db38c147590ad9}{ +\index{samp.h@{samp.h}!sampShutdown@{sampShutdown}} +\index{sampShutdown@{sampShutdown}!samp.h@{samp.h}} +\subsubsection[{sampShutdown}]{\setlength{\rightskip}{0pt plus 5cm}int sampShutdown (handle\_\-t {\em handle})}} +\label{samp_8h_65908d088c8b917d10db38c147590ad9} + + +Shut down the active SAMP interface. + +SAMP\_\-SHUTDOWN -- Shut down the active SAMP interface. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_8e18ae12df031094ace47863f93b3634}{ +\index{samp.h@{samp.h}!sampStartup@{sampStartup}} +\index{sampStartup@{sampStartup}!samp.h@{samp.h}} +\subsubsection[{sampStartup}]{\setlength{\rightskip}{0pt plus 5cm}int sampStartup (handle\_\-t {\em handle})}} +\label{samp_8h_8e18ae12df031094ace47863f93b3634} + + +Startup the SAMP interface to send/receive messages. + +SAMP\_\-STARTUP -- Startup the SAMP interface to send/receive messages. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} +\hypertarget{samp_8h_65e3987c9b510018dcdd91203b437e40}{ +\index{samp.h@{samp.h}!sampTrace@{sampTrace}} +\index{sampTrace@{sampTrace}!samp.h@{samp.h}} +\subsubsection[{sampTrace}]{\setlength{\rightskip}{0pt plus 5cm}sampTrace (handle\_\-t {\em handle}, \/ char $\ast$ {\em format}, \/ {\em ...})}} +\label{samp_8h_65e3987c9b510018dcdd91203b437e40} + + +SAMP tracer. + +SAMPTRACE -- SAMP tracer. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]SAMP handle \item[{\em format}]message format string \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +Referenced by samp\_\-Metadata(), sampClose(), and sampInit().\hypertarget{samp_8h_c0c812e5d3f2c9ee6c54067e4c81b3dd}{ +\index{samp.h@{samp.h}!sampVerbose@{sampVerbose}} +\index{sampVerbose@{sampVerbose}!samp.h@{samp.h}} +\subsubsection[{sampVerbose}]{\setlength{\rightskip}{0pt plus 5cm}int sampVerbose (handle\_\-t {\em handle}, \/ int {\em value})}} +\label{samp_8h_c0c812e5d3f2c9ee6c54067e4c81b3dd} + + +Set interface debug level. + +SAMPVERBOSE -- Set interface verbose level. + +\begin{Desc} +\item[Parameters:] +\begin{description} +\item[{\em handle}]user handle to samp struct \item[{\em value}]verbose value \end{description} +\end{Desc} +\begin{Desc} +\item[Returns:]nothing \end{Desc} + + +References Samp::verbose.
\ No newline at end of file diff --git a/vendor/voclient/libsamp/doc/latex/structClient.tex b/vendor/voclient/libsamp/doc/latex/structClient.tex new file mode 100644 index 00000000..fe0ca813 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/structClient.tex @@ -0,0 +1,37 @@ +\hypertarget{structClient}{ +\section{Client Struct Reference} +\label{structClient}\index{Client@{Client}} +} +{\tt \#include $<$samp.h$>$} + +\subsection*{Data Fields} +\begin{CompactItemize} +\item +\hypertarget{structClient_69ad045aad8793b0aa0984e245e549eb}{ +char \textbf{pubId} \mbox{[}SZ\_\-NAME\mbox{]}} +\label{structClient_69ad045aad8793b0aa0984e245e549eb} + +\item +char \hyperlink{structClient_67f4b49f5eda3f6cf1ff33a6fe883bf6}{name} \mbox{[}SZ\_\-NAME\mbox{]} +\end{CompactItemize} + + +\subsection{Detailed Description} +Registered \hyperlink{structClient}{Client} name mappings. + +\subsection{Field Documentation} +\hypertarget{structClient_67f4b49f5eda3f6cf1ff33a6fe883bf6}{ +\index{Client@{Client}!name@{name}} +\index{name@{name}!Client@{Client}} +\subsubsection[{name}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Client::name}}} +\label{structClient_67f4b49f5eda3f6cf1ff33a6fe883bf6} + + +public name + +Referenced by samp\_\-addClient(), samp\_\-app2id(), samp\_\-envGet(), samp\_\-id2app(), samp\_\-listClients(), samp\_\-mapClients(), samp\_\-paramGet(), samp\_\-removeClient(), and sampStartup(). + +The documentation for this struct was generated from the following files:\begin{CompactItemize} +\item +\hyperlink{samp_8h}{samp.h}\item +\hyperlink{sampDecl_8h}{sampDecl.h}\end{CompactItemize} diff --git a/vendor/voclient/libsamp/doc/latex/structHub.tex b/vendor/voclient/libsamp/doc/latex/structHub.tex new file mode 100644 index 00000000..e2db1a28 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/structHub.tex @@ -0,0 +1,167 @@ +\hypertarget{structHub}{ +\section{Hub Struct Reference} +\label{structHub}\index{Hub@{Hub}} +} +{\tt \#include $<$samp.h$>$} + +\subsection*{Data Fields} +\begin{CompactItemize} +\item +\hypertarget{structHub_2afdf379c978a0a93b1213d1469f5bd5}{ +char \textbf{appName} \mbox{[}SZ\_\-LINE\mbox{]}} +\label{structHub_2afdf379c978a0a93b1213d1469f5bd5} + +\item +char \hyperlink{structHub_b6cbad1270ab46610f03837d4a01648f}{appVer} \mbox{[}SZ\_\-LINE\mbox{]} +\item +char \hyperlink{structHub_d96b607b83480697b7147f95f84132fb}{description} \mbox{[}SZ\_\-LINE\mbox{]} +\item +\hyperlink{structappMD}{appMD} \hyperlink{structHub_cfe9051f3f0d6fd908ddf394283d1262}{meta} +\item +char \hyperlink{structHub_52a6b65f54e98c4f3b7441808e30fa6c}{secret} \mbox{[}SZ\_\-SECRET\mbox{]} +\item +char \hyperlink{structHub_81adb6d0cab27f61c0aaebbb7b7685e4}{url} \mbox{[}SZ\_\-URL\mbox{]} +\item +char \hyperlink{structHub_0e07ef26e39ed1282042364297591df5}{version} \mbox{[}SZ\_\-NAME\mbox{]} +\item +int \hyperlink{structHub_3546ac45740591096b9bdc4c37b8d5f5}{id} +\item +char \hyperlink{structHub_83ae1eed61525e4dd8795d7076b9a844}{appId} \mbox{[}SZ\_\-NAME\mbox{]} +\item +char \hyperlink{structHub_53b0a5acf4419ffff98c6510e84a9f62}{privateKey} \mbox{[}SZ\_\-LINE\mbox{]} +\item +char \hyperlink{structHub_c5ecb8cd6b3d61ab9e0fddfb643c65c3}{hubId} \mbox{[}SZ\_\-LINE\mbox{]} +\item +char \hyperlink{structHub_ce254c7adba1a20deb1dff7e112dd2a8}{selfId} \mbox{[}SZ\_\-LINE\mbox{]} +\item +char \hyperlink{structHub_b69adb014b0cef61d6632e60fb2dff5b}{timeout} \mbox{[}SZ\_\-NAME\mbox{]} +\item +void $\ast$ \hyperlink{structHub_cfd1b13e1f462d6595ce4e0b5ab08cb9}{samp} +\end{CompactItemize} + + +\subsection{Detailed Description} +\hyperlink{structHub}{Hub} description. Our application connects to this hub by default, but the structure will be valid for any \hyperlink{structHub}{Hub}. + +\subsection{Field Documentation} +\hypertarget{structHub_83ae1eed61525e4dd8795d7076b9a844}{ +\index{Hub@{Hub}!appId@{appId}} +\index{appId@{appId}!Hub@{Hub}} +\subsubsection[{appId}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::appId}}} +\label{structHub_83ae1eed61525e4dd8795d7076b9a844} + + +\hyperlink{structHub}{Hub} XML-RPC connection + +Referenced by samp\_\-hubOpen().\hypertarget{structHub_b6cbad1270ab46610f03837d4a01648f}{ +\index{Hub@{Hub}!appVer@{appVer}} +\index{appVer@{appVer}!Hub@{Hub}} +\subsubsection[{appVer}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::appVer}}} +\label{structHub_b6cbad1270ab46610f03837d4a01648f} + + +application name + +Referenced by samp\_\-hubOpen(), samp\_\-Metadata(), and samp\_\-setAppVersion().\hypertarget{structHub_d96b607b83480697b7147f95f84132fb}{ +\index{Hub@{Hub}!description@{description}} +\index{description@{description}!Hub@{Hub}} +\subsubsection[{description}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::description}}} +\label{structHub_d96b607b83480697b7147f95f84132fb} + + +application version + +Referenced by samp\_\-hubDeclareMetadata(), samp\_\-hubOpen(), and samp\_\-Metadata().\hypertarget{structHub_c5ecb8cd6b3d61ab9e0fddfb643c65c3}{ +\index{Hub@{Hub}!hubId@{hubId}} +\index{hubId@{hubId}!Hub@{Hub}} +\subsubsection[{hubId}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::hubId}}} +\label{structHub_c5ecb8cd6b3d61ab9e0fddfb643c65c3} + + +client key value + +Referenced by samp\_\-hubRegister(), and samp\_\-Register().\hypertarget{structHub_3546ac45740591096b9bdc4c37b8d5f5}{ +\index{Hub@{Hub}!id@{id}} +\index{id@{id}!Hub@{Hub}} +\subsubsection[{id}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Hub::id}}} +\label{structHub_3546ac45740591096b9bdc4c37b8d5f5} + + +\hyperlink{structHub}{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().\hypertarget{structHub_cfe9051f3f0d6fd908ddf394283d1262}{ +\index{Hub@{Hub}!meta@{meta}} +\index{meta@{meta}!Hub@{Hub}} +\subsubsection[{meta}]{\setlength{\rightskip}{0pt plus 5cm}{\bf appMD} {\bf Hub::meta}}} +\label{structHub_cfe9051f3f0d6fd908ddf394283d1262} + + +descriptive text + +Referenced by samp\_\-hubClose(), samp\_\-hubDeclareMetadata(), samp\_\-hubOpen(), and samp\_\-Metadata().\hypertarget{structHub_53b0a5acf4419ffff98c6510e84a9f62}{ +\index{Hub@{Hub}!privateKey@{privateKey}} +\index{privateKey@{privateKey}!Hub@{Hub}} +\subsubsection[{privateKey}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::privateKey}}} +\label{structHub_53b0a5acf4419ffff98c6510e84a9f62} + + +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().\hypertarget{structHub_cfd1b13e1f462d6595ce4e0b5ab08cb9}{ +\index{Hub@{Hub}!samp@{samp}} +\index{samp@{samp}!Hub@{Hub}} +\subsubsection[{samp}]{\setlength{\rightskip}{0pt plus 5cm}void $\ast$ {\bf Hub::samp}}} +\label{structHub_cfd1b13e1f462d6595ce4e0b5ab08cb9} + + +Sync msg timeout (str) + +Referenced by samp\_\-hubDeclareSubscriptions(), and samp\_\-hubOpen().\hypertarget{structHub_52a6b65f54e98c4f3b7441808e30fa6c}{ +\index{Hub@{Hub}!secret@{secret}} +\index{secret@{secret}!Hub@{Hub}} +\subsubsection[{secret}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::secret}}} +\label{structHub_52a6b65f54e98c4f3b7441808e30fa6c} + + +metadata + +Referenced by samp\_\-hubRegister(), and samp\_\-Register().\hypertarget{structHub_ce254c7adba1a20deb1dff7e112dd2a8}{ +\index{Hub@{Hub}!selfId@{selfId}} +\index{selfId@{selfId}!Hub@{Hub}} +\subsubsection[{selfId}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::selfId}}} +\label{structHub_ce254c7adba1a20deb1dff7e112dd2a8} + + +\hyperlink{structHub}{Hub} id value + +Referenced by samp\_\-hubRegister(), and samp\_\-Register().\hypertarget{structHub_b69adb014b0cef61d6632e60fb2dff5b}{ +\index{Hub@{Hub}!timeout@{timeout}} +\index{timeout@{timeout}!Hub@{Hub}} +\subsubsection[{timeout}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::timeout}}} +\label{structHub_b69adb014b0cef61d6632e60fb2dff5b} + + +\hyperlink{structClient}{Client} id value + +Referenced by samp\_\-callAndWait(), samp\_\-envGet(), samp\_\-hubOpen(), samp\_\-paramGet(), and samp\_\-setTimeout().\hypertarget{structHub_81adb6d0cab27f61c0aaebbb7b7685e4}{ +\index{Hub@{Hub}!url@{url}} +\index{url@{url}!Hub@{Hub}} +\subsubsection[{url}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::url}}} +\label{structHub_81adb6d0cab27f61c0aaebbb7b7685e4} + + +registration string + +Referenced by samp\_\-hubOpen().\hypertarget{structHub_0e07ef26e39ed1282042364297591df5}{ +\index{Hub@{Hub}!version@{version}} +\index{version@{version}!Hub@{Hub}} +\subsubsection[{version}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Hub::version}}} +\label{structHub_0e07ef26e39ed1282042364297591df5} + + +\hyperlink{structHub}{Hub} service endpoint + +The documentation for this struct was generated from the following files:\begin{CompactItemize} +\item +\hyperlink{samp_8h}{samp.h}\item +\hyperlink{sampDecl_8h}{sampDecl.h}\end{CompactItemize} diff --git a/vendor/voclient/libsamp/doc/latex/structSamp.tex b/vendor/voclient/libsamp/doc/latex/structSamp.tex new file mode 100644 index 00000000..21780ddf --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/structSamp.tex @@ -0,0 +1,271 @@ +\hypertarget{structSamp}{ +\section{Samp Struct Reference} +\label{structSamp}\index{Samp@{Samp}} +} +{\tt \#include $<$samp.h$>$} + +\subsection*{Data Fields} +\begin{CompactItemize} +\item +\hypertarget{structSamp_f372ba3fd5ff2d8c8ec06bd33403ca9e}{ +char \textbf{appName} \mbox{[}SZ\_\-NAME\mbox{]}} +\label{structSamp_f372ba3fd5ff2d8c8ec06bd33403ca9e} + +\item +char \hyperlink{structSamp_df7c497b6dbffc08e8ef5d7edd4ee97e}{appVer} \mbox{[}SZ\_\-LINE\mbox{]} +\item +char \hyperlink{structSamp_d672d7d425e8180b93c7ca2229d1acd8}{description} \mbox{[}SZ\_\-NAME\mbox{]} +\item +char \hyperlink{structSamp_62629ad2155a2a1a7676e32ef9fb9ffd}{errortxt} \mbox{[}SZ\_\-LINE\mbox{]} +\item +\hyperlink{structappMD}{appMD} \hyperlink{structSamp_0884021074d1ed14342187005e0b78e7}{meta} +\item +pthread\_\-t \hyperlink{structSamp_e7db0cac0c4ad61c9ed7f3d344b623cf}{svrThread} +\item +int($\ast$ \hyperlink{structSamp_eb399d3fb381bee752b5747ff4cb9a9b}{defaultUserFunc} )(char $\ast$sender, char $\ast$msgid, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\item +\hypertarget{structSamp_60d87008915bca91796cbdf77537e5f0}{ +\hyperlink{structSubs}{Subs} \textbf{subs} \mbox{[}MAX\_\-SUBS\mbox{]}} +\label{structSamp_60d87008915bca91796cbdf77537e5f0} + +\item +int \hyperlink{structSamp_36f4cfae3407b8961e57a77abca7d599}{nsubs} +\item +\hyperlink{structClient}{Client} \hyperlink{structSamp_2cc1f00b9e4bae456e0e72b90147df7b}{clients} \mbox{[}MAX\_\-CLIENTS\mbox{]} +\item +int \hyperlink{structSamp_97ef8ad57159f4b6c4fcd93a12853b69}{nclients} +\item +int \hyperlink{structSamp_69b05b2fa1ab19729d81659ad64387a0}{serverTid} +\item +int \hyperlink{structSamp_8849cb13cbedae805b4e35327bc449e2}{serverPort} +\item +\hyperlink{structHub}{Hub} $\ast$ \hyperlink{structSamp_14811ec2253a6e2e75a8ec863c4150b0}{hub} +\item +handle\_\-t \hyperlink{structSamp_03918136809ece7e60de4e30c64b6224}{hubHandle} +\item +int \hyperlink{structSamp_723b2538cfd65122c49783b36a7d30b5}{hubThreadID} +\item +int \hyperlink{structSamp_32402da48b11693c13252edbdca7673c}{active} +\item +int \hyperlink{structSamp_c8eee2b56f226f59d814fd1baa751b77}{mapClients} +\item +int \hyperlink{structSamp_30ca22535582e7bf6416627d1cd46525}{msgMode} +\item +int \hyperlink{structSamp_14f6ed59a947504d37bd8cdd1f2f8e8d}{handlerMode} +\item +FILE $\ast$ \hyperlink{structSamp_79f2ee1f48cb40edaf9b63ccdbb6942f}{logfd} +\item +int \hyperlink{structSamp_d8469d2447cd872101fb83d92f85049e}{debug} +\item +int \hyperlink{structSamp_981b01bd09deddb039db3567825bd653}{verbose} +\item +int \hyperlink{structSamp_25ddaf846639c7c67ea651a578b804ad}{trace} +\end{CompactItemize} + + +\subsection{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. + +\subsection{Field Documentation} +\hypertarget{structSamp_32402da48b11693c13252edbdca7673c}{ +\index{Samp@{Samp}!active@{active}} +\index{active@{active}!Samp@{Samp}} +\subsubsection[{active}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::active}}} +\label{structSamp_32402da48b11693c13252edbdca7673c} + + +\hyperlink{structHub}{Hub} thread id + +Referenced by samp\_\-hubActive(), sampShutdown(), and sampStartup().\hypertarget{structSamp_df7c497b6dbffc08e8ef5d7edd4ee97e}{ +\index{Samp@{Samp}!appVer@{appVer}} +\index{appVer@{appVer}!Samp@{Samp}} +\subsubsection[{appVer}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Samp::appVer}}} +\label{structSamp_df7c497b6dbffc08e8ef5d7edd4ee97e} + + +application name + +Referenced by samp\_\-hubOpen(), samp\_\-Metadata(), and samp\_\-setAppVersion().\hypertarget{structSamp_2cc1f00b9e4bae456e0e72b90147df7b}{ +\index{Samp@{Samp}!clients@{clients}} +\index{clients@{clients}!Samp@{Samp}} +\subsubsection[{clients}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Client} {\bf Samp::clients}}} +\label{structSamp_2cc1f00b9e4bae456e0e72b90147df7b} + + +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().\hypertarget{structSamp_d8469d2447cd872101fb83d92f85049e}{ +\index{Samp@{Samp}!debug@{debug}} +\index{debug@{debug}!Samp@{Samp}} +\subsubsection[{debug}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::debug}}} +\label{structSamp_d8469d2447cd872101fb83d92f85049e} + + +log file descriptor + +Referenced by samp\_\-call(), samp\_\-callAll(), samp\_\-callAndWait(), samp\_\-notifyAll(), sampDebug(), and sampLog().\hypertarget{structSamp_eb399d3fb381bee752b5747ff4cb9a9b}{ +\index{Samp@{Samp}!defaultUserFunc@{defaultUserFunc}} +\index{defaultUserFunc@{defaultUserFunc}!Samp@{Samp}} +\subsubsection[{defaultUserFunc}]{\setlength{\rightskip}{0pt plus 5cm}int($\ast$ {\bf Samp::defaultUserFunc})(char $\ast$sender, char $\ast$msgid, {\bf Map} map) (char $\ast$ {\em sender}, \/ char $\ast$ {\em msgid}, \/ {\bf Map} {\em map})}} +\label{structSamp_eb399d3fb381bee752b5747ff4cb9a9b} + + +server thread number default user handler + +Referenced by samp\_\-execUserHandler(), samp\_\-getUserHandler(), samp\_\-receiveCall(), samp\_\-receiveNotification(), samp\_\-receiveResponse(), and samp\_\-setUserHandler().\hypertarget{structSamp_d672d7d425e8180b93c7ca2229d1acd8}{ +\index{Samp@{Samp}!description@{description}} +\index{description@{description}!Samp@{Samp}} +\subsubsection[{description}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Samp::description}}} +\label{structSamp_d672d7d425e8180b93c7ca2229d1acd8} + + +application version + +Referenced by samp\_\-getMetadata(), samp\_\-hubOpen(), samp\_\-Metadata(), and samp\_\-printMetadata().\hypertarget{structSamp_62629ad2155a2a1a7676e32ef9fb9ffd}{ +\index{Samp@{Samp}!errortxt@{errortxt}} +\index{errortxt@{errortxt}!Samp@{Samp}} +\subsubsection[{errortxt}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf Samp::errortxt}}} +\label{structSamp_62629ad2155a2a1a7676e32ef9fb9ffd} + + +application description + +Referenced by samp\_\-call(), samp\_\-callAll(), samp\_\-callAndWait(), samp\_\-envGet(), samp\_\-getErr(), samp\_\-GetMetadata(), samp\_\-notifyAll(), samp\_\-paramGet(), and samp\_\-setErr().\hypertarget{structSamp_14f6ed59a947504d37bd8cdd1f2f8e8d}{ +\index{Samp@{Samp}!handlerMode@{handlerMode}} +\index{handlerMode@{handlerMode}!Samp@{Samp}} +\subsubsection[{handlerMode}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::handlerMode}}} +\label{structSamp_14f6ed59a947504d37bd8cdd1f2f8e8d} + + +(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().\hypertarget{structSamp_14811ec2253a6e2e75a8ec863c4150b0}{ +\index{Samp@{Samp}!hub@{hub}} +\index{hub@{hub}!Samp@{Samp}} +\subsubsection[{hub}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Hub} $\ast$ {\bf Samp::hub}}} +\label{structSamp_14811ec2253a6e2e75a8ec863c4150b0} + + +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().\hypertarget{structSamp_03918136809ece7e60de4e30c64b6224}{ +\index{Samp@{Samp}!hubHandle@{hubHandle}} +\index{hubHandle@{hubHandle}!Samp@{Samp}} +\subsubsection[{hubHandle}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t {\bf Samp::hubHandle}}} +\label{structSamp_03918136809ece7e60de4e30c64b6224} + + +\hyperlink{structHub}{Hub} connection + +Referenced by sampClose(), sampShutdown(), and sampStartup().\hypertarget{structSamp_723b2538cfd65122c49783b36a7d30b5}{ +\index{Samp@{Samp}!hubThreadID@{hubThreadID}} +\index{hubThreadID@{hubThreadID}!Samp@{Samp}} +\subsubsection[{hubThreadID}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::hubThreadID}}} +\label{structSamp_723b2538cfd65122c49783b36a7d30b5} + + +\hyperlink{structHub}{Hub} handle alias \hypertarget{structSamp_79f2ee1f48cb40edaf9b63ccdbb6942f}{ +\index{Samp@{Samp}!logfd@{logfd}} +\index{logfd@{logfd}!Samp@{Samp}} +\subsubsection[{logfd}]{\setlength{\rightskip}{0pt plus 5cm}FILE $\ast$ {\bf Samp::logfd}}} +\label{structSamp_79f2ee1f48cb40edaf9b63ccdbb6942f} + + +CBR / CBV for user handlers + +Referenced by sampLog().\hypertarget{structSamp_c8eee2b56f226f59d814fd1baa751b77}{ +\index{Samp@{Samp}!mapClients@{mapClients}} +\index{mapClients@{mapClients}!Samp@{Samp}} +\subsubsection[{mapClients}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::mapClients}}} +\label{structSamp_c8eee2b56f226f59d814fd1baa751b77} + + +is interface active + +Referenced by sampStartup().\hypertarget{structSamp_0884021074d1ed14342187005e0b78e7}{ +\index{Samp@{Samp}!meta@{meta}} +\index{meta@{meta}!Samp@{Samp}} +\subsubsection[{meta}]{\setlength{\rightskip}{0pt plus 5cm}{\bf appMD} {\bf Samp::meta}}} +\label{structSamp_0884021074d1ed14342187005e0b78e7} + + +last msh error string + +Referenced by samp\_\-getMetadata(), samp\_\-Metadata(), and samp\_\-printMetadata().\hypertarget{structSamp_30ca22535582e7bf6416627d1cd46525}{ +\index{Samp@{Samp}!msgMode@{msgMode}} +\index{msgMode@{msgMode}!Samp@{Samp}} +\subsubsection[{msgMode}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::msgMode}}} +\label{structSamp_30ca22535582e7bf6416627d1cd46525} + + +map other clients + +is interface active + +Referenced by samp\_\-sendMsg(), samp\_\-setASyncMode(), samp\_\-setCallMode(), samp\_\-setMsgMode(), samp\_\-setNotifyMode(), and samp\_\-setSyncMode().\hypertarget{structSamp_97ef8ad57159f4b6c4fcd93a12853b69}{ +\index{Samp@{Samp}!nclients@{nclients}} +\index{nclients@{nclients}!Samp@{Samp}} +\subsubsection[{nclients}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::nclients}}} +\label{structSamp_97ef8ad57159f4b6c4fcd93a12853b69} + + +samp clients + +Referenced by samp\_\-addClient(), samp\_\-app2id(), samp\_\-envGet(), samp\_\-id2app(), samp\_\-listClients(), samp\_\-mapClients(), samp\_\-paramGet(), samp\_\-removeClient(), samp\_\-sendMsg(), and sampStartup().\hypertarget{structSamp_36f4cfae3407b8961e57a77abca7d599}{ +\index{Samp@{Samp}!nsubs@{nsubs}} +\index{nsubs@{nsubs}!Samp@{Samp}} +\subsubsection[{nsubs}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::nsubs}}} +\label{structSamp_36f4cfae3407b8961e57a77abca7d599} + + +message subscriptions + +Referenced by samp\_\-getSampHandler(), samp\_\-getUserHandler(), samp\_\-hubDeclareSubscriptions(), samp\_\-setSampHandler(), samp\_\-setUserHandler(), samp\_\-Subscribe(), and samp\_\-Unsubscribe().\hypertarget{structSamp_8849cb13cbedae805b4e35327bc449e2}{ +\index{Samp@{Samp}!serverPort@{serverPort}} +\index{serverPort@{serverPort}!Samp@{Samp}} +\subsubsection[{serverPort}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::serverPort}}} +\label{structSamp_8849cb13cbedae805b4e35327bc449e2} + + +samp server threadId \hypertarget{structSamp_69b05b2fa1ab19729d81659ad64387a0}{ +\index{Samp@{Samp}!serverTid@{serverTid}} +\index{serverTid@{serverTid}!Samp@{Samp}} +\subsubsection[{serverTid}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::serverTid}}} +\label{structSamp_69b05b2fa1ab19729d81659ad64387a0} + + +number of samp clients \hypertarget{structSamp_e7db0cac0c4ad61c9ed7f3d344b623cf}{ +\index{Samp@{Samp}!svrThread@{svrThread}} +\index{svrThread@{svrThread}!Samp@{Samp}} +\subsubsection[{svrThread}]{\setlength{\rightskip}{0pt plus 5cm}pthread\_\-t {\bf Samp::svrThread}}} +\label{structSamp_e7db0cac0c4ad61c9ed7f3d344b623cf} + + +metadata + +Referenced by sampShutdown().\hypertarget{structSamp_25ddaf846639c7c67ea651a578b804ad}{ +\index{Samp@{Samp}!trace@{trace}} +\index{trace@{trace}!Samp@{Samp}} +\subsubsection[{trace}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::trace}}} +\label{structSamp_25ddaf846639c7c67ea651a578b804ad} + + +verbose flag + +debug flag + +Referenced by samp\_\-call(), samp\_\-callAll(), samp\_\-callAndWait(), samp\_\-notifyAll(), samp\_\-receiveCall(), samp\_\-receiveNotification(), samp\_\-receiveResponse(), sampStartup(), and sampTrace().\hypertarget{structSamp_981b01bd09deddb039db3567825bd653}{ +\index{Samp@{Samp}!verbose@{verbose}} +\index{verbose@{verbose}!Samp@{Samp}} +\subsubsection[{verbose}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf Samp::verbose}}} +\label{structSamp_981b01bd09deddb039db3567825bd653} + + +debug flag + +Referenced by sampClose(), sampDebug(), sampShutdown(), sampStartup(), and sampVerbose(). + +The documentation for this struct was generated from the following files:\begin{CompactItemize} +\item +\hyperlink{samp_8h}{samp.h}\item +\hyperlink{sampDecl_8h}{sampDecl.h}\end{CompactItemize} diff --git a/vendor/voclient/libsamp/doc/latex/structSubs.tex b/vendor/voclient/libsamp/doc/latex/structSubs.tex new file mode 100644 index 00000000..0484a0a4 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/structSubs.tex @@ -0,0 +1,48 @@ +\hypertarget{structSubs}{ +\section{Subs Struct Reference} +\label{structSubs}\index{Subs@{Subs}} +} +{\tt \#include $<$samp.h$>$} + +\subsection*{Data Fields} +\begin{CompactItemize} +\item +\hypertarget{structSubs_e34561f0e9c8805dcb19fe4f91ea3e3e}{ +char \textbf{mtype} \mbox{[}SZ\_\-LINE\mbox{]}} +\label{structSubs_e34561f0e9c8805dcb19fe4f91ea3e3e} + +\item +int($\ast$ \hyperlink{structSubs_14364d5a161adc47732c39b96e8156f0}{userFunc} )(void $\ast$p) +\item +int($\ast$ \hyperlink{structSubs_c4eca724f23609bb7ab9640c39c1001b}{sampFunc} )(char $\ast$sid, char $\ast$sender, char $\ast$msgid, \hyperlink{sampDecl_8h_39a90bc041db57e1a6ba736ba91eee30}{Map} map) +\end{CompactItemize} + + +\subsection{Detailed Description} +Message subscription. + +\subsection{Field Documentation} +\hypertarget{structSubs_c4eca724f23609bb7ab9640c39c1001b}{ +\index{Subs@{Subs}!sampFunc@{sampFunc}} +\index{sampFunc@{sampFunc}!Subs@{Subs}} +\subsubsection[{sampFunc}]{\setlength{\rightskip}{0pt plus 5cm}int($\ast$ {\bf Subs::sampFunc})(char $\ast$sid, char $\ast$sender, char $\ast$msgid, {\bf Map} map) (char $\ast$ {\em sid}, \/ char $\ast$ {\em sender}, \/ char $\ast$ {\em msgid}, \/ {\bf Map} {\em map})}} +\label{structSubs_c4eca724f23609bb7ab9640c39c1001b} + + +user handler function samp handler function + +Referenced by samp\_\-getSampHandler(), samp\_\-setSampHandler(), and samp\_\-Unsubscribe().\hypertarget{structSubs_14364d5a161adc47732c39b96e8156f0}{ +\index{Subs@{Subs}!userFunc@{userFunc}} +\index{userFunc@{userFunc}!Subs@{Subs}} +\subsubsection[{userFunc}]{\setlength{\rightskip}{0pt plus 5cm}int($\ast$ {\bf Subs::userFunc})(void $\ast$p) (void $\ast$ {\em p})}} +\label{structSubs_14364d5a161adc47732c39b96e8156f0} + + +mtype string + +Referenced by samp\_\-getUserHandler(), samp\_\-hubDeclareSubscriptions(), samp\_\-setUserHandler(), and samp\_\-Unsubscribe(). + +The documentation for this struct was generated from the following files:\begin{CompactItemize} +\item +\hyperlink{samp_8h}{samp.h}\item +\hyperlink{sampDecl_8h}{sampDecl.h}\end{CompactItemize} diff --git a/vendor/voclient/libsamp/doc/latex/structappMD.tex b/vendor/voclient/libsamp/doc/latex/structappMD.tex new file mode 100644 index 00000000..22486960 --- /dev/null +++ b/vendor/voclient/libsamp/doc/latex/structappMD.tex @@ -0,0 +1,103 @@ +\hypertarget{structappMD}{ +\section{appMD Struct Reference} +\label{structappMD}\index{appMD@{appMD}} +} +{\tt \#include $<$samp.h$>$} + +\subsection*{Data Fields} +\begin{CompactItemize} +\item +\hypertarget{structappMD_138f7e855439b5960fedf2bfb28f473e}{ +char \textbf{name} \mbox{[}SZ\_\-LINE\mbox{]}} +\label{structappMD_138f7e855439b5960fedf2bfb28f473e} + +\item +char \hyperlink{structappMD_fe527cb05f296f8e8b8144bf444beffd}{desc} \mbox{[}SZ\_\-DESC\mbox{]} +\item +char \hyperlink{structappMD_8ff19215559267a838fe300ca4f743a7}{iconURL} \mbox{[}SZ\_\-URL\mbox{]} +\item +char \hyperlink{structappMD_53945cba18e159fcdd4fb627b1d1d312}{docURL} \mbox{[}SZ\_\-URL\mbox{]} +\item +char $\ast$ \hyperlink{structappMD_652f4b568b3de167fa0886613c8c6656}{descHTML} +\item +int \hyperlink{structappMD_4b9f5ebb7d20beb53a7bfe192009e89a}{nkeys} +\item +char $\ast$ \hyperlink{structappMD_cf4d62dbfeb28cb8c503d6a4d1598a8d}{aKey} \mbox{[}MAX\_\-MDATTRS\mbox{]} +\item +char $\ast$ \hyperlink{structappMD_13ae9876a351aee3fe5b861733aff77a}{aVal} \mbox{[}MAX\_\-MDATTRS\mbox{]} +\end{CompactItemize} + + +\subsection{Detailed Description} +SAMP String datatype Application (and \hyperlink{structHub}{Hub}) metadata. + +Application (and \hyperlink{structHub}{Hub}) metadata. + +\subsection{Field Documentation} +\hypertarget{structappMD_cf4d62dbfeb28cb8c503d6a4d1598a8d}{ +\index{appMD@{appMD}!aKey@{aKey}} +\index{aKey@{aKey}!appMD@{appMD}} +\subsubsection[{aKey}]{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ {\bf appMD::aKey}}} +\label{structappMD_cf4d62dbfeb28cb8c503d6a4d1598a8d} + + +number of meta keys + +Referenced by samp\_\-getMetadata(), samp\_\-hubClose(), samp\_\-hubDeclareMetadata(), samp\_\-Metadata(), and samp\_\-printMetadata().\hypertarget{structappMD_13ae9876a351aee3fe5b861733aff77a}{ +\index{appMD@{appMD}!aVal@{aVal}} +\index{aVal@{aVal}!appMD@{appMD}} +\subsubsection[{aVal}]{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ {\bf appMD::aVal}}} +\label{structappMD_13ae9876a351aee3fe5b861733aff77a} + + +attr keyword + +Referenced by samp\_\-getMetadata(), samp\_\-hubClose(), samp\_\-hubDeclareMetadata(), samp\_\-Metadata(), and samp\_\-printMetadata().\hypertarget{structappMD_fe527cb05f296f8e8b8144bf444beffd}{ +\index{appMD@{appMD}!desc@{desc}} +\index{desc@{desc}!appMD@{appMD}} +\subsubsection[{desc}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf appMD::desc}}} +\label{structappMD_fe527cb05f296f8e8b8144bf444beffd} + + +name + +Referenced by samp\_\-hubOpen(), and samp\_\-Metadata().\hypertarget{structappMD_652f4b568b3de167fa0886613c8c6656}{ +\index{appMD@{appMD}!descHTML@{descHTML}} +\index{descHTML@{descHTML}!appMD@{appMD}} +\subsubsection[{descHTML}]{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ {\bf appMD::descHTML}}} +\label{structappMD_652f4b568b3de167fa0886613c8c6656} + + +documentation URL \hypertarget{structappMD_53945cba18e159fcdd4fb627b1d1d312}{ +\index{appMD@{appMD}!docURL@{docURL}} +\index{docURL@{docURL}!appMD@{appMD}} +\subsubsection[{docURL}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf appMD::docURL}}} +\label{structappMD_53945cba18e159fcdd4fb627b1d1d312} + + +icon URL + +Referenced by samp\_\-getMetadata(), samp\_\-hubDeclareMetadata(), samp\_\-Metadata(), and samp\_\-printMetadata().\hypertarget{structappMD_8ff19215559267a838fe300ca4f743a7}{ +\index{appMD@{appMD}!iconURL@{iconURL}} +\index{iconURL@{iconURL}!appMD@{appMD}} +\subsubsection[{iconURL}]{\setlength{\rightskip}{0pt plus 5cm}char {\bf appMD::iconURL}}} +\label{structappMD_8ff19215559267a838fe300ca4f743a7} + + +descriptive text + +Referenced by samp\_\-getMetadata(), samp\_\-hubDeclareMetadata(), samp\_\-Metadata(), and samp\_\-printMetadata().\hypertarget{structappMD_4b9f5ebb7d20beb53a7bfe192009e89a}{ +\index{appMD@{appMD}!nkeys@{nkeys}} +\index{nkeys@{nkeys}!appMD@{appMD}} +\subsubsection[{nkeys}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf appMD::nkeys}}} +\label{structappMD_4b9f5ebb7d20beb53a7bfe192009e89a} + + +descriptive text (HTML) + +Referenced by samp\_\-getMetadata(), samp\_\-hubClose(), samp\_\-hubDeclareMetadata(), samp\_\-Metadata(), and samp\_\-printMetadata(). + +The documentation for this struct was generated from the following files:\begin{CompactItemize} +\item +\hyperlink{samp_8h}{samp.h}\item +\hyperlink{sampDecl_8h}{sampDecl.h}\end{CompactItemize} diff --git a/vendor/voclient/libsamp/doc/mkdoc b/vendor/voclient/libsamp/doc/mkdoc new file mode 100755 index 00000000..906eeb6b --- /dev/null +++ b/vendor/voclient/libsamp/doc/mkdoc @@ -0,0 +1,10 @@ +#!/bin/csh -f + + +set m = "samp" + +foreach doc ( $m ) + groff -man -T ps ${doc}.man > ${doc}.ps + ps2pdf ${doc}.ps + man2html ${doc}.man > ${doc}.html +end diff --git a/vendor/voclient/libsamp/doc/samp.man b/vendor/voclient/libsamp/doc/samp.man new file mode 100644 index 00000000..8b8c141e --- /dev/null +++ b/vendor/voclient/libsamp/doc/samp.man @@ -0,0 +1,152 @@ +.\" @(#)samp.1 1.0 Oct-2011 MJF +.TH SAMP 1 "October 2011" "VOClient Project" +.SH NAME +samp \- commandline SAMP interface tool +.SH SYNOPSIS +\fBsamp\fP [\fI<flags>\fP] [ <\fIresource\fP> [[ <\fIobjname\fP> [ <\fIsr\fP> ]]] ] + +\fBvodata\fP [\fI<flags>\fP] [ <\fIresource\fP> [[ <\fIra\fP> <\fIdec\fP> [ <\fIsr\fP> ]]] ] + +\fBvodata\fP [\fI<flags>\fP] [ <\fIurl\fP> ] + +.SH OPTIONS +The \fIsamp\fP task accepts the following options: +.TP 8 +.B \-h +Print a help summary to the terminal and exit. +.TP 8 +.B \-d +Debug output. +.TP 8 +.B \-v +Verbose output. + +.TP 0 +The following flags control the major behavior of the task: +of output to present. +.TP 8 +.B \-m +Handle multiple messages. If not set, the task will exit after receipt +of the first message. +.TP 8 +.B \-s \fI<sender>\fR +Handle messages only from the specified \fI<sender>\fR application. The +application name may optionally be the public ID of the application. + +.TP 8 +.B \-t \fI<to>\fR +Send the message to the specified application. If not set, a message is +broadcast to all clients subscribed to that particular message. +.TP 8 +.B \-p \fI<pattern>\fR +Send the message using the specified messaging pattern. Allowed values +are '\fIsynch\dR', '\fIasynch\fR', or '\fInotify\fR'. Asynchronous messages +will ignore the reponse message. + +.TP 8 +.B \-i +Process in interactive mode. The application will register with the +Hub once and then process commands typed in at the "samp>" prompt. +.TP 8 +.B \-f \fI<file>\fR +Process all commands in the named \fI<file\f>. + + + +.SH DESCRIPTION +The \fIsamp\fR application ..... + + + +.SH COMMAND SUMMARY +.nf + Commands: + + snoop print all received messages + send <mtype> [<args> ...] generalized <mtype> message send + + status print Hub availability + list list all registered clients + access <appName> print <appName> availability + handle <mtype> wait for <mtype> message + + exec <cmd> execute a client command + setenv <name> <value> set an environment value + getenv <name> get an environment value + setparam <name> <value> set a parameter value + getparam <name> get a parameter value + + loadImage <url> load the named image + loadVOTable <url> load the named VOTable + loadFITS <url> load the named FITS bintable + loadSpec <url> load the named spectrum + loadResource <ivorn> load the named VO Resource + + pointAt <ra> <dec> point at given coords + showRow [<tblId>] [<url>] <row> highlight specified row + selectRows [<tblId>] [<url>] <rows> select specified rows + bibcode <bibcode> load the bibcode +.fi + + +.SH EXAMPLES + +.TP 4 +1) Print SAMP application status information: +.nf + + % samp status is Hub available? + % samp access topcat is 'topcat' connected? + % samp list list all available applications +.fi + +.TP 4 +2) Send a message containing the mtype \fIfoo.bar\fR and the +parameter \fIfoo\fR with a value of \fItrue\fR to all applications +subscribed to this mtype. +.nf + + % samp send foo.bar foo=true + % samp -t topcat send foo.bar foo=true +.fi +The second example sends the message specifically to 'topcat'. + +.TP 4 +3) Start the application an wait for a 'foo.bar' message to arrive. In +the second example, we'll continue running to receive multiple messages. +In the third example, wait for a message only from another 'samp' +application. +.nf + + % samp handle foo.bar (1) + % samp -m handle foo.bar (2) + % samp -s samp handle foo.bar (3) +.fi + +.TP 4 +4) Process multiple commands from a file: +.nf + % type cmds + loadImage http://foo.bar/sif.fits + loadVOTable http://foo.bar/sif.fits + % samp -f cmds + or + % cat cmds | samp -f - +.fi + + +.SH BUGS +.PP + + +.SH TODO +.PP + + +.SH Revision History +October 2011 - This task is new. +.SH Author +Michael Fitzpatrick (fitz@noao.edu), October 2011 +.SH "SEE ALSO" + + |
