brlapi_suspendDriver (3)

If the application wants to directly talk to the braille terminal, it should use Raw Mode. In this special mode, the driver gives the whole control of the terminal to it: brltty doesn't work any more.

For this, it simply has to call brlapi_enterRawMode(), then brlapi_sendRaw() and brlapi_recvRaw(), and finally give control back thanks to brlapi_leaveRawMode().

Special care of the terminal should be taken, since one might completely trash the terminal's data, or even lock it! The application should always check for terminal's type thanks to brlapi_getDriverName().

The client can also make brltty close the driver by using brlapi_suspendDriver(), and resume it again with brlapi_resumeDriver(). This should not be used if possible: raw mode should be sufficient for any use. If not, please ask for features :)

int \fBBRLAPI_STDCALL\fP brlapi__enterRawMode (\fBbrlapi_handle_t\fP *handle, const char *driver)

int \fBBRLAPI_STDCALL\fP brlapi__leaveRawMode (\fBbrlapi_handle_t\fP *handle)

ssize_t \fBBRLAPI_STDCALL\fP brlapi__recvRaw (\fBbrlapi_handle_t\fP *handle, void *buffer, size_tsize)

int \fBBRLAPI_STDCALL\fP brlapi__resumeDriver (\fBbrlapi_handle_t\fP *handle)

ssize_t \fBBRLAPI_STDCALL\fP brlapi__sendRaw (\fBbrlapi_handle_t\fP *handle, const void *buffer, size_tsize)

int \fBBRLAPI_STDCALL\fP brlapi__suspendDriver (\fBbrlapi_handle_t\fP *handle, const char *driver)

int \fBBRLAPI_STDCALL\fP brlapi_enterRawMode (const char *driver)

Switch to Raw mode

Parameters:

driver Specifies the name of the driver for which the raw communication will be established.

Returns:

0 on success, -1 on error

int \fBBRLAPI_STDCALL\fP brlapi_leaveRawMode (void)

Leave Raw mode

Returns:

0 on success, -1 on error

ssize_t \fBBRLAPI_STDCALL\fP brlapi_recvRaw (void *buffer, size_tsize)

Get Raw data

Parameters:

buffer points on a buffer where the function will store the received data;

size holds the buffer size.

Returns:

its size, -1 on error or signal interruption

int \fBBRLAPI_STDCALL\fP brlapi_resumeDriver (void)

Resume braille driver

Returns:

-1 on error

ssize_t \fBBRLAPI_STDCALL\fP brlapi_sendRaw (const void *buffer, size_tsize)

Send Raw data

Parameters:

buffer points on the data;

size holds the packet size.

Returns:

size on success, -1 on error

int \fBBRLAPI_STDCALL\fP brlapi_suspendDriver (const char *driver)

Suspend braille driver

Parameters:

driver Specifies the name of the driver which will be suspended.

Returns:

-1 on error

Generated automatically by Doxygen for BrlAPI from the source code.