Linux Manuals session 3

brlapi_writeArguments_t – Synopsis #include <brlapi.h> Data Fields int displayNumber unsigned int regionBegin unsigned int regionSize char * text int textSize unsigned char * andMask unsigned char * orMask int cursor char * charset Detailed Description Structure containing arguments to be given to brlapi_write() Field Documentation unsigned char* brlapi_writeArguments_t::andMask And attributes; applied first char* brlapi_writeArguments_t::charset Text…

brlapi_writeArgumentsPacket_t – Synopsis #include <brlapi_protocol.h> Data Fields uint32_t flags unsigned char data Detailed Description Structure of extended write packets Field Documentation unsigned char brlapi_writeArgumentsPacket_t::data Flags to tell which fields are present uint32_t brlapi_writeArgumentsPacket_t::flags Author Generated automatically by Doxygen for BrlAPI from the source code.

NAME Writing on the braille display – Write text to the braille display. Data Structures struct 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 } Functions int BRLAPI_STDCALL brlapi_writeText (int cursor, const char *text) int BRLAPI_STDCALL brlapi__writeText (brlapi_handle_t *handle, int…

brlapi_versionPacket_t – Synopsis #include <brlapi_protocol.h> Data Fields uint32_t protocolVersion Detailed Description Structure of version packets Field Documentation uint32_t brlapi_versionPacket_t::protocolVersion Author Generated automatically by Doxygen for BrlAPI from the source code.

NAME Version of the BrlAPI library – Macros #define BRLAPI_RELEASE ‘0.6.0’ #define BRLAPI_MAJOR 0 #define BRLAPI_MINOR 6 #define BRLAPI_REVISION 0 Detailed Description Macro Definition Documentation #define BRLAPI_MAJOR 0 Library major version. #define BRLAPI_MINOR 6 Library minor version. #define BRLAPI_RELEASE ‘0.6.0’ Library version. #define BRLAPI_REVISION 0 Library revision. Author Generated automatically by Doxygen for BrlAPI from…

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…

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

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

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

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…

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…

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

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

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

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