Linux Manuals session 3

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 Description…

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 Description…

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…

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 BrlAPI’s protocol – Instructions and constants for BrlAPI ‘s protocol. Data Structures struct 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_expandedKeyCode_t – Synopsis #include <brlapi.h> Data Fields unsigned int type unsigned int command unsigned int argument unsigned int flags Detailed Description Structure holding the components of a key code as returned by brlapi_expandKeyCode() Field Documentation unsigned int brlapi_expandedKeyCode_t::argument the argument value unsigned int brlapi_expandedKeyCode_t::command the command value unsigned int brlapi_expandedKeyCode_t::flags the flags value unsigned int…

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,…

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…

NAME brlapi_error_t – SYNOPSIS #include <brlapi.h> Data Fields int brlerrno int libcerrno int gaierrno const char * errfun Detailed Description All information that is needed to describe brlapi errors Field Documentation int brlapi_error_t::brlerrno const char* brlapi_error_t::errfun int brlapi_error_t::gaierrno int brlapi_error_t::libcerrno Author Generated automatically by Doxygen for BrlAPI from the source code. Index

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…

brlapi_errorPacket_t – Synopsis #include <brlapi_protocol.h> Data Fields uint32_t code brlapi_packetType_t type unsigned char packet Detailed Description Structure of error packets Field Documentation uint32_t brlapi_errorPacket_t::code unsigned char brlapi_errorPacket_t::packet brlapi_packetType_t brlapi_errorPacket_t::type Author Generated automatically by Doxygen for BrlAPI from the source code.

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…

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…

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…

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,…

NAME 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…

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