Linux Manuals session 3

Driver-Specific modes – Raw and Suspend Modes mechanism. Functionsint BRLAPI_STDCALL brlapi_enterRawMode (const char *driver) int BRLAPI_STDCALL brlapi__enterRawMode (brlapi_handle_t *handle, const char *driver) int BRLAPI_STDCALL brlapi_leaveRawMode (void) int BRLAPI_STDCALL brlapi__leaveRawMode (brlapi_handle_t *handle) ssize_t BRLAPI_STDCALL brlapi_sendRaw (const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi__sendRaw (brlapi_handle_t *handle, const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi_recvRaw (void *buffer, size_t…

brlapi_describedKeyCode_t – Synopsis#include <brlapi.h> Data Fieldsconst char * type const char * command unsigned int argument unsigned int flags const char * flag [64-BRLAPI_KEY_FLAGS_SHIFT] brlapi_expandedKeyCode_t values Detailed DescriptionStructure holding the components of a key code as returned by brlapi_describeKeyCode() Field Documentationunsigned int brlapi_describedKeyCode_t::argumentthe argument value const char* brlapi_describedKeyCode_t::commandthe command name const char* brlapi_describedKeyCode_t::flag[64-BRLAPI_KEY_FLAGS_SHIFT]the flag names…

Reading key presses – How to read key presses from the braille terminal. Data Structuresstruct brlapi_expandedKeyCode_t struct brlapi_describedKeyCode_t struct brlapi_range_t Macros#define brlapi_ignoreAllKeys() brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0) #define brlapi_acceptAllKeys() brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0) #define BRLAPI_UC_ROW 0x2800UL #define brlapi__ignoreAllKeys(handle) brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0) #define brlapi__acceptAllKeys(handle) brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0) Enumerationsenum brlapi_rangeType_t { brlapi_rangeType_all, brlapi_rangeType_type, brlapi_rangeType_command, brlapi_rangeType_key, brlapi_rangeType_code } Functionsint…

Deprecated names – Data Structuresstruct brlapi_writeStruct Macros#define brlapi_settings_t brlapi_connectionSettings_t #define BRLAPI_WRITESTRUCT_INITIALIZER BRLAPI_WRITEARGUMENTS_INITIALIZER #define brl_keycode_t brlapi_keyCode_t #define brl_type_t brlapi_packetType_t #define BRLCOMMANDS NULL #define BRL_KEYCODE_MAX BRLAPI_KEY_MAX #define brlapi_initializeConnection brlapi_openConnection #define brlapi_getTty brlapi_enterTtyMode #define brlapi_getTtyPath brlapi_enterTtyModeWithPath #define brlapi_leaveTty brlapi_leaveTtyMode #define brlapi_unignoreKeyRange brlapi_acceptKeyRange #define brlapi_unignoreKeySet brlapi_acceptKeySet #define brlapi_getRaw brlapi_enterRawMode #define brlapi_leaveRaw brlapi_leaveRawMode #define brlapi_suspend brlapi_suspendDriver #define brlapi_resume brlapi_resumeDriver #define…

Error handling – How to handle errors. Data Structuresstruct brlapi_error_t Macros#define BRLAPI_ERROR_SUCCESS 0 #define BRLAPI_ERROR_NOMEM 1 #define BRLAPI_ERROR_TTYBUSY 2 #define BRLAPI_ERROR_DEVICEBUSY 3 #define BRLAPI_ERROR_UNKNOWN_INSTRUCTION 4 #define BRLAPI_ERROR_ILLEGAL_INSTRUCTION 5 #define BRLAPI_ERROR_INVALID_PARAMETER 6 #define BRLAPI_ERROR_INVALID_PACKET 7 #define BRLAPI_ERROR_CONNREFUSED 8 #define BRLAPI_ERROR_OPNOTSUPP 9 #define BRLAPI_ERROR_GAIERR 10 #define BRLAPI_ERROR_LIBCERR 11 #define BRLAPI_ERROR_UNKNOWNTTY 12 #define BRLAPI_ERROR_PROTOCOL_VERSION 13 #define BRLAPI_ERROR_EOF 14…

brlapi_constants.h – SynopsisDefines#define BRLAPI_KEY_CMD_NOOP (BRLAPI_KEY_CMD(0) + 0) #define BRLAPI_KEY_CMD_LNUP (BRLAPI_KEY_CMD(0) + 1) #define BRLAPI_KEY_CMD_LNDN (BRLAPI_KEY_CMD(0) + 2) #define BRLAPI_KEY_CMD_WINUP (BRLAPI_KEY_CMD(0) + 3) #define BRLAPI_KEY_CMD_WINDN (BRLAPI_KEY_CMD(0) + 4) #define BRLAPI_KEY_CMD_PRDIFLN (BRLAPI_KEY_CMD(0) + 5) #define BRLAPI_KEY_CMD_NXDIFLN (BRLAPI_KEY_CMD(0) + 6) #define BRLAPI_KEY_CMD_ATTRUP (BRLAPI_KEY_CMD(0) + 7) #define BRLAPI_KEY_CMD_ATTRDN (BRLAPI_KEY_CMD(0) + 8) #define BRLAPI_KEY_CMD_TOP (BRLAPI_KEY_CMD(0) + 9) #define BRLAPI_KEY_CMD_BOT (BRLAPI_KEY_CMD(0)…

brlapi_constants.h – SynopsisMacros#define BRLAPI_KEY_CMD_NOOP (BRLAPI_KEY_CMD(0) + 0) #define BRLAPI_KEY_CMD_LNUP (BRLAPI_KEY_CMD(0) + 1) #define BRLAPI_KEY_CMD_LNDN (BRLAPI_KEY_CMD(0) + 2) #define BRLAPI_KEY_CMD_WINUP (BRLAPI_KEY_CMD(0) + 3) #define BRLAPI_KEY_CMD_WINDN (BRLAPI_KEY_CMD(0) + 4) #define BRLAPI_KEY_CMD_PRDIFLN (BRLAPI_KEY_CMD(0) + 5) #define BRLAPI_KEY_CMD_NXDIFLN (BRLAPI_KEY_CMD(0) + 6) #define BRLAPI_KEY_CMD_ATTRUP (BRLAPI_KEY_CMD(0) + 7) #define BRLAPI_KEY_CMD_ATTRDN (BRLAPI_KEY_CMD(0) + 8) #define BRLAPI_KEY_CMD_TOP (BRLAPI_KEY_CMD(0) + 9) #define BRLAPI_KEY_CMD_BOT (BRLAPI_KEY_CMD(0)…

brlapi_connectionSettings_t – Settings structure for BrlAPI connection. Synopsis#include <brlapi.h> Data Fieldschar * auth char * host Detailed DescriptionThis structure holds every parameter needed to connect to BrlAPI: which file the authorization key can be found in and which computer to connect to. Examples: brlapi_connectionSettings_t settings; settings.auth=’/etc/brlapi.key’; settings.host=’foo’; libbrlapi will read authorization key from file /etc/brlapi.key…

Connecting to BrlAPI – Data Structuresstruct brlapi_connectionSettings_t Settings structure for BrlAPI connection. Macros#define BRLAPI_SOCKETPORTNUM 4101 #define BRLAPI_SOCKETPORT ‘4101’ #define BRLAPI_SOCKETPATH ‘/var/lib/BrlAPI’ #define BRLAPI_ETCDIR ‘/etc’ #define BRLAPI_AUTHKEYFILE ‘brlapi.key’ #define BRLAPI_DEFAUTH BRLAPI_ETCDIR ‘/’ BRLAPI_AUTHKEYFILE #define BRLAPI_SETTINGS_INITIALIZER { NULL, NULL } Typedefstypedef int brlapi_fileDescriptor Functionsbrlapi_fileDescriptor BRLAPI_STDCALL brlapi_openConnection (const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings)" brlapi_fileDescriptor BRLAPI_STDCALL brlapi__openConnection (brlapi_handle_t *handle, const…

Connecting to BrlAPI – Data Structuresstruct brlapi_connectionSettings_t Settings structure for BrlAPI connection. Macros#define BRLAPI_SOCKETPORTNUM 4101 #define BRLAPI_SOCKETPORT ‘4101’ #define BRLAPI_SOCKETPATH ‘/var/lib/BrlAPI’ #define BRLAPI_ETCDIR ‘/etc’ #define BRLAPI_AUTHKEYFILE ‘brlapi.key’ #define BRLAPI_DEFAUTH BRLAPI_ETCDIR ‘/’ BRLAPI_AUTHKEYFILE #define BRLAPI_SETTINGS_INITIALIZER { NULL, NULL } Typedefstypedef int brlapi_fileDescriptor Functionsbrlapi_fileDescriptor BRLAPI_STDCALL brlapi_openConnection (const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings)" brlapi_fileDescriptor BRLAPI_STDCALL brlapi__openConnection (brlapi_handle_t *handle, const…

brlapi_authServerPacket_t – Synopsis#include <brlapi_protocol.h> Data Fieldsuint32_t type [1] Field Documentationuint32_t brlapi_authServerPacket_t::type[1]AuthorGenerated automatically by Doxygen for BrlAPI from the source code.

brlapi_authClientPacket_t – Synopsis#include <brlapi_protocol.h> Data Fieldsuint32_t type unsigned char key Detailed DescriptionStructure of authorization packets Field Documentationunsigned char brlapi_authClientPacket_t::keyuint32_t brlapi_authClientPacket_t::typeAuthorGenerated automatically by Doxygen for BrlAPI from the source code.

Reading key presses – How to read key presses from the braille terminal. Data Structuresstruct brlapi_expandedKeyCode_t struct brlapi_describedKeyCode_t struct brlapi_range_t Macros#define brlapi_ignoreAllKeys() brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0) #define brlapi_acceptAllKeys() brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0) #define BRLAPI_UC_ROW 0x2800UL #define brlapi__ignoreAllKeys(handle) brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0) #define brlapi__acceptAllKeys(handle) brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0) Enumerationsenum brlapi_rangeType_t { brlapi_rangeType_all, brlapi_rangeType_type, brlapi_rangeType_command, brlapi_rangeType_key, brlapi_rangeType_code } Functionsint…

Reading key presses – How to read key presses from the braille terminal. Data Structuresstruct brlapi_expandedKeyCode_t struct brlapi_describedKeyCode_t struct brlapi_range_t Macros#define brlapi_ignoreAllKeys() brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0) #define brlapi_acceptAllKeys() brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0) #define BRLAPI_UC_ROW 0x2800UL #define brlapi__ignoreAllKeys(handle) brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0) #define brlapi__acceptAllKeys(handle) brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0) Enumerationsenum brlapi_rangeType_t { brlapi_rangeType_all, brlapi_rangeType_type, brlapi_rangeType_command, brlapi_rangeType_key, brlapi_rangeType_code } Functionsint…

Reading key presses – How to read key presses from the braille terminal. Data Structuresstruct brlapi_expandedKeyCode_t struct brlapi_describedKeyCode_t struct brlapi_range_t Macros#define brlapi_ignoreAllKeys() brlapi_ignoreKeys(brlapi_rangeType_all, NULL, 0) #define brlapi_acceptAllKeys() brlapi_acceptKeys(brlapi_rangeType_all, NULL, 0) #define BRLAPI_UC_ROW 0x2800UL #define brlapi__ignoreAllKeys(handle) brlapi__ignoreKeys(handle, brlapi_rangeType_all, NULL, 0) #define brlapi__acceptAllKeys(handle) brlapi__acceptKeys(handle, brlapi_rangeType_all, NULL, 0) Enumerationsenum brlapi_rangeType_t { brlapi_rangeType_all, brlapi_rangeType_type, brlapi_rangeType_command, brlapi_rangeType_key, brlapi_rangeType_code } Functionsint…

Writing on the braille display – Write text to the braille display. Data Structuresstruct brlapi_writeArguments_t Macros#define BRLAPI_DISPLAY_DEFAULT -1 #define BRLAPI_CURSOR_LEAVE -1 #define BRLAPI_CURSOR_OFF 0 #define BRLAPI_WRITEARGUMENTS_INITIALIZER { BRLAPI_DISPLAY_DEFAULT, 0, 0, NULL, -1, NULL, NULL, BRLAPI_CURSOR_LEAVE, NULL } Functionsint BRLAPI_STDCALL brlapi_writeText (int cursor, const char *text) int BRLAPI_STDCALL brlapi__writeText (brlapi_handle_t *handle, int cursor, const char *text)…

Writing on the braille display – Write text to the braille display. Data Structuresstruct brlapi_writeArguments_t Macros#define BRLAPI_DISPLAY_DEFAULT -1 #define BRLAPI_CURSOR_LEAVE -1 #define BRLAPI_CURSOR_OFF 0 #define BRLAPI_WRITEARGUMENTS_INITIALIZER { BRLAPI_DISPLAY_DEFAULT, 0, 0, NULL, -1, NULL, NULL, BRLAPI_CURSOR_LEAVE, NULL } Functionsint BRLAPI_STDCALL brlapi_writeText (int cursor, const char *text) int BRLAPI_STDCALL brlapi__writeText (brlapi_handle_t *handle, int cursor, const char *text)…

Writing on the braille display – Write text to the braille display. Data Structuresstruct brlapi_writeArguments_t Macros#define BRLAPI_DISPLAY_DEFAULT -1 #define BRLAPI_CURSOR_LEAVE -1 #define BRLAPI_CURSOR_OFF 0 #define BRLAPI_WRITEARGUMENTS_INITIALIZER { BRLAPI_DISPLAY_DEFAULT, 0, 0, NULL, -1, NULL, NULL, BRLAPI_CURSOR_LEAVE, NULL } Functionsint BRLAPI_STDCALL brlapi_writeText (int cursor, const char *text) int BRLAPI_STDCALL brlapi__writeText (brlapi_handle_t *handle, int cursor, const char *text)…

Writing on the braille display – Write text to the braille display. Data Structuresstruct brlapi_writeArguments_t Macros#define BRLAPI_DISPLAY_DEFAULT -1 #define BRLAPI_CURSOR_LEAVE -1 #define BRLAPI_CURSOR_OFF 0 #define BRLAPI_WRITEARGUMENTS_INITIALIZER { BRLAPI_DISPLAY_DEFAULT, 0, 0, NULL, -1, NULL, NULL, BRLAPI_CURSOR_LEAVE, NULL } Functionsint BRLAPI_STDCALL brlapi_writeText (int cursor, const char *text) int BRLAPI_STDCALL brlapi__writeText (brlapi_handle_t *handle, int cursor, const char *text)…

Driver-Specific modes – Raw and Suspend Modes mechanism. Functionsint BRLAPI_STDCALL brlapi_enterRawMode (const char *driver) int BRLAPI_STDCALL brlapi__enterRawMode (brlapi_handle_t *handle, const char *driver) int BRLAPI_STDCALL brlapi_leaveRawMode (void) int BRLAPI_STDCALL brlapi__leaveRawMode (brlapi_handle_t *handle) ssize_t BRLAPI_STDCALL brlapi_sendRaw (const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi__sendRaw (brlapi_handle_t *handle, const void *buffer, size_t size) ssize_t BRLAPI_STDCALL brlapi_recvRaw (void *buffer, size_t…