<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>BrlAPI: brlapi_protocol.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.6.1 --> <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><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><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="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="dir_72852a12575d1a8ab11cd1b865cc5084.html">Programs</a> </div> </div> <div class="contents"> <h1>brlapi_protocol.h File Reference</h1> <p>types and constants for <em>BrlAPI's</em> protocol <a href="#_details">More...</a></p> <code>#include "<a class="el" href="brlapi_8h_source.html">brlapi.h</a>"</code><br/> <code>#include <inttypes.h></code><br/> <code>#include <unistd.h></code><br/> <code>#include <pthread.h></code><br/> <p><a href="brlapi__protocol_8h_source.html">Go to the source code of this file.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Data Structures</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__header__t.html">brlapi_header_t</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__versionPacket__t.html">brlapi_versionPacket_t</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__authClientPacket__t.html">brlapi_authClientPacket_t</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__authServerPacket__t.html">brlapi_authServerPacket_t</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__errorPacket__t.html">brlapi_errorPacket_t</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__getDriverSpecificModePacket__t.html">brlapi_getDriverSpecificModePacket_t</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structbrlapi__writeArgumentsPacket__t.html">brlapi_writeArgumentsPacket_t</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">union </td><td class="memItemRight" valign="bottom"><a class="el" href="unionbrlapi__packet__t.html">brlapi_packet_t</a></td></tr> <tr><td colspan="2"><h2>Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="brlapi__protocol_8h.html#ab5eb23180f7cc12b7d6c04a8ec067fdd">UINT32_MAX</a> (4294967295U)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga474ab793dc36cc75725fe2db0f6539cd">BRLAPI_PROTOCOL_VERSION</a> ((uint32_t) 8)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga226a35313d1fb8e6ce43b45a040b8060">BRLAPI_MAXPACKETSIZE</a> 512</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga59dd4fd2ec9a136698f981134c1bf413">BRLAPI_PACKET_VERSION</a> 'v'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga56aa34e93567c9c311e4bacb1590ae94">BRLAPI_PACKET_AUTH</a> 'a'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gac87f258167cb6a0399b9530e517a36ee">BRLAPI_PACKET_GETDRIVERNAME</a> 'n'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga60ad67d097729a904b4e6183844a9e64">BRLAPI_PACKET_GETDISPLAYSIZE</a> 's'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gab60182f624fd198cf6c1d5f8acfd4c23">BRLAPI_PACKET_ENTERTTYMODE</a> 't'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gaf3e8402995513974ce2df4f021deb8a6">BRLAPI_PACKET_SETFOCUS</a> 'F'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga78ff97595dd705e7a1c9cd26966aede3">BRLAPI_PACKET_LEAVETTYMODE</a> 'L'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga47e630b382b8c98e49d5d0e4fe7bbfe4">BRLAPI_PACKET_KEY</a> 'k'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga7e9a2ae1a27efdf11f5d11fca2d024c2">BRLAPI_PACKET_IGNOREKEYRANGES</a> 'm'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga804976f89df42ad6034da62c22369ee5">BRLAPI_PACKET_ACCEPTKEYRANGES</a> 'u'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga30fd33abe54249e0df012e0672555b96">BRLAPI_PACKET_WRITE</a> 'w'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga4dbb5f494c14c61b2cfed257773225e7">BRLAPI_PACKET_ENTERRAWMODE</a> '*'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga26f54245797674956773c5d605952fd0">BRLAPI_PACKET_LEAVERAWMODE</a> '#'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gadacd3f3d969abfbfe1646082fc7cbcdf">BRLAPI_PACKET_PACKET</a> 'p'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga242e2ac3823cc0f01d59892e2d8b978c">BRLAPI_PACKET_ACK</a> 'A'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga46b4fac6b43d157b6f2876da38057c3e">BRLAPI_PACKET_ERROR</a> 'e'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gac795fbf998dddc46a022c94fa249d25b">BRLAPI_PACKET_EXCEPTION</a> 'E'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga26c12ffe4fa36cfa3a9f43422d05b204">BRLAPI_PACKET_SUSPENDDRIVER</a> 'S'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga0ca55799c3e9b227f43e7539bce32438">BRLAPI_PACKET_RESUMEDRIVER</a> 'R'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga51947eca7c98c48dd65947de7dd007b7">BRLAPI_DEVICE_MAGIC</a> (0xdeadbeefL)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gad5b2bfe3d15d25b0484c4c58f400ae3d">BRLAPI_HEADERSIZE</a> sizeof(<a class="el" href="structbrlapi__header__t.html">brlapi_header_t</a>)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga367c679d5be38322a005ae2940369392">BRLAPI_AUTH_NONE</a> 'N'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gaa792a6efca4665fd11ad25fce8a9a510">BRLAPI_AUTH_KEY</a> 'K'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga34a2e40089d7cc4474f5248766355d3d">BRLAPI_AUTH_CRED</a> 'C'</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga59759e6252e19d27f7ef0fd2fd4999f9">BRLAPI_WF_DISPLAYNUMBER</a> 0X01</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga8d7548291609530a85dfc024b67bc451">BRLAPI_WF_REGION</a> 0X02</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gaf120e757b447b2454adae26bbc9f653f">BRLAPI_WF_TEXT</a> 0X04</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga9ed86ddb71fd7ba23314c1eab176b67b">BRLAPI_WF_ATTR_AND</a> 0X08</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gac1d8b05d14559b90367e532a4909d56e">BRLAPI_WF_ATTR_OR</a> 0X10</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga7e2bd4369f039add78e2b3d112f77978">BRLAPI_WF_CURSOR</a> 0X20</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga2da000ca3c25898208885cda63032250">BRLAPI_WF_CHARSET</a> 0X40</td></tr> <tr><td colspan="2"><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#gabc8a0c3fe653b8d44059aee810c5b35a">brlapi_writePacket</a> (<a class="el" href="group__brlapi__connection.html#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> fd, <a class="el" href="group__brlapi__error.html#gae2fac75a86e7a9dc54f4b3c23bc319e9">brlapi_packetType_t</a> type, const void *buf, size_t size)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga3fa149ae4b0f1adcf8f514ebc9a1f45f">brlapi_readPacketHeader</a> (<a class="el" href="group__brlapi__connection.html#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> fd, <a class="el" href="group__brlapi__error.html#gae2fac75a86e7a9dc54f4b3c23bc319e9">brlapi_packetType_t</a> *packetType)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga6a963be14210e5706f16b57a2f388e6e">brlapi_readPacketContent</a> (<a class="el" href="group__brlapi__connection.html#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> fd, size_t packetSize, void *buf, size_t bufSize)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga593411f2c9306ff774eb854f78eaa18b">brlapi_readPacket</a> (<a class="el" href="group__brlapi__connection.html#ga1273c1f34be592e19c9319e64becd1c0">brlapi_fileDescriptor</a> fd, <a class="el" href="group__brlapi__error.html#gae2fac75a86e7a9dc54f4b3c23bc319e9">brlapi_packetType_t</a> *type, void *buf, size_t size)</td></tr> <tr><td colspan="2"><h2>Variables</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">pthread_mutex_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__brlapi__protocol.html#ga2e20749820ad75c8b455310565092724">brlapi_fd_mutex</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <hr/><h2>Define Documentation</h2> <a class="anchor" id="ab5eb23180f7cc12b7d6c04a8ec067fdd"></a><!-- doxytag: member="brlapi_protocol.h::UINT32_MAX" ref="ab5eb23180f7cc12b7d6c04a8ec067fdd" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define UINT32_MAX (4294967295U)</td> </tr> </table> </div> <div class="memdoc"> </div> </div> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on 9 May 2010 for BrlAPI by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>