api_protocol.h File Reference.TH "api_protocol.h" 3 "22 Dec 2004" "Version 1.0" "BrlAPI"

NAME
api_protocol.h - types and constants for BrlAPI's protocol

SYNOPSIS

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

  Data Structures
struct authStruct
struct errorPacket_t
struct writeStruct

  Defines
#define BRLPACKET_AUTHKEY 'K'
#define BRLPACKET_GETDRIVERID 'd'
#define BRLPACKET_GETDRIVERNAME 'n'
#define BRLPACKET_GETDISPLAYSIZE 's'
#define BRLPACKET_GETTTY 't'
#define BRLPACKET_SETFOCUS 'F'
#define BRLPACKET_LEAVETTY 'L'
#define BRLPACKET_KEY 'k'
#define BRLPACKET_IGNOREKEYRANGE 'm'
#define BRLPACKET_IGNOREKEYSET 'M'
#define BRLPACKET_UNIGNOREKEYRANGE 'u'
#define BRLPACKET_UNIGNOREKEYSET 'U'
#define BRLPACKET_WRITE 'w'
#define BRLPACKET_GETRAW '*'
#define BRLPACKET_LEAVERAW '#'
#define BRLPACKET_PACKET 'p'
#define BRLPACKET_ACK 'A'
#define BRLPACKET_ERROR 'e'
#define BRLPACKET_EXCEPTION 'E'
#define BRLRAW_MAGIC (0xdeadbeefL)
#define BRLAPI_WF_DISPLAYNUMBER 0X01
#define BRLAPI_WF_REGION 0X02
#define BRLAPI_WF_TEXT 0X04
#define BRLAPI_WF_ATTR_AND 0X08
#define BRLAPI_WF_ATTR_OR 0X10
#define BRLAPI_WF_CURSOR 0X20

  Functions
ssize_t brlapi_writePacket (int fd, brl_type_t type, const void *buf, size_t size)
ssize_t brlapi_readPacket (int fd, brl_type_t *type, void *buf, size_t size)

Detailed Description

Author

Generated automatically by Doxygen for BrlAPI from the source code.