Raw and Suspend Modes mechanism.
More...
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 :)
◆ brlapi__enterRawMode()
◆ brlapi__leaveRawMode()
◆ brlapi__recvRaw()
◆ brlapi__resumeDriver()
◆ brlapi__sendRaw()
◆ brlapi__suspendDriver()
◆ brlapi_enterRawMode()
Switch to Raw mode
TODO: document which functions work in 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
◆ brlapi_leaveRawMode()
Leave Raw mode
- Returns
- 0 on success, -1 on error
◆ brlapi_recvRaw()
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 on interruption by a signal or a parameter change notification, in which case brlapi_errno will be BRLAPI_ERROR_LIBCERR and errno will be EINTR.
◆ brlapi_resumeDriver()
Resume braille driver
- Returns
- -1 on error
◆ brlapi_sendRaw()
ssize_t BRLAPI_STDCALL brlapi_sendRaw |
( |
const void * |
buffer, |
|
|
size_t |
size |
|
) |
| |
Send Raw data
- Parameters
-
buffer | points on the data; |
size | holds the packet size. |
- Returns
- size on success, -1 on error
◆ brlapi_suspendDriver()
Suspend braille driver
- Parameters
-
driver | Specifies the name of the driver which will be suspended. |
- Returns
- -1 on error