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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BrlAPI: Connecting to BrlAPI</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">BrlAPI<span id="projectnumber"> 0.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search',false);
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="doc-content">
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Connecting to BrlAPI</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__connectionSettings__t.html">brlapi_connectionSettings_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Settings structure for <em>BrlAPI</em> connection. <a href="structbrlapi__connectionSettings__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gabf6a76636febaac1c0251abb12d0935c" id="r_gabf6a76636febaac1c0251abb12d0935c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabf6a76636febaac1c0251abb12d0935c">BRLAPI_SOCKETPORTNUM</a>   4101</td></tr>
<tr class="separator:gabf6a76636febaac1c0251abb12d0935c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4f5503ad782017b1e0b323b3ec8a331a" id="r_ga4f5503ad782017b1e0b323b3ec8a331a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4f5503ad782017b1e0b323b3ec8a331a">BRLAPI_SOCKETPORT</a>   "4101"</td></tr>
<tr class="separator:ga4f5503ad782017b1e0b323b3ec8a331a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga056c43c3de93b35970abf896e99a9893" id="r_ga056c43c3de93b35970abf896e99a9893"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga056c43c3de93b35970abf896e99a9893">BRLAPI_SOCKETPATH</a>   "/var/lib/BrlAPI"</td></tr>
<tr class="separator:ga056c43c3de93b35970abf896e99a9893"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0439f024cb826c67dbe16f7c66fa5a38" id="r_ga0439f024cb826c67dbe16f7c66fa5a38"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0439f024cb826c67dbe16f7c66fa5a38">BRLAPI_ETCDIR</a>   "/etc"</td></tr>
<tr class="separator:ga0439f024cb826c67dbe16f7c66fa5a38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6f87d526cda948b27ca7f503b97561ec" id="r_ga6f87d526cda948b27ca7f503b97561ec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6f87d526cda948b27ca7f503b97561ec">BRLAPI_AUTHKEYFILE</a>   "brlapi.key"</td></tr>
<tr class="separator:ga6f87d526cda948b27ca7f503b97561ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabf9e3103b9d24698e93266d016db3f3a" id="r_gabf9e3103b9d24698e93266d016db3f3a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabf9e3103b9d24698e93266d016db3f3a">BRLAPI_DEFAUTH_KEYFILE</a>   "keyfile:" <a class="el" href="#ga0439f024cb826c67dbe16f7c66fa5a38">BRLAPI_ETCDIR</a> "/" <a class="el" href="#ga6f87d526cda948b27ca7f503b97561ec">BRLAPI_AUTHKEYFILE</a></td></tr>
<tr class="separator:gabf9e3103b9d24698e93266d016db3f3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a5181cb2bbfd6181ab8c932e10c0df4" id="r_ga5a5181cb2bbfd6181ab8c932e10c0df4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5a5181cb2bbfd6181ab8c932e10c0df4">BRLAPI_DEFAUTH_POLKIT</a>   ""</td></tr>
<tr class="separator:ga5a5181cb2bbfd6181ab8c932e10c0df4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1b86dad4b4a50dc0875ab4c037812d5c" id="r_ga1b86dad4b4a50dc0875ab4c037812d5c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1b86dad4b4a50dc0875ab4c037812d5c">BRLAPI_DEFAUTH</a>   <a class="el" href="#gabf9e3103b9d24698e93266d016db3f3a">BRLAPI_DEFAUTH_KEYFILE</a> <a class="el" href="#ga5a5181cb2bbfd6181ab8c932e10c0df4">BRLAPI_DEFAUTH_POLKIT</a></td></tr>
<tr class="separator:ga1b86dad4b4a50dc0875ab4c037812d5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac6fdbd933cf7a92c81ce2d323a122a7b" id="r_gac6fdbd933cf7a92c81ce2d323a122a7b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac6fdbd933cf7a92c81ce2d323a122a7b">BRLAPI_INVALID_FILE_DESCRIPTOR</a>   -1</td></tr>
<tr class="separator:gac6fdbd933cf7a92c81ce2d323a122a7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga45d2990108338f4764c4cabde1c3e759" id="r_ga45d2990108338f4764c4cabde1c3e759"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga45d2990108338f4764c4cabde1c3e759">BRLAPI_SETTINGS_INITIALIZER</a>   { NULL, NULL }</td></tr>
<tr class="separator:ga45d2990108338f4764c4cabde1c3e759"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga1273c1f34be592e19c9319e64becd1c0" id="r_ga1273c1f34be592e19c9319e64becd1c0"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a></td></tr>
<tr class="separator:ga1273c1f34be592e19c9319e64becd1c0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacd26dc42640bdad09a389be10b9e3618" id="r_gacd26dc42640bdad09a389be10b9e3618"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacd26dc42640bdad09a389be10b9e3618">brlapi_openConnection</a> (const <a class="el" href="structbrlapi__connectionSettings__t.html">brlapi_connectionSettings_t</a> *desiredSettings, <a class="el" href="structbrlapi__connectionSettings__t.html">brlapi_connectionSettings_t</a> *actualSettings)</td></tr>
<tr class="separator:gacd26dc42640bdad09a389be10b9e3618"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab72663955b05e29196285f945f55aa87" id="r_gab72663955b05e29196285f945f55aa87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab72663955b05e29196285f945f55aa87">brlapi__openConnection</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle, const <a class="el" href="structbrlapi__connectionSettings__t.html">brlapi_connectionSettings_t</a> *desiredSettings, <a class="el" href="structbrlapi__connectionSettings__t.html">brlapi_connectionSettings_t</a> *actualSettings)</td></tr>
<tr class="separator:gab72663955b05e29196285f945f55aa87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad1ae91118d131102b4de6dd31364940e" id="r_gad1ae91118d131102b4de6dd31364940e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad1ae91118d131102b4de6dd31364940e">brlapi_getFileDescriptor</a> (void)</td></tr>
<tr class="separator:gad1ae91118d131102b4de6dd31364940e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2270ac9b512d819bd1a4c0a1488757e1" id="r_ga2270ac9b512d819bd1a4c0a1488757e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2270ac9b512d819bd1a4c0a1488757e1">brlapi__getFileDescriptor</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle)</td></tr>
<tr class="separator:ga2270ac9b512d819bd1a4c0a1488757e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b2e32ae6b9dddaeea8f2365e37494cb" id="r_ga7b2e32ae6b9dddaeea8f2365e37494cb"><td class="memItemLeft" align="right" valign="top">void <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7b2e32ae6b9dddaeea8f2365e37494cb">brlapi_closeConnection</a> (void)</td></tr>
<tr class="separator:ga7b2e32ae6b9dddaeea8f2365e37494cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8fb742c787203548522fc4d0f1edd041" id="r_ga8fb742c787203548522fc4d0f1edd041"><td class="memItemLeft" align="right" valign="top">void <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8fb742c787203548522fc4d0f1edd041">brlapi__closeConnection</a> (<a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *handle)</td></tr>
<tr class="separator:ga8fb742c787203548522fc4d0f1edd041"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Before calling any other function of the library, calling <a class="el" href="#gacd26dc42640bdad09a389be10b9e3618">brlapi_openConnection()</a> is needed to establish a connection to <em>BrlAPI</em> 's server. When the connection is not needed any more, <a class="el" href="#ga7b2e32ae6b9dddaeea8f2365e37494cb">brlapi_closeConnection()</a> must be called to close the connection. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga6f87d526cda948b27ca7f503b97561ec" name="ga6f87d526cda948b27ca7f503b97561ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6f87d526cda948b27ca7f503b97561ec">◆ </a></span>BRLAPI_AUTHKEYFILE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_AUTHKEYFILE   "brlapi.key"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default name of the file containing <em>BrlAPI</em> 's authorization key</p>
<p>This name is relative to BRLAPI_ETCDIR </p>
</div>
</div>
<a id="ga1b86dad4b4a50dc0875ab4c037812d5c" name="ga1b86dad4b4a50dc0875ab4c037812d5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b86dad4b4a50dc0875ab4c037812d5c">◆ </a></span>BRLAPI_DEFAUTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_DEFAUTH   <a class="el" href="#gabf9e3103b9d24698e93266d016db3f3a">BRLAPI_DEFAUTH_KEYFILE</a> <a class="el" href="#ga5a5181cb2bbfd6181ab8c932e10c0df4">BRLAPI_DEFAUTH_POLKIT</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gabf9e3103b9d24698e93266d016db3f3a" name="gabf9e3103b9d24698e93266d016db3f3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabf9e3103b9d24698e93266d016db3f3a">◆ </a></span>BRLAPI_DEFAUTH_KEYFILE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_DEFAUTH_KEYFILE   "keyfile:" <a class="el" href="#ga0439f024cb826c67dbe16f7c66fa5a38">BRLAPI_ETCDIR</a> "/" <a class="el" href="#ga6f87d526cda948b27ca7f503b97561ec">BRLAPI_AUTHKEYFILE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default authorization setting </p>
</div>
</div>
<a id="ga5a5181cb2bbfd6181ab8c932e10c0df4" name="ga5a5181cb2bbfd6181ab8c932e10c0df4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5a5181cb2bbfd6181ab8c932e10c0df4">◆ </a></span>BRLAPI_DEFAUTH_POLKIT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_DEFAUTH_POLKIT   ""</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga0439f024cb826c67dbe16f7c66fa5a38" name="ga0439f024cb826c67dbe16f7c66fa5a38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0439f024cb826c67dbe16f7c66fa5a38">◆ </a></span>BRLAPI_ETCDIR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_ETCDIR   "/etc"</td>
</tr>
</table>
</div><div class="memdoc">
<p><em>brltty</em> 's settings directory</p>
<p>This is where authorization key and driver-dependent key names are found for instance. </p>
</div>
</div>
<a id="gac6fdbd933cf7a92c81ce2d323a122a7b" name="gac6fdbd933cf7a92c81ce2d323a122a7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac6fdbd933cf7a92c81ce2d323a122a7b">◆ </a></span>BRLAPI_INVALID_FILE_DESCRIPTOR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_INVALID_FILE_DESCRIPTOR   -1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Invalid value for brlapi_fileDescriptor</p>
<p>This is returned by <a class="el" href="#gad1ae91118d131102b4de6dd31364940e">brlapi_getFileDescriptor()</a> when the connection is closed. </p>
</div>
</div>
<a id="ga45d2990108338f4764c4cabde1c3e759" name="ga45d2990108338f4764c4cabde1c3e759"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga45d2990108338f4764c4cabde1c3e759">◆ </a></span>BRLAPI_SETTINGS_INITIALIZER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_SETTINGS_INITIALIZER   { NULL, NULL }</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allows to initialize a structure of type <em><a class="el" href="structbrlapi__connectionSettings__t.html" title="Settings structure for BrlAPI connection.">brlapi_connectionSettings_t</a></em> * with default values. </p>
</div>
</div>
<a id="ga056c43c3de93b35970abf896e99a9893" name="ga056c43c3de93b35970abf896e99a9893"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga056c43c3de93b35970abf896e99a9893">◆ </a></span>BRLAPI_SOCKETPATH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_SOCKETPATH   "/var/lib/BrlAPI"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default unix path on which connections to <em>BrlAPI</em> can be established </p>
</div>
</div>
<a id="ga4f5503ad782017b1e0b323b3ec8a331a" name="ga4f5503ad782017b1e0b323b3ec8a331a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f5503ad782017b1e0b323b3ec8a331a">◆ </a></span>BRLAPI_SOCKETPORT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_SOCKETPORT   "4101"</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gabf6a76636febaac1c0251abb12d0935c" name="gabf6a76636febaac1c0251abb12d0935c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabf6a76636febaac1c0251abb12d0935c">◆ </a></span>BRLAPI_SOCKETPORTNUM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BRLAPI_SOCKETPORTNUM   4101</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default port number on which connections to <em>BrlAPI</em> can be established </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga1273c1f34be592e19c9319e64becd1c0" name="ga1273c1f34be592e19c9319e64becd1c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1273c1f34be592e19c9319e64becd1c0">◆ </a></span>brlapi_fileDescriptor</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>OS-dependent file descriptor type</p>
<p>This is the type for file descriptors returned by <a class="el" href="#gacd26dc42640bdad09a389be10b9e3618">brlapi_openConnection()</a> and <a class="el" href="#gad1ae91118d131102b4de6dd31364940e">brlapi_getFileDescriptor()</a>. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8fb742c787203548522fc4d0f1edd041" name="ga8fb742c787203548522fc4d0f1edd041"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8fb742c787203548522fc4d0f1edd041">◆ </a></span>brlapi__closeConnection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi__closeConnection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>handle</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga2270ac9b512d819bd1a4c0a1488757e1" name="ga2270ac9b512d819bd1a4c0a1488757e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2270ac9b512d819bd1a4c0a1488757e1">◆ </a></span>brlapi__getFileDescriptor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi__getFileDescriptor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>handle</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gab72663955b05e29196285f945f55aa87" name="gab72663955b05e29196285f945f55aa87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab72663955b05e29196285f945f55aa87">◆ </a></span>brlapi__openConnection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi__openConnection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__brlapi__handles.html#ga57f2aec62b18f8aefea2ab550744b0c1">brlapi_handle_t</a> *</td> <td class="paramname"><span class="paramname"><em>handle</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structbrlapi__connectionSettings__t.html">brlapi_connectionSettings_t</a> *</td> <td class="paramname"><span class="paramname"><em>desiredSettings</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbrlapi__connectionSettings__t.html">brlapi_connectionSettings_t</a> *</td> <td class="paramname"><span class="paramname"><em>actualSettings</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga7b2e32ae6b9dddaeea8f2365e37494cb" name="ga7b2e32ae6b9dddaeea8f2365e37494cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7b2e32ae6b9dddaeea8f2365e37494cb">◆ </a></span>brlapi_closeConnection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi_closeConnection </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cleanly close the socket</p>
<p>This function locks until a closing acknowledgement is received from the server. The socket is then freed, so the file descriptor <a class="el" href="#gacd26dc42640bdad09a389be10b9e3618">brlapi_openConnection()</a> gave has no meaning any more </p>
</div>
</div>
<a id="gad1ae91118d131102b4de6dd31364940e" name="gad1ae91118d131102b4de6dd31364940e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad1ae91118d131102b4de6dd31364940e">◆ </a></span>brlapi_getFileDescriptor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi_getFileDescriptor </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the file descriptor used by the BrlAPI connection</p>
<p>This allows to use it with <code>select()</code>, <code>g_io_add_watch()</code>, <code>XtAppAddInput()</code>, etc.</p>
<p>BRLAPI_INVALID_FILE_DESCRIPTOR is returned when the connection was closed. </p>
</div>
</div>
<a id="gacd26dc42640bdad09a389be10b9e3618" name="gacd26dc42640bdad09a389be10b9e3618"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd26dc42640bdad09a389be10b9e3618">◆ </a></span>brlapi_openConnection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> <a class="el" href="brlapi_8h.html#aaf61afab5ea0f7574217a09dba040428">BRLAPI_STDCALL</a> brlapi_openConnection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbrlapi__connectionSettings__t.html">brlapi_connectionSettings_t</a> *</td> <td class="paramname"><span class="paramname"><em>desiredSettings</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structbrlapi__connectionSettings__t.html">brlapi_connectionSettings_t</a> *</td> <td class="paramname"><span class="paramname"><em>actualSettings</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a socket and connect it to <em>BrlAPI</em> 's server</p>
<p>This function first loads an authorization key as specified in settings. It then creates a TCP socket and connects it to the specified machine, on the specified port. It writes the authorization key on the socket and waits for acknowledgement.</p>
<dl class="section return"><dt>Returns</dt><dd>the file descriptor, or BRLAPI_INVALID_FILE_DESCRIPTOR on error</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The file descriptor is returned in case the client wants to communicate with the server without using <em>libbrlapi</em> functions. If it uses them however, it won't have to pass the file descriptor later, since the library keeps a copy of it. But that also means that <a class="el" href="#gacd26dc42640bdad09a389be10b9e3618">brlapi_openConnection()</a> may be called several times, but <em>libbrlapi</em> functions will always work with the last call's descriptor</dd></dl>
<dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="keywordflow">if</span> (<a class="code hl_function" href="#gacd26dc42640bdad09a389be10b9e3618">brlapi_openConnection</a>(&settings,&settings)<0) {</div>
<div class="line"> fprintf(stderr,<span class="stringliteral">"couldn't connect to BrlAPI at %s: %s\n"</span>,</div>
<div class="line"> settings.host, <a class="code hl_function" href="group__brlapi__error.html#gadbb2373f03c1c195c84656137e358c9c">brlapi_strerror</a>(&<a class="code hl_enumeration" href="group__brlapi__error.html#ga58c44380d52b1dc94a05a98edb2f0fe3">brlapi_error</a>));</div>
<div class="line"> exit(1);</div>
<div class="line">}</div>
<div class="ttc" id="agroup__brlapi__connection_html_gacd26dc42640bdad09a389be10b9e3618"><div class="ttname"><a href="#gacd26dc42640bdad09a389be10b9e3618">brlapi_openConnection</a></div><div class="ttdeci">brlapi_fileDescriptor BRLAPI_STDCALL brlapi_openConnection(const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings)</div></div>
<div class="ttc" id="agroup__brlapi__error_html_ga58c44380d52b1dc94a05a98edb2f0fe3"><div class="ttname"><a href="group__brlapi__error.html#ga58c44380d52b1dc94a05a98edb2f0fe3">brlapi_error</a></div><div class="ttdeci">brlapi_error</div><div class="ttdef"><b>Definition</b> brlapi.h:1284</div></div>
<div class="ttc" id="agroup__brlapi__error_html_gadbb2373f03c1c195c84656137e358c9c"><div class="ttname"><a href="group__brlapi__error.html#gadbb2373f03c1c195c84656137e358c9c">brlapi_strerror</a></div><div class="ttdeci">const char *BRLAPI_STDCALL brlapi_strerror(const brlapi_error_t *error)</div></div>
</div><!-- fragment --></dd></dl>
<dl class="section user"><dt>Errors:</dt><dd><em>BrlAPI</em> might not be on this TCP port, the host name might not be resolvable, the authorization may fail,...</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">desiredSettings</td><td>this gives the desired connection parameters, as described in <a class="el" href="structbrlapi__connectionSettings__t.html" title="Settings structure for BrlAPI connection.">brlapi_connectionSettings_t</a>. If <code>NULL</code>, defaults values are used, so that it is generally a good idea to give <code>NULL</code> as default, and only fill a <a class="el" href="structbrlapi__connectionSettings__t.html" title="Settings structure for BrlAPI connection.">brlapi_connectionSettings_t</a> structure when the user gave parameters to the program for instance; </td></tr>
<tr><td class="paramname">actualSettings</td><td>if not <code>NULL</code>, parameters which were actually used are stored here, if the application ever needs them. Since they are constant strings, or come from a getenv call, these must not be freed by the application.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structbrlapi__connectionSettings__t.html" title="Settings structure for BrlAPI connection.">brlapi_connectionSettings_t</a> <a class="el" href="group__brlapi__protocol.html#gabc8a0c3fe653b8d44059aee810c5b35a">brlapi_writePacket()</a> <a class="el" href="group__brlapi__protocol.html#ga3fa149ae4b0f1adcf8f514ebc9a1f45f">brlapi_readPacketHeader()</a> <a class="el" href="group__brlapi__protocol.html#ga6a963be14210e5706f16b57a2f388e6e">brlapi_readPacketContent()</a> <a class="el" href="group__brlapi__protocol.html#ga593411f2c9306ff774eb854f78eaa18b">brlapi_readPacket()</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
|
