Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

api.h File Reference

Types, defines and functions prototypes for BrlAPI's library. More...

#include <sys/types.h>
#include <stdint.h>
#include <unistd.h>

Go to the source code of this file.

Data Structures

struct  brlapi_settings_t
 Settings structure for BrlAPI connection. More...
struct  brlapi_writeStruct
struct  brlapi_error_t

Defines

#define BRLAPI_SOCKETPORTNUM   35751
#define BRLAPI_MAXPACKETSIZE   512
#define BRLAPI_MAXNAMELENGTH   31
#define BRLAPI_SOCKETPATH   "/var/lib/BrlAPI/"
#define BRLAPI_ETCDIR   "/etc"
#define BRLAPI_AUTHFILE   "brlapi.key"
#define BRLAPI_DEFAUTHPATH   BRLAPI_ETCDIR "/" BRLAPI_AUTHFILE
#define BRLAPI_WRITESTRUCT_INITIALIZER   { -1, 0, 0, NULL, NULL, NULL, -1, NULL };
#define BRL_KEYCODE_MAX   ((brl_keycode_t) (UINT32_MAX))
#define BRLAPI_MAXKEYSETSIZE   (BRLAPI_MAXPACKETSIZE / sizeof(brl_keycode_t))
#define BRLERR_SUCCESS   0
#define BRLERR_NOMEM   1
#define BRLERR_TTYBUSY   2
#define BRLERR_RAWMODEBUSY   3
#define BRLERR_UNKNOWN_INSTRUCTION   4
#define BRLERR_ILLEGAL_INSTRUCTION   5
#define BRLERR_INVALID_PARAMETER   6
#define BRLERR_INVALID_PACKET   7
#define BRLERR_CONNREFUSED   8
#define BRLERR_OPNOTSUPP   9
#define BRLERR_GAIERR   10
#define BRLERR_LIBCERR   11
#define BRLERR_UNKNOWNTTY   12
#define BRLERR_PROTOCOL_VERSION   13
#define BRLERR_EOF   14
#define BRLERR_EMPTYKEY   15
#define BRLERR_DRIVERERROR   16
#define brlapi_error   (*brlapi_error_location())
#define brlapi_errno   (brlapi_error.brlerrno)
#define brlapi_libcerrno   (brlapi_error.exterrno.libcerrno)
#define brlapi_gaierrno   (brlapi_error.exterrno.gaierrno)
#define brlapi_errfun   (brlapi_error.errfun)

Typedefs

typedef uint32_t brl_keycode_t
typedef uint32_t brl_type_t
typedef void(* brlapi_exceptionHandler_t )(int err, brl_type_t type, const void *buf, size_t size)

Functions

int brlapi_initializeConnection (const brlapi_settings_t *clientSettings, brlapi_settings_t *usedSettings)
void brlapi_closeConnection (void)
int brlapi_loadAuthKey (const char *filename, size_t *authlength, void *auth)
int brlapi_getDriverId (char *id, size_t n)
int brlapi_getDriverName (char *name, size_t n)
int brlapi_getDisplaySize (unsigned int *x, unsigned int *y)
int brlapi_getTty (int tty, const char *how)
int brlapi_getTtyPath (int *ttys, int nttys, const char *how)
int brlapi_leaveTty (void)
int brlapi_setFocus (int tty)
int brlapi_writeText (int cursor, const char *str)
int brlapi_writeDots (const unsigned char *dots)
int brlapi_write (const brlapi_writeStruct *s)
int brlapi_readKey (int block, brl_keycode_t *code)
int brlapi_ignoreKeyRange (brl_keycode_t x, brl_keycode_t y)
int brlapi_ignoreKeySet (const brl_keycode_t *s, unsigned int n)
int brlapi_unignoreKeyRange (brl_keycode_t x, brl_keycode_t y)
int brlapi_unignoreKeySet (const brl_keycode_t *s, unsigned int n)
int brlapi_getRaw (const char *driver)
int brlapi_leaveRaw (void)
ssize_t brlapi_sendRaw (const void *buf, size_t size)
ssize_t brlapi_recvRaw (void *buf, size_t size)
void brlapi_perror (const char *s)
brlapi_error_tbrlapi_error_location (void)
const char * brlapi_strerror (const brlapi_error_t *error)
const char * brlapi_packetType (brl_type_t ptype)
int brlapi_strexception (char *buf, size_t n, int err, brl_type_t type, const void *packet, size_t size)
brlapi_exceptionHandler_t brlapi_setExceptionHandler (brlapi_exceptionHandler_t handler)

Variables

const char * brlapi_errlist []
const int brlapi_nerr
brlapi_error_t brlapi_error
int brlapi_errno
int brlapi_libcerrno
int brlapi_gaierrno
const char * brlapi_errfun


Detailed Description


Generated on Mon Dec 26 09:55:17 2005 for BrlAPI by  doxygen 1.4.4