<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>BrlAPI: brlapi_connectionSettings_t Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
<li><a href="dirs.html"><span>Directories</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>brlapi_connectionSettings_t Struct Reference<br>
<small>
[<a class="el" href="group__brlapi__connection.html">Connecting to BrlAPI</a>]</small>
</h1><!-- doxytag: class="brlapi_connectionSettings_t" -->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 class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__connectionSettings__t.html#8dbec98b6b7bb5ff0de80490f6a8a9cd">auth</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__connectionSettings__t.html#1d9d3a3849ef30c8e52f339042d24b2c">host</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> which file the authorization key can be found in and which computer to connect to.<p>
<dl class="user" compact><dt><b>Examples:</b></dt><dd><div class="fragment"><pre class="fragment"> <a class="code" href="structbrlapi__connectionSettings__t.html" title="Settings structure for BrlAPI connection.">brlapi_connectionSettings_t</a> settings;
settings.<a class="code" href="structbrlapi__connectionSettings__t.html#8dbec98b6b7bb5ff0de80490f6a8a9cd">auth</a>=<span class="stringliteral">"/etc/brlapi.key"</span>;
settings.<a class="code" href="structbrlapi__connectionSettings__t.html#1d9d3a3849ef30c8e52f339042d24b2c">host</a>=<span class="stringliteral">"foo"</span>;
</pre></div></dd></dl>
<em>libbrlapi</em> will read authorization key from file <code>/etc/brlapi</code>.key and connect to the machine called "foo", on the default TCP port.<p>
<div class="fragment"><pre class="fragment"> settings.<a class="code" href="structbrlapi__connectionSettings__t.html#1d9d3a3849ef30c8e52f339042d24b2c">host</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 class="fragment"> settings.<a class="code" href="structbrlapi__connectionSettings__t.html#1d9d3a3849ef30c8e52f339042d24b2c">host</a>=<span class="stringliteral">":1"</span>;
</pre></div><p>
lets <em>libbrlapi</em> connect to the local computer, on port BRLAPI_SOCKETPORTNUM+1<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__brlapi__connection.html#gcd26dc42640bdad09a389be10b9e3618">brlapi_openConnection()</a> </dd></dl>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="8dbec98b6b7bb5ff0de80490f6a8a9cd"></a><!-- doxytag: member="brlapi_connectionSettings_t::auth" ref="8dbec98b6b7bb5ff0de80490f6a8a9cd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structbrlapi__connectionSettings__t.html#8dbec98b6b7bb5ff0de80490f6a8a9cd">brlapi_connectionSettings_t::auth</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For security reasons, <em>libbrlapi</em> has to get authorized to connect to the <em>BrlAPI</em> server. This can be done via a secret key, for instance. 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_AUTH environment variable, if it exists.
</div>
</div><p>
<a class="anchor" name="1d9d3a3849ef30c8e52f339042d24b2c"></a><!-- doxytag: member="brlapi_connectionSettings_t::host" ref="1d9d3a3849ef30c8e52f339042d24b2c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structbrlapi__connectionSettings__t.html#1d9d3a3849ef30c8e52f339042d24b2c">brlapi_connectionSettings_t::host</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<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:1", which means TCP port number BRLAPI_SOCKETPORTNUM+1 on computer called "foo". <dl class="note" compact><dt><b>Note:</b></dt><dd>Please check that resolving this name works before complaining</dd></dl>
Settings <code>NULL</code> defaults it to localhost, using the local installation's default TCP port, or to the content of the BRLAPI_HOST environment variable, if it exists.
</div>
</div><p>
<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>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 22:37:56 2009 for BrlAPI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
