1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>brlapi_settings_t struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center>
<hr><h1>brlapi_settings_t Struct Reference<br>
<small>
[<a class="el" href="group__brlapi__connection.html">Connecting to BrlAPI</a>]</small>
</h1>Settings structure for <em>BrlAPI</em> connection.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="brlapi_8h-source.html">brlapi.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 nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="structbrlapi__settings__t.html#m0">authKey</a></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="structbrlapi__settings__t.html#m1">hostName</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This structure holds every parameter needed to connect to <em>BrlAPI</em>: in which file the authentication key can be found and to which computer to connect.<dl compact><dt><b>Examples:</b></dt><dd>
<div class="fragment"><pre> <a class="code" href="structbrlapi__settings__t.html">brlapi_settings_t</a> settings;
settings.<a class="code" href="structbrlapi__settings__t.html#m0">authKey</a>=<span class="stringliteral">"/etc/brlapi.key"</span>;
settings.<a class="code" href="structbrlapi__settings__t.html#m1">hostName</a>=<span class="stringliteral">"foo"</span>;
</pre></div></dl><em>libbrlapi</em> will read authentication key from file <code>/etc/brlapi.key</code> and connect to the machine called "foo", on the default TCP port.
<p>
<div class="fragment"><pre> settings.<a class="code" href="structbrlapi__settings__t.html#m1">hostName</a>=<span class="stringliteral">"10.1.0.2"</span>;
</pre></div>
<p>
lets directly enter an IP address instead of a machine name.
<p>
<div class="fragment"><pre> settings.<a class="code" href="structbrlapi__settings__t.html#m1">hostName</a>=<span class="stringliteral">":4321"</span>;
</pre></div>
<p>
lets <em>libbrlapi</em> connect to the local computer, on TCP port 4321
<p>
<dl compact><dt><b>See also: </b></dt><dd>
<a class="el" href="group__brlapi__connection.html#a0">brlapi_initializeConnection()</a> <a class="el" href="group__brlapi__connection.html#a2">brlapi_loadAuthKey()</a> </dl>
<p>
<hr><h2>Field Documentation</h2>
<a name="m0" doxytag="brlapi_settings_t::authKey"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* brlapi_settings_t::authKey
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
To get authenticated, <em>libbrlapi</em> has to tell the <em>BrlAPI</em> server a secret key, for security reasons. This is the path to the file which holds it; it will hence have to be readable by the application.
<p>
Setting <code>NULL</code> defaults it to local installation setup or to the content of the BRLAPI_AUTHNAME environment variable, if it exists. </td>
</tr>
</table>
<a name="m1" doxytag="brlapi_settings_t::hostName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* brlapi_settings_t::hostName
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
this tells where the <em>BrlAPI</em> server resides: it might be listening on another computer, on any TCP port. It should look like "foo:1234", which means TCP port number 1234 on computer called "foo". <dl compact><dt><b>Note: </b></dt><dd>
Please check that resolving this name works before complaining</dl>Settings <code>NULL</code> defaults it to localhost, using the local installation's default TCP port, or to the content of the BRLAPI_HOSTNAME environment variable, if it exists. </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="brlapi_8h-source.html">brlapi.h</a></ul>
<hr><address style="align: right;"><small>Generated on Thu Jan 15 13:21:27 2004 for BrlAPI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>
|
