| brlapi_error(3) | Library Functions Manual | brlapi_error(3) |
brlapi_error - Error handling
- How to handle errors.
struct brlapi_error_t
#define brlapi_error (*brlapi_error_location())
#define brlapi_errno (brlapi_error.brlerrno)
#define brlapi_libcerrno (brlapi_error.libcerrno)
#define brlapi_gaierrno (brlapi_error.gaierrno)
#define brlapi_errfun (brlapi_error.errfun)
typedef uint32_t brlapi_packetType_t
typedef void(BRLAPI_STDCALL * brlapi_exceptionHandler_t) (int
error, brlapi_packetType_t type, const void *packet, size_t size)
typedef void(BRLAPI_STDCALL * brlapi__exceptionHandler_t)
(brlapi_handle_t *handle, int error, brlapi_packetType_t type,
const void *packet, size_t size)
enum brlapi_error { BRLAPI_ERROR_SUCCESS = 0,
BRLAPI_ERROR_SUCCESS = 0, BRLAPI_ERROR_NOMEM = 1,
BRLAPI_ERROR_NOMEM = 1, BRLAPI_ERROR_TTYBUSY = 2,
BRLAPI_ERROR_TTYBUSY = 2, BRLAPI_ERROR_DEVICEBUSY = 3,
BRLAPI_ERROR_DEVICEBUSY = 3, BRLAPI_ERROR_UNKNOWN_INSTRUCTION
= 4, BRLAPI_ERROR_UNKNOWN_INSTRUCTION = 4,
BRLAPI_ERROR_ILLEGAL_INSTRUCTION = 5,
BRLAPI_ERROR_ILLEGAL_INSTRUCTION = 5,
BRLAPI_ERROR_INVALID_PARAMETER = 6,
BRLAPI_ERROR_INVALID_PARAMETER = 6,
BRLAPI_ERROR_INVALID_PACKET = 7, BRLAPI_ERROR_INVALID_PACKET =
7, BRLAPI_ERROR_CONNREFUSED = 8, BRLAPI_ERROR_CONNREFUSED = 8,
BRLAPI_ERROR_OPNOTSUPP = 9, BRLAPI_ERROR_OPNOTSUPP = 9,
BRLAPI_ERROR_GAIERR = 10, BRLAPI_ERROR_GAIERR = 10,
BRLAPI_ERROR_LIBCERR = 11, BRLAPI_ERROR_LIBCERR = 11,
BRLAPI_ERROR_UNKNOWNTTY = 12, BRLAPI_ERROR_UNKNOWNTTY = 12,
BRLAPI_ERROR_PROTOCOL_VERSION = 13,
BRLAPI_ERROR_PROTOCOL_VERSION = 13, BRLAPI_ERROR_EOF = 14,
BRLAPI_ERROR_EOF = 14, BRLAPI_ERROR_EMPTYKEY = 15,
BRLAPI_ERROR_EMPTYKEY = 15, BRLAPI_ERROR_DRIVERERROR = 16,
BRLAPI_ERROR_DRIVERERROR = 16, BRLAPI_ERROR_AUTHENTICATION =
17, BRLAPI_ERROR_AUTHENTICATION = 17,
BRLAPI_ERROR_READONLY_PARAMETER = 18,
BRLAPI_ERROR_READONLY_PARAMETER = 18 }
void BRLAPI_STDCALL brlapi_perror (const char *s)
brlapi_error_t *BRLAPI_STDCALL brlapi_error_location
(void)
const char *BRLAPI_STDCALL brlapi_strerror (const
brlapi_error_t *error)
size_t BRLAPI_STDCALL brlapi_strerror_r (const
brlapi_error_t *error, char *buf, size_t buflen)
const char *BRLAPI_STDCALL brlapi_getPacketTypeName
(brlapi_packetType_t type)
int BRLAPI_STDCALL brlapi_strexception (char *buffer, size_t
bufferSize, int error, brlapi_packetType_t type, const void *packet,
size_t packetSize)
int BRLAPI_STDCALL brlapi__strexception (brlapi_handle_t
*handle, char *buffer, size_t bufferSize, int error,
brlapi_packetType_t type, const void *packet, size_t packetSize)
brlapi_exceptionHandler_t BRLAPI_STDCALL
brlapi_setExceptionHandler (brlapi_exceptionHandler_t handler)
brlapi__exceptionHandler_t BRLAPI_STDCALL
brlapi__setExceptionHandler (brlapi_handle_t *handle,
brlapi__exceptionHandler_t handler)
void BRLAPI_STDCALL brlapi_defaultExceptionHandler (int error,
brlapi_packetType_t type, const void *packet, size_t size)
void BRLAPI_STDCALL brlapi__defaultExceptionHandler
(brlapi_handle_t *handle, int error, brlapi_packetType_t type,
const void *packet, size_t size)
const char * brlapi_errlist []
const int brlapi_nerr
brlapi_error_t brlapi_error
enum brlapi_error brlapi_errno
int brlapi_libcerrno
int brlapi_gaierrno
const char * brlapi_errfun
When a function fails, brlapi_errno will hold an error code to explain why it failed. It should always be reported somehow.
Although most errors are reported that way, some (called exceptions) are reported asynchronously for efficiency reasons, because they always just report a programming error. The affected functions are: brlapi_setFocus, brlapi_write* and brlapi_sendRaw. When they happen, the next call to brlapi_something will close the connection and call the exception handler. If the exception handler returns, the brlapi_something function will return an end-of-file error.
The default exception handler (brlapi_defaultExceptionHandler()) dumps the guilty packet before abort()ing. It can be replaced by calling brlapi_setExceptionHandler(). For instance, the Java and Python bindings use this for raising a Java or Python exception that may be caught.
Cheat about the brlapi_errfun C token
Cheat about the brlapi_errno C token
Cheat about the brlapi_error C token
Cheat about the brlapi_gaierrno C token
Cheat about the brlapi_libcerrno C token
Types for exception handlers
Types of exception handlers which are to be given to brlapi_setExceptionHandler() and brlapi__setExceptionHandler().
Parameters
Type for packet type. Only unsigned can cross networks, 32bits
BrlAPI Error codes
Enumerator
Get per-thread error location
In multithreaded software, brlapi_error is thread-specific, so api.h cheats about the brlapi_error token and actually calls brlapi_error_location().
This gets the thread specific location of global variable brlapi_error
Get plain packet type
brlapi_getPacketTypeName() returns the plain packet type name corresponding to its argument.
Print a BrlAPI error message
brlapi_perror() reads brlapi_error, and acts just like perror().
Set a new exception handler
brlapi_setExceptionHandler() replaces the previous exception handler with the handler parameter. The previous exception handler is returned to make chaining error handlers possible.
The default handler just prints the exception and abort()s.
Get plain error message
brlapi_strerror() returns the plain error message corresponding to its argument. Since the message is a constant string, the application must not free it. Also, this makes it unsafe in threaded environments, brlapi_strerror_r() should be used instead in that case.
Store plain error message
brlapi_strerror_r() stores the plain error message corresponding to its error argument. buflen has to be set to the size of buf, and brlapi_strerror_r() will store at most buflen bytes in buf. If buflen is not large enough for the whole error message, it will be truncated, but a trailing \0 character will still be set at buf[buflen-1].
Returns
If buflen is set to 0, buf can be set to NULL, and brlapi_strerror_r will thus only return the number of characters that would have been stored (without the trailing \0 character).
Describes an exception
brlapi_strexception() puts a text describing the given exception in buffer.
The beginning of the guilty packet is dumped as a sequence of hex bytes.
Returns
Shorthand for brlapi_error.errfun
Error message list
These are the string constants used by brlapi_perror().
Shorthand for brlapi_error.errno
Global variable brlapi_error
brlapi_error is a global left-value containing the last error information. Its errno field is not reset to BRLAPI_ERROR_SUCCESS on success.
This information may be copied in brlapi_error_t variables for later use with the brlapi_strerror function.
Shorthand for brlapi_error.gaierrno
Shorthand for brlapi_error.libcerrno
Number of error messages
Generated automatically by Doxygen for BrlAPI from the source code.
| Version 0.8 | BrlAPI |