brlapi.h(3)

NAME
brlapi.h - types, defines and functions prototypes for BrlAPI

SYNOPSIS

#include <inttypes.h>
#include <unistd.h>
#include <pthread.h>

  Data Structures
struct brlapi_keybinding_t
Key binding structure.
struct brlapi_settings_t
Settings structure for BrlAPI connection.

  Defines
#define BRLAPI_SOCKETPORT '35751'
#define BRLAPI_ETCDIR '/etc'
#define BRLAPI_AUTHFILE 'brlapi.key'
#define BRLAPI_AUTHNAME BRLAPI_ETCDIR '/' BRLAPI_AUTHFILE
#define BRLKEYCODES ((uint32_t) 1)
#define BRLCOMMANDS ((uint32_t) 2)
#define BRL_KEYBUF_SIZE 256
#define BRL_KEYCODE_MAX ((brl_keycode_t) (UINT32_MAX))
#define BRLAPI_HOMEKEYDIR '.brlkeys'
#define BRLAPI_HOMEKEYEXT '.kbd'
#define BRLAPI_ETCKEYFILE 'brlkeys'
#define BRLERR_SUCCESS 0
#define BRLERR_NOMEM 1
#define BRLERR_TTYBUSY 2
#define BRLERR_UNKNOWN_INSTRUCTION 3
#define BRLERR_ILLEGAL_INSTRUCTION 4
#define BRLERR_INVALID_PARAMETER 5
#define BRLERR_INVALID_PACKET 6
#define BRLERR_RAWNOTSUPP 7
#define BRLERR_KEYSNOTSUPP 8
#define BRLERR_CONNREFUSED 9
#define BRLERR_OPNOTSUPP 10
#define BRLERR_GAIERR 11
#define BRLERR_LIBCERR 12
#define BRLERR_UNKNOWNTTY 13
#define brlapi_errno (*brlapi_errno_location ())
#define BRLAPI_MAXPACKETSIZE 512
#define BRLPACKET_AUTHKEY 'K'
#define BRLPACKET_BYE 'B'
#define BRLPACKET_GETDRIVERID 'd'
#define BRLPACKET_GETDRIVERNAME 'n'
#define BRLPACKET_GETDISPLAYSIZE 's'
#define BRLPACKET_GETTTY 't'
#define BRLPACKET_LEAVETTY 'L'
#define BRLPACKET_KEY 'k'
#define BRLPACKET_COMMAND 'c'
#define BRLPACKET_MASKKEYS 'm'
#define BRLPACKET_UNMASKKEYS 'u'
#define BRLPACKET_WRITE 'W'
#define BRLPACKET_WRITEDOTS 'D'
#define BRLPACKET_STATWRITE 'S'
#define BRLPACKET_GETRAW '*'
#define BRLPACKET_LEAVERAW '#'
#define BRLPACKET_PACKET 'p'
#define BRLPACKET_ACK 'A'
#define BRLPACKET_ERROR 'E'
#define BRLRAW_MAGIC (0xdeadbeefL)

  Typedefs
typedef uint32_t brl_keycode_t
typedef uint32_t brl_type_t

  Functions
int brlapi_initializeConnection (const brlapi_settings_t *clientSettings, brlapi_settings_t *usedSettings)
void brlapi_closeConnection (void)
int brlapi_loadAuthKey (const char *filename, int *authlength, void *auth)
int brlapi_getControllingTty (void)
char * brlapi_getDriverId (void)
char * brlapi_getDriverName (void)
int brlapi_getDisplaySize (unsigned int *x, unsigned int *y)
int brlapi_getTty (uint32_t tty, uint32_t how, brlapi_keybinding_t *keybinding)
int brlapi_leaveTty (void)
int brlapi_writeBrl (uint32_t cursor, const char *str)
int brlapi_writeBrlDots (const char *dots)
int brlapi_readKey (int block, brl_keycode_t *code)
int brlapi_readCommand (int block, brl_keycode_t *code)
int brlapi_readBinding (int block, const char **code)
int brlapi_ignoreKeys (brl_keycode_t x, brl_keycode_t y)
int brlapi_unignoreKeys (brl_keycode_t x, brl_keycode_t y)
int brlapi_getRaw (void)
int brlapi_leaveRaw (void)
int brlapi_sendRaw (const unsigned char *buf, size_t size)
int brlapi_recvRaw (unsigned char *buf, size_t size)
void brlapi_perror (const char *s)
int * brlapi_errno_location (void)
int brlapi_writePacket (int fd, brl_type_t type, const void *buf, size_t size)
int brlapi_readPacket (int fd, brl_type_t *type, void *buf, size_t size)

  Variables
const char * brlapi_errlist []
const int brlapi_nerr
int brlapi_errno
pthread_mutex_t brlapi_fd_mutex

DETAILED DESCRIPTION

AUTHOR

Generated automatically by Doxygen for BrlAPI from the source code.