SysTutorials Posts

Error handling – How to handle errors. Data Structures struct 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…

Connecting to BrlAPI – Data Structures struct 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 } Typedefs typedef int brlapi_fileDescriptor Functions brlapi_fileDescriptor BRLAPI_STDCALL brlapi_openConnection (const brlapi_connectionSettings_t *desiredSettings, brlapi_connectionSettings_t *actualSettings)" brlapi_fileDescriptor BRLAPI_STDCALL…

NAME Error handling – How to handle errors. Data Structures struct 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…

NAME Error handling – How to handle errors. Data Structures struct 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…

Entering & leaving tty mode – How to take control of ttys for direct braille display / read. Macros #define BRLAPI_TTY_DEFAULT -1 Functions int BRLAPI_STDCALL brlapi_enterTtyMode (int tty, const char *driver) int BRLAPI_STDCALL brlapi__enterTtyMode (brlapi_handle_t *handle, int tty, const char *driver) int BRLAPI_STDCALL brlapi_enterTtyModeWithPath (int *ttys, int count, const char *driver) int BRLAPI_STDCALL brlapi__enterTtyModeWithPath (brlapi_handle_t…

Deprecated names – Data Structures struct 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…

Driver-Specific modes – Raw and Suspend Modes mechanism. Functions int 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,…

Deprecated names – Data Structures struct 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…

