1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
|
.TH "Error handling" 3 "15 Jan 2004" "BrlAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Error handling \- how to handle errors which might very well happen
More...
.SS "Defines"
.in +1c
.ti -1c
.RI "#define \fBBRLERR_SUCCESS\fP 0"
.br
.ti -1c
.RI "#define \fBBRLERR_NOMEM\fP 1"
.br
.ti -1c
.RI "#define \fBBRLERR_TTYBUSY\fP 2"
.br
.ti -1c
.RI "#define \fBBRLERR_UNKNOWN_INSTRUCTION\fP 3"
.br
.ti -1c
.RI "#define \fBBRLERR_ILLEGAL_INSTRUCTION\fP 4"
.br
.ti -1c
.RI "#define \fBBRLERR_INVALID_PARAMETER\fP 5"
.br
.ti -1c
.RI "#define \fBBRLERR_INVALID_PACKET\fP 6"
.br
.ti -1c
.RI "#define \fBBRLERR_RAWNOTSUPP\fP 7"
.br
.ti -1c
.RI "#define \fBBRLERR_KEYSNOTSUPP\fP 8"
.br
.ti -1c
.RI "#define \fBBRLERR_CONNREFUSED\fP 9"
.br
.ti -1c
.RI "#define \fBBRLERR_OPNOTSUPP\fP 10"
.br
.ti -1c
.RI "#define \fBBRLERR_GAIERR\fP 11"
.br
.ti -1c
.RI "#define \fBBRLERR_LIBCERR\fP 12"
.br
.ti -1c
.RI "#define \fBBRLERR_UNKNOWNTTY\fP 13"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBbrlapi_perror\fP (const char *s)"
.br
.ti -1c
.RI "int * \fBbrlapi_errno_location\fP (void)"
.br
.in -1c
.SS "Variables"
.in +1c
.ti -1c
.RI "const char * \fBbrlapi_errlist\fP []"
.br
.ti -1c
.RI "const int \fBbrlapi_nerr\fP"
.br
.ti -1c
.RI "int \fBbrlapi_errno\fP"
.br
.in -1c
.SH "DETAILED DESCRIPTION"
.PP
.SH "DEFINE DOCUMENTATION"
.PP
.SS "#define BRLERR_CONNREFUSED 9"
.PP
Connection refused
.SS "#define BRLERR_GAIERR 11"
.PP
Getaddrinfo error
.SS "#define BRLERR_ILLEGAL_INSTRUCTION 4"
.PP
Forbiden in current mode
.SS "#define BRLERR_INVALID_PACKET 6"
.PP
Invalid size
.SS "#define BRLERR_INVALID_PARAMETER 5"
.PP
Out of range or have no sense
.SS "#define BRLERR_KEYSNOTSUPP 8"
.PP
Reading of key codes not supported by loaded driver
.SS "#define BRLERR_LIBCERR 12"
.PP
Libc error
.SS "#define BRLERR_NOMEM 1"
.PP
Not enough memory
.SS "#define BRLERR_OPNOTSUPP 10"
.PP
Operation not supported
.SS "#define BRLERR_RAWNOTSUPP 7"
.PP
Raw mode not supported by loaded driver
.SS "#define BRLERR_SUCCESS 0"
.PP
Success
.SS "#define BRLERR_TTYBUSY 2"
.PP
Already a connection running in this tty
.SS "#define BRLERR_UNKNOWN_INSTRUCTION 3"
.PP
Not implemented in protocol
.SS "#define BRLERR_UNKNOWNTTY 13"
.PP
Couldn't find out the tty number
.SH "FUNCTION DOCUMENTATION"
.PP
.SS "int* brlapi_errno_location (void)"
.PP
Get per-thread errno location
.PP
In multithreaded software, brlapi_errno is thread specific, so \fBbrlapi.h\fP cheats about the brlapi_errno token and actually calls \fBbrlapi_errno_location()\fP
.PP
This gets the thread specific location of global variable brlapi_errno
.SS "void brlapi_perror (const char * s)"
.PP
Print a BrlAPI error message
.PP
\fBbrlapi_perror()\fP reads brlapi_errno, and acts just like perror()
.SH "VARIABLE DOCUMENTATION"
.PP
.SS "const char* brlapi_errlist[]"
.PP
Error message list
.PP
These are the string constants used by \fBbrlapi_perror()\fP
.SS "int brlapi_errno"
.PP
Global variable brlapi_errno
.PP
brlapi_errno is a global left-value containing the last error code. It is not reset to BRLERR_SUCCESS on success.
.SS "const int brlapi_nerr"
.PP
Number of error messages
|