struct header_t

struct authStruct

struct errorPacket_t

struct getRawPacket_t

struct writeStruct

#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

#define BRLAPI_WF_CHARSET 0X40

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

ssize_t brlapi_readPacketHeader (int fd, brl_type_t *packetType)

ssize_t brlapi_readPacketContent (int fd, size_t packetSize, void *buf, size_t bufSize)

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

pthread_mutex_t brlapi_fd_mutex

And attributes

Or attributes

Charset

Cursor position

Flags for writing Display number

Region parameter

Contains some text

Acknowledgement

Authentication key

non-fatal error

Exception

Dimensions of brl display

Ask which driver is used

Ask which driver is used

Enter in raw mode

Asks for a specified tty

Mask key-range

Mask key-set

Braille key

Leave raw mode

Release the tty

Raw packets

Set current tty focus

Unmask key range

Unmask key set

Write

Magic number to give when sending a BRLPACKET_GETRAW packet

Read a packet from BrlAPI server

This function is for internal use, but one might use it if one really knows what one is doing...

type is where the function will store the packet type; it should always be one of the above defined BRLPACKET_* (or else something very nasty must have happened :/).

The syntax is the same as read()'s.

Returns: packet's size, -2 if EOF occurred, -1 on error. If the packet is larger than the supplied buffer, the buffer will be filled with the beginning of the packet, the rest of the packet being discarded. This follows the semantics of the recv system call when the MSG_TRUNC option is given.

See also: brlapi_writePacket()

Read the content of a packet from BrlAPI server

This function is for internal use, but one might use it if one really knows what one is doing...

packetSize is the size announced by brlapi_readPacketHeader()

bufSize is the size of buf

Returns: packetSize, -2 if EOF occurred, -1 on error. If the packet is larger than the supplied buffer, the buffer will be filled with the beginning of the packet, the rest of the packet being discarded. This follows the semantics of the recv system call when the MSG_TRUNC option is given.

See also: brlapi_writePacket() brlapi_readPacketHeader() brlapi_readPacket()

Read the header (type+size) of a packet from BrlAPI server

This function is for internal use, but one might use it if one really knows what one is doing...

type is where the function will store the packet type; it should always be one of the above defined BRLPACKET_* (or else something very nasty must have happened :/).

Returns: packet's size, -2 if EOF occurred, -1 on error.

See also: brlapi_writePacket() brlapi_readPacketContent brlapi_readPacket

Send a packet to BrlAPI server

This function is for internal use, but one might use it if one really knows what one is doing...

type should only be one of the above defined BRLPACKET_*.

The syntax is the same as write()'s.

Returns: 0 on success, -1 on failure

See also: brlapi_readPacketHeader() brlapi_readPacketContent() brlapi_readPacket()

Mutex for protecting concurrent fd access

In order to regulate concurrent access to the library's file descriptor and requests to / answers from BrlAPI server, every function of the library locks this mutex, namely

•

brlapi_initializeConnection()

•

brlapi_closeConnection()

•

brlapi_getRaw()

•

brlapi_leaveRaw()

•

brlapi_sendRaw()

•

brlapi_recvRaw()

•

brlapi_getDriverId()

•

brlapi_getDriverName()

•

brlapi_getDisplaySize()

•

brlapi_getTty()

•

brlapi_leaveTty()

•

brlapi_*write*()

•

brlapi_(un)?ignorekey(Range|Set)()

•

brlapi_readKey()

If both these functions and brlapi_writePacket() or brlapi_readPacket() are used in a multithreaded application, this mutex must be locked before calling brlapi_writePacket() or brlapi_readPacket(), and unlocked afterwards.