NAME Reading key presses – How to read key presses from the braille terminal. Data Structures struct 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) Enumerations enum brlapi_rangeType_t { brlapi_rangeType_all, brlapi_rangeType_type, brlapi_rangeType_command,…

NAME Types and Defines fore BrlAPI Key Codes – Macros #define BRLAPI_PRIxKEYCODE PRIx64 #define BRLAPI_PRIuKEYCODE PRIu64 #define BRLAPI_KEY_MAX UINT64_C(0XFFFFFFFFFFFFFFFF) #define BRLAPI_KEY_FLAGS_MASK UINT64_C(0XFFFFFFFF00000000) #define BRLAPI_KEY_FLAGS_SHIFT 32 #define BRLAPI_KEY_FLG(v) ((brlapi_keyCode_t)(v) << BRLAPI_KEY_FLAGS_SHIFT) #define BRLAPI_KEY_FLG_MOD1 BRLAPI_KEY_FLG(0x00000008) #define BRLAPI_KEY_FLG_MOD2 BRLAPI_KEY_FLG(0x00000010) #define BRLAPI_KEY_FLG_MOD3 BRLAPI_KEY_FLG(0x00000020) #define BRLAPI_KEY_FLG_MOD4 BRLAPI_KEY_FLG(0x00000040) #define BRLAPI_KEY_FLG_MOD5 BRLAPI_KEY_FLG(0x00000080) #define BRLAPI_KEY_TYPE_MASK UINT64_C(0X00000000E0000000) #define BRLAPI_KEY_TYPE_SHIFT 29 #define BRLAPI_KEY_TYPE_CMD UINT64_C(0X0000000020000000) #define…

brlapi_keycodes.h – Synopsis #include ‘brlapi_constants.h’ Macros #define BRLAPI_PRIxKEYCODE PRIx64 #define BRLAPI_PRIuKEYCODE PRIu64 #define BRLAPI_KEY_MAX UINT64_C(0XFFFFFFFFFFFFFFFF) #define BRLAPI_KEY_FLAGS_MASK UINT64_C(0XFFFFFFFF00000000) #define BRLAPI_KEY_FLAGS_SHIFT 32 #define BRLAPI_KEY_FLG(v) ((brlapi_keyCode_t)(v) << BRLAPI_KEY_FLAGS_SHIFT) #define BRLAPI_KEY_FLG_MOD1 BRLAPI_KEY_FLG(0x00000008) #define BRLAPI_KEY_FLG_MOD2 BRLAPI_KEY_FLG(0x00000010) #define BRLAPI_KEY_FLG_MOD3 BRLAPI_KEY_FLG(0x00000020) #define BRLAPI_KEY_FLG_MOD4 BRLAPI_KEY_FLG(0x00000040) #define BRLAPI_KEY_FLG_MOD5 BRLAPI_KEY_FLG(0x00000080) #define BRLAPI_KEY_TYPE_MASK UINT64_C(0X00000000E0000000) #define BRLAPI_KEY_TYPE_SHIFT 29 #define BRLAPI_KEY_TYPE_CMD UINT64_C(0X0000000020000000) #define BRLAPI_KEY_TYPE_SYM UINT64_C(0X0000000000000000) #define BRLAPI_KEY_CODE_MASK…

Types and Defines fore BrlAPI Key Codes – Macros #define BRLAPI_PRIxKEYCODE PRIx64 #define BRLAPI_PRIuKEYCODE PRIu64 #define BRLAPI_KEY_MAX UINT64_C(0XFFFFFFFFFFFFFFFF) #define BRLAPI_KEY_FLAGS_MASK UINT64_C(0XFFFFFFFF00000000) #define BRLAPI_KEY_FLAGS_SHIFT 32 #define BRLAPI_KEY_FLG(v) ((brlapi_keyCode_t)(v) << BRLAPI_KEY_FLAGS_SHIFT) #define BRLAPI_KEY_FLG_MOD1 BRLAPI_KEY_FLG(0x00000008) #define BRLAPI_KEY_FLG_MOD2 BRLAPI_KEY_FLG(0x00000010) #define BRLAPI_KEY_FLG_MOD3 BRLAPI_KEY_FLG(0x00000020) #define BRLAPI_KEY_FLG_MOD4 BRLAPI_KEY_FLG(0x00000040) #define BRLAPI_KEY_FLG_MOD5 BRLAPI_KEY_FLG(0x00000080) #define BRLAPI_KEY_TYPE_MASK UINT64_C(0X00000000E0000000) #define BRLAPI_KEY_TYPE_SHIFT 29 #define BRLAPI_KEY_TYPE_CMD UINT64_C(0X0000000020000000) #define BRLAPI_KEY_TYPE_SYM…

Deprecated names – Data Structures struct 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…

NAME Getting Terminal information – How to get information about the connected Terminal. Macros #define BRLAPI_MAXNAMELENGTH 31 Functions int 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…

Reading key presses – How to read key presses from the braille terminal. Data Structures struct 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) Enumerations enum brlapi_rangeType_t { brlapi_rangeType_all, brlapi_rangeType_type, brlapi_rangeType_command, brlapi_rangeType_key,…

Reading key presses – How to read key presses from the braille terminal. Data Structures struct 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) Enumerations enum brlapi_rangeType_t { brlapi_rangeType_all, brlapi_rangeType_type, brlapi_rangeType_command, brlapi_rangeType_key,…

Reading key presses – How to read key presses from the braille terminal. Data Structures struct 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) Enumerations enum brlapi_rangeType_t { brlapi_rangeType_all, brlapi_rangeType_type, brlapi_rangeType_command, brlapi_rangeType_key,…

NAME brlapi_header_t – SYNOPSIS #include <brlapi_protocol.h> Data Fields uint32_t size brlapi_packetType_t type Detailed Description Structure of packets headers Field Documentation uint32_t brlapi_header_t::size brlapi_packetType_t brlapi_header_t::type Author Generated automatically by Doxygen for BrlAPI from the source code. Index Author

NAME BrlAPI handles – Typedefs typedef struct brlapi_handle_t brlapi_handle_t Functions size_t BRLAPI_STDCALL brlapi_getHandleSize (void) Detailed Description Each 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__…

NAME BrlAPI handles – Typedefs typedef struct brlapi_handle_t brlapi_handle_t Functions size_t BRLAPI_STDCALL brlapi_getHandleSize (void) Detailed Description Each 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__…