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
|
<!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.h File 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.h File Reference</h1>types, defines and functions prototypes for <em>BrlAPI</em>
<a href="#_details">More...</a>
<p>
<code>#include <inttypes.h></code><br>
<code>#include <unistd.h></code><br>
<code>#include <pthread.h></code><br>
<p>
<a href="brlapi_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 nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structbrlapi__keybinding__t.html">brlapi_keybinding_t</a></td></tr>
<tr><td> </td><td><font size=-1><em>Key binding structure.</em> <a href="structbrlapi__keybinding__t.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structbrlapi__settings__t.html">brlapi_settings_t</a></td></tr>
<tr><td> </td><td><font size=-1><em>Settings structure for <em>BrlAPI</em> connection.</em> <a href="structbrlapi__settings__t.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__connection.html#a4">BRLAPI_SOCKETPORT</a> "35751"</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__connection.html#a5">BRLAPI_ETCDIR</a> "/etc"</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__connection.html#a6">BRLAPI_AUTHFILE</a> "brlapi.key"</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__connection.html#a7">BRLAPI_AUTHNAME</a> BRLAPI_ETCDIR "/" BRLAPI_AUTHFILE</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__tty.html#a2">BRLKEYCODES</a> ((uint32_t) 1)</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__tty.html#a3">BRLCOMMANDS</a> ((uint32_t) 2)</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a6">BRL_KEYBUF_SIZE</a> 256</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a7">BRL_KEYCODE_MAX</a> ((<a class="el" href="group__brlapi__keys.html#a0">brl_keycode_t</a>) (UINT32_MAX))</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a8">BRLAPI_HOMEKEYDIR</a> ".brlkeys"</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a9">BRLAPI_HOMEKEYEXT</a> ".kbd"</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a10">BRLAPI_ETCKEYFILE</a> "brlkeys"</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a5">BRLERR_SUCCESS</a> 0</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a6">BRLERR_NOMEM</a> 1</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a7">BRLERR_TTYBUSY</a> 2</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a8">BRLERR_UNKNOWN_INSTRUCTION</a> 3</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a9">BRLERR_ILLEGAL_INSTRUCTION</a> 4</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a10">BRLERR_INVALID_PARAMETER</a> 5</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a11">BRLERR_INVALID_PACKET</a> 6</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a12">BRLERR_RAWNOTSUPP</a> 7</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a13">BRLERR_KEYSNOTSUPP</a> 8</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a14">BRLERR_CONNREFUSED</a> 9</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a15">BRLERR_OPNOTSUPP</a> 10</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a16">BRLERR_GAIERR</a> 11</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a17">BRLERR_LIBCERR</a> 12</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a18">BRLERR_UNKNOWNTTY</a> 13</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a27">brlapi_errno</a> (*brlapi_errno_location ())</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a4">BRLAPI_MAXPACKETSIZE</a> 512</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a5">BRLPACKET_AUTHKEY</a> 'K'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a6">BRLPACKET_BYE</a> 'B'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a7">BRLPACKET_GETDRIVERID</a> 'd'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a8">BRLPACKET_GETDRIVERNAME</a> 'n'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a9">BRLPACKET_GETDISPLAYSIZE</a> 's'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a10">BRLPACKET_GETTTY</a> 't'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a11">BRLPACKET_LEAVETTY</a> 'L'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a12">BRLPACKET_KEY</a> 'k'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a13">BRLPACKET_COMMAND</a> 'c'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a14">BRLPACKET_MASKKEYS</a> 'm'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a15">BRLPACKET_UNMASKKEYS</a> 'u'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a16">BRLPACKET_WRITE</a> 'W'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a17">BRLPACKET_WRITEDOTS</a> 'D'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a18">BRLPACKET_STATWRITE</a> 'S'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a19">BRLPACKET_GETRAW</a> '*'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a20">BRLPACKET_LEAVERAW</a> '#'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a21">BRLPACKET_PACKET</a> 'p'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a22">BRLPACKET_ACK</a> 'A'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a23">BRLPACKET_ERROR</a> 'E'</td></tr>
<tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a24">BRLRAW_MAGIC</a> (0xdeadbeefL)</td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef uint32_t </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a0">brl_keycode_t</a></td></tr>
<tr><td nowrap align=right valign=top>typedef uint32_t </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a0">brl_type_t</a></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__connection.html#a0">brlapi_initializeConnection</a> (const <a class="el" href="structbrlapi__settings__t.html">brlapi_settings_t</a> *clientSettings, <a class="el" href="structbrlapi__settings__t.html">brlapi_settings_t</a> *usedSettings)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__brlapi__connection.html#a1">brlapi_closeConnection</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__connection.html#a2">brlapi_loadAuthKey</a> (const char *filename, int *authlength, void *auth)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__connection.html#a3">brlapi_getControllingTty</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="group__brlapi__info.html#a0">brlapi_getDriverId</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="group__brlapi__info.html#a1">brlapi_getDriverName</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__info.html#a2">brlapi_getDisplaySize</a> (unsigned int *x, unsigned int *y)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__tty.html#a0">brlapi_getTty</a> (uint32_t tty, uint32_t how, <a class="el" href="structbrlapi__keybinding__t.html">brlapi_keybinding_t</a> *keybinding)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__tty.html#a1">brlapi_leaveTty</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__write.html#a0">brlapi_writeBrl</a> (uint32_t cursor, const char *str)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__write.html#a1">brlapi_writeBrlDots</a> (const char *dots)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a1">brlapi_readKey</a> (int block, <a class="el" href="group__brlapi__keys.html#a0">brl_keycode_t</a> *code)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a2">brlapi_readCommand</a> (int block, <a class="el" href="group__brlapi__keys.html#a0">brl_keycode_t</a> *code)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a3">brlapi_readBinding</a> (int block, const char **code)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a4">brlapi_ignoreKeys</a> (<a class="el" href="group__brlapi__keys.html#a0">brl_keycode_t</a> x, <a class="el" href="group__brlapi__keys.html#a0">brl_keycode_t</a> y)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__keys.html#a5">brlapi_unignoreKeys</a> (<a class="el" href="group__brlapi__keys.html#a0">brl_keycode_t</a> x, <a class="el" href="group__brlapi__keys.html#a0">brl_keycode_t</a> y)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__raw.html#a0">brlapi_getRaw</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__raw.html#a1">brlapi_leaveRaw</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__raw.html#a2">brlapi_sendRaw</a> (const unsigned char *buf, size_t size)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__raw.html#a3">brlapi_recvRaw</a> (unsigned char *buf, size_t size)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a3">brlapi_perror</a> (const char *s)</td></tr>
<tr><td nowrap align=right valign=top>int * </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a4">brlapi_errno_location</a> (void)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a2">brlapi_writePacket</a> (int fd, <a class="el" href="group__brlapi__protocol.html#a0">brl_type_t</a> type, const void *buf, size_t size)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a3">brlapi_readPacket</a> (int fd, <a class="el" href="group__brlapi__protocol.html#a0">brl_type_t</a> *type, void *buf, size_t size)</td></tr>
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
<tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a0">brlapi_errlist</a> []</td></tr>
<tr><td nowrap align=right valign=top>const int </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a1">brlapi_nerr</a></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="group__brlapi__error.html#a2">brlapi_errno</a></td></tr>
<tr><td nowrap align=right valign=top>pthread_mutex_t </td><td valign=bottom><a class="el" href="group__brlapi__protocol.html#a1">brlapi_fd_mutex</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<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>
|
