Linux Manuals session 3

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…

brlapi_header_t – Synopsis#include <brlapi_protocol.h> Data Fieldsuint32_t size brlapi_packetType_t type Detailed DescriptionStructure of packets headers Field Documentationuint32_t brlapi_header_t::sizebrlapi_packetType_t brlapi_header_t::typeAuthorGenerated automatically by Doxygen for BrlAPI from the source code.

BrlAPI handles – Typedefstypedef struct brlapi_handle_t brlapi_handle_t Functionssize_t BRLAPI_STDCALL brlapi_getHandleSize (void) Detailed DescriptionEach function provided by BrlAPI comes in two versions. 1. A version whose name is prefixed by brlapi_ for clients opening only one simultaneous connection with BrlAPI (most frequen case)2. A version whose name is prefixed by brlapi__ for use by clients wishing…

BrlAPI handles – Typedefstypedef struct brlapi_handle_t brlapi_handle_t Functionssize_t BRLAPI_STDCALL brlapi_getHandleSize (void) Detailed DescriptionEach function provided by BrlAPI comes in two versions. 1. A version whose name is prefixed by brlapi_ for clients opening only one simultaneous connection with BrlAPI (most frequen case)2. A version whose name is prefixed by brlapi__ for use by clients wishing…

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…

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…

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 handles – Typedefstypedef struct brlapi_handle_t brlapi_handle_t Functionssize_t BRLAPI_STDCALL brlapi_getHandleSize (void) Detailed DescriptionEach function provided by BrlAPI comes in two versions. 1. A version whose name is prefixed by brlapi_ for clients opening only one simultaneous connection with BrlAPI (most frequen case)2. A version whose name is prefixed by brlapi__ for use by clients wishing…

brlapi_getDriverSpecificModePacket_t – Synopsis#include <brlapi_protocol.h> Data Fieldsuint32_t magic unsigned char nameLength char name Detailed DescriptionStructure of enterRawMode / suspend packets Field Documentationuint32_t brlapi_getDriverSpecificModePacket_t::magicchar brlapi_getDriverSpecificModePacket_t::nameunsigned char brlapi_getDriverSpecificModePacket_t::nameLengthAuthorGenerated automatically by Doxygen for BrlAPI from the source code.

Getting Terminal information – How to get information about the connected Terminal. Macros#define BRLAPI_MAXNAMELENGTH 31 Functionsint BRLAPI_STDCALL brlapi_getDriverName (char *buffer, size_t size) int BRLAPI_STDCALL brlapi__getDriverName (brlapi_handle_t *handle, char *buffer, size_t size) int BRLAPI_STDCALL brlapi_getDisplaySize (unsigned int *x, unsigned int *y) int BRLAPI_STDCALL brlapi__getDisplaySize (brlapi_handle_t *handle, unsigned int *x, unsigned int *y) Detailed DescriptionBefore using Raw…

Getting Terminal information – How to get information about the connected Terminal. Macros#define BRLAPI_MAXNAMELENGTH 31 Functionsint BRLAPI_STDCALL brlapi_getDriverName (char *buffer, size_t size) int BRLAPI_STDCALL brlapi__getDriverName (brlapi_handle_t *handle, char *buffer, size_t size) int BRLAPI_STDCALL brlapi_getDisplaySize (unsigned int *x, unsigned int *y) int BRLAPI_STDCALL brlapi__getDisplaySize (brlapi_handle_t *handle, unsigned int *x, unsigned int *y) Detailed DescriptionBefore using Raw…

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…

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’s protocol – Instructions and constants for BrlAPI ‘s protocol. Data Structuresstruct brlapi_header_t struct brlapi_versionPacket_t struct brlapi_authClientPacket_t struct brlapi_authServerPacket_t struct brlapi_errorPacket_t struct brlapi_getDriverSpecificModePacket_t struct brlapi_writeArgumentsPacket_t union brlapi_packet_t Macros#define BRLAPI_PROTOCOL_VERSION ((uint32_t) 8) /** Communication protocol version */ #define BRLAPI_MAXPACKETSIZE 512 #define BRLAPI_PACKET_VERSION ‘v’ #define BRLAPI_PACKET_AUTH ‘a’ #define BRLAPI_PACKET_GETDRIVERNAME ‘n’ #define BRLAPI_PACKET_GETDISPLAYSIZE ‘s’ #define BRLAPI_PACKET_ENTERTTYMODE ‘t’ #define…

brlapi_expandedKeyCode_t – Synopsis#include <brlapi.h> Data Fieldsunsigned int type unsigned int command unsigned int argument unsigned int flags Detailed DescriptionStructure holding the components of a key code as returned by brlapi_expandKeyCode() Field Documentationunsigned int brlapi_expandedKeyCode_t::argumentthe argument value unsigned int brlapi_expandedKeyCode_t::commandthe command value unsigned int brlapi_expandedKeyCode_t::flagsthe flags value unsigned int brlapi_expandedKeyCode_t::typethe type value AuthorGenerated automatically by Doxygen…

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…

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…