.TH "brlapi_driverspecific" 3 "Wed Feb 03 2021" "Version 0.8" "BrlAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
brlapi_driverspecific \- Raw and Suspend Modes mechanism\&.  

.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi_enterRawMode\fP (const char *driver)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi__enterRawMode\fP (\fBbrlapi_handle_t\fP *handle, const char *driver)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi_leaveRawMode\fP (void)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi__leaveRawMode\fP (\fBbrlapi_handle_t\fP *handle)"
.br
.ti -1c
.RI "ssize_t \fBBRLAPI_STDCALL\fP \fBbrlapi_sendRaw\fP (const void *buffer, size_t size)"
.br
.ti -1c
.RI "ssize_t \fBBRLAPI_STDCALL\fP \fBbrlapi__sendRaw\fP (\fBbrlapi_handle_t\fP *handle, const void *buffer, size_t size)"
.br
.ti -1c
.RI "ssize_t \fBBRLAPI_STDCALL\fP \fBbrlapi_recvRaw\fP (void *buffer, size_t size)"
.br
.ti -1c
.RI "ssize_t \fBBRLAPI_STDCALL\fP \fBbrlapi__recvRaw\fP (\fBbrlapi_handle_t\fP *handle, void *buffer, size_t size)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi_suspendDriver\fP (const char *driver)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi__suspendDriver\fP (\fBbrlapi_handle_t\fP *handle, const char *driver)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi_resumeDriver\fP (void)"
.br
.ti -1c
.RI "int \fBBRLAPI_STDCALL\fP \fBbrlapi__resumeDriver\fP (\fBbrlapi_handle_t\fP *handle)"
.br
.in -1c
.SH "Detailed Description"
.PP 
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: \fIbrltty\fP doesn't work any more\&.
.PP
For this, it simply has to call \fBbrlapi_enterRawMode()\fP, then \fBbrlapi_sendRaw()\fP and \fBbrlapi_recvRaw()\fP, and finally give control back thanks to \fBbrlapi_leaveRawMode()\fP\&.
.PP
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 \fBbrlapi_getDriverName()\fP\&.
.PP
The client can also make brltty close the driver by using \fBbrlapi_suspendDriver()\fP, and resume it again with \fBbrlapi_resumeDriver()\fP\&. This should not be used if possible: raw mode should be sufficient for any use\&. If not, please ask for features :) 
.SH "Function Documentation"
.PP 
.SS "int \fBBRLAPI_STDCALL\fP brlapi__enterRawMode (\fBbrlapi_handle_t\fP * handle, const char * driver)"

.SS "int \fBBRLAPI_STDCALL\fP brlapi__leaveRawMode (\fBbrlapi_handle_t\fP * handle)"

.SS "ssize_t \fBBRLAPI_STDCALL\fP brlapi__recvRaw (\fBbrlapi_handle_t\fP * handle, void * buffer, size_t size)"

.SS "int \fBBRLAPI_STDCALL\fP brlapi__resumeDriver (\fBbrlapi_handle_t\fP * handle)"

.SS "ssize_t \fBBRLAPI_STDCALL\fP brlapi__sendRaw (\fBbrlapi_handle_t\fP * handle, const void * buffer, size_t size)"

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

.SS "int \fBBRLAPI_STDCALL\fP brlapi_enterRawMode (const char * driver)"
Switch to Raw mode 
.PP
\fBParameters:\fP
.RS 4
\fIdriver\fP Specifies the name of the driver for which the raw communication will be established\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on error 
.RE
.PP

.SS "int \fBBRLAPI_STDCALL\fP brlapi_leaveRawMode (void)"
Leave Raw mode 
.PP
\fBReturns:\fP
.RS 4
0 on success, -1 on error 
.RE
.PP

.SS "ssize_t \fBBRLAPI_STDCALL\fP brlapi_recvRaw (void * buffer, size_t size)"
Get Raw data
.PP
\fBParameters:\fP
.RS 4
\fIbuffer\fP points on a buffer where the function will store the received data; 
.br
\fIsize\fP holds the buffer size\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
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\&. 
.RE
.PP

.SS "int \fBBRLAPI_STDCALL\fP brlapi_resumeDriver (void)"
Resume braille driver 
.PP
\fBReturns:\fP
.RS 4
-1 on error 
.RE
.PP

.SS "ssize_t \fBBRLAPI_STDCALL\fP brlapi_sendRaw (const void * buffer, size_t size)"
Send Raw data
.PP
\fBParameters:\fP
.RS 4
\fIbuffer\fP points on the data; 
.br
\fIsize\fP holds the packet size\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
size on success, -1 on error 
.RE
.PP

.SS "int \fBBRLAPI_STDCALL\fP brlapi_suspendDriver (const char * driver)"
Suspend braille driver 
.PP
\fBParameters:\fP
.RS 4
\fIdriver\fP Specifies the name of the driver which will be suspended\&. 
.RE
.PP
\fBReturns:\fP
.RS 4
-1 on error 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for BrlAPI from the source code\&.