Annotation of libwww/Library/src/HTError.html, revision 2.42
2.1 frystyk 1: <HTML>
2: <HEAD>
2.40 frystyk 3: <!-- Changed by: Henrik Frystyk Nielsen, 4-Jul-1996 -->
2.37 frystyk 4: <TITLE>W3C Reference Library libwww Error Class</TITLE>
2.1 frystyk 5: </HEAD>
6: <BODY>
2.37 frystyk 7: <H1>
8: The Error Class
9: </H1>
2.18 frystyk 10: <PRE>
11: /*
2.22 frystyk 12: ** (c) COPYRIGHT MIT 1995.
2.18 frystyk 13: ** Please first read the full copyright statement in the file COPYRIGH.
14: */
15: </PRE>
2.37 frystyk 16: <P>
17: The Error class provides an easy API for registering errors ocurring while
18: the Library serves a request. All errors are registered in an "error
19: stack" in the <A HREF="HTReq.html">Request object</A> which allows for
20: nested errors. The Error class is both natural language independent and
21: application independent in that it uses enumerations in order to refer to
22: specific errors. It is for the application to provide an error presentation
23: module which interprets the errors associated with a request. An eample of
24: such an implementation can be found in the <A HREF="HTDialog.html">HTDialog
25: module</A>.
26: <P>
27: This module is implemented by <A HREF="HTError.c">HTError.c</A>, and it is
28: a part of the <A HREF="http://www.w3.org/pub/WWW/Library/"> W3C Reference
29: Library</A>.
2.1 frystyk 30: <PRE>
31: #ifndef HTERROR_H
32: #define HTERROR_H
2.36 frystyk 33:
34: typedef struct _HTError HTError;
35:
36: typedef enum _HTSeverity {
37: ERR_UNKNOWN = 0x0,
38: ERR_FATAL = 0x1,
39: ERR_NON_FATAL = 0x2,
40: ERR_WARN = 0x4,
41: ERR_INFO = 0x8
42: } HTSeverity;
43:
2.28 frystyk 44: #include "HTReq.h"
2.1 frystyk 45: </PRE>
2.37 frystyk 46: <H2>
47: <A NAME="errorinfo">Error Codes and Messages</A>
48: </H2>
49: <P>
50: <B>Note:</B> All non-HTTP error codes have index numbers > HTERR_HTTP_CODES,
51: and they will not be shown in the error-message generated.
2.1 frystyk 52: <PRE>
53: typedef enum _HTErrorElement {
2.38 frystyk 54: HTERR_CONTINUE = 0, /* 100 */
55: HTERR_SWITCHING, /* 101 */
56: HTERR_OK, /* 200 */
2.1 frystyk 57: HTERR_CREATED, /* 201 */
58: HTERR_ACCEPTED, /* 202 */
2.38 frystyk 59: HTERR_NON_AUTHORITATIVE, /* 203 */
2.23 frystyk 60: HTERR_NO_CONTENT, /* 204 */
2.38 frystyk 61: HTERR_RESET, /* 205 */
62: HTERR_PARTIAL, /* 206 */
63: HTERR_MULTIPLE, /* 300 */
2.1 frystyk 64: HTERR_MOVED, /* 301 */
65: HTERR_FOUND, /* 302 */
66: HTERR_METHOD, /* 303 */
67: HTERR_NOT_MODIFIED, /* 304 */
2.38 frystyk 68: HTERR_USE_PROXY, /* 305 */
2.1 frystyk 69: HTERR_BAD_REQUEST, /* 400 */
70: HTERR_UNAUTHORIZED, /* 401 */
71: HTERR_PAYMENT_REQUIRED, /* 402 */
72: HTERR_FORBIDDEN, /* 403 */
73: HTERR_NOT_FOUND, /* 404 */
2.20 frystyk 74: HTERR_NOT_ALLOWED, /* 405 */
75: HTERR_NONE_ACCEPTABLE, /* 406 */
2.38 frystyk 76: HTERR_PROXY_UNAUTHORIZED, /* 407 */
2.20 frystyk 77: HTERR_TIMEOUT, /* 408 */
2.38 frystyk 78: HTERR_CONFLICT, /* 409 */
79: HTERR_GONE, /* 410 */
80: HTERR_LENGTH_REQUIRED, /* 411 */
81: HTERR_PRECON_FAILED, /* 412 */
82: HTERR_TOO_BIG, /* 413 */
83: HTERR_URI_TOO_BIG, /* 414 */
84: HTERR_UNSUPPORTED, /* 415 */
2.1 frystyk 85: HTERR_INTERNAL, /* 500 */
86: HTERR_NOT_IMPLEMENTED, /* 501 */
2.20 frystyk 87: HTERR_BAD_GATE, /* 502 */
88: HTERR_DOWN, /* 503 */
89: HTERR_GATE_TIMEOUT, /* 504 */
2.38 frystyk 90: HTERR_BAD_VERSION, /* 505 */
91:
92: /* Cache warnings */
93: HTERR_STALE, /* 10 */
94: HTERR_REVALIDATION_FAILED, /* 11 */
95: HTERR_DISCONNECTED_CACHE, /* 12 */
96: HTERR_HEURISTIC_EXPIRATION, /* 13 */
97: HTERR_TRANSFORMED, /* 14 */
98: HTERR_CACHE, /* 99 */
99:
100: /* Put all non-HTTP status codes after this */
2.1 frystyk 101: HTERR_NO_REMOTE_HOST,
2.13 frystyk 102: HTERR_NO_HOST,
2.31 frystyk 103: HTERR_NO_FILE,
2.1 frystyk 104: HTERR_FTP_SERVER,
105: HTERR_FTP_NO_RESPONSE,
106: HTERR_TIME_OUT,
2.2 frystyk 107: HTERR_GOPHER_SERVER,
108: HTERR_INTERRUPTED,
2.13 frystyk 109: HTERR_CON_INTR,
2.2 frystyk 110: HTERR_CSO_SERVER,
2.20 frystyk 111: HTERR_HTTP09,
112: HTERR_BAD_REPLY,
2.16 frystyk 113: HTERR_UNKNOWN_AA,
2.5 frystyk 114: HTERR_NEWS_SERVER,
2.7 frystyk 115: HTERR_FILE_TO_FTP,
2.39 frystyk 116: HTERR_AUTO_REDIRECT,
2.8 frystyk 117: HTERR_MAX_REDIRECT,
2.16 frystyk 118: HTERR_EOF,
2.14 frystyk 119: HTERR_WAIS_OVERFLOW,
120: HTERR_WAIS_MODULE,
2.12 frystyk 121: HTERR_WAIS_NO_CONNECT,
2.2 frystyk 122: HTERR_SYSTEM,
2.29 frystyk 123: HTERR_CLASS,
2.31 frystyk 124: HTERR_ACCESS,
125: HTERR_LOGIN,
2.41 frystyk 126: HTERR_CACHE_EXPIRED,
2.1 frystyk 127: HTERR_ELEMENTS /* This MUST be the last element */
128: } HTErrorElement;
2.30 frystyk 129: </PRE>
2.37 frystyk 130: <H2>
131: What Errors should be Parsed Through?
132: </H2>
133: <P>
134: This variable dictates which errors should be put out when generating the
135: message to the user. The first four enumerations make it possible to see
136: `everything as bad or worse than' this level, e.g. <CODE>HT_ERR_SHOW_NON_FATAL
137: </CODE>shows messages of type <CODE>HT_ERR_SHOW_NON_FATAL </CODE>and
138: <CODE>HT_ERR_SHOW_FATAL</CODE>.
139: <P>
140: <B>Note:</B> The default value is made so that it only puts a message to
141: <EM>stderr</EM> if a `real' error has occurred. If a separate widget is available
142: for information and error messages then probably
143: <CODE>HT_ERR_SHOW_DETAILED</CODE> would be more appropriate.
144: <PRE>
145: typedef enum _HTErrorShow {
146: HT_ERR_SHOW_FATAL = 0x1,
147: HT_ERR_SHOW_NON_FATAL = 0x3,
148: HT_ERR_SHOW_WARNING = 0x7,
149: HT_ERR_SHOW_INFO = 0xF,
150: HT_ERR_SHOW_PARS = 0x10,
151: HT_ERR_SHOW_LOCATION = 0x20,
152: HT_ERR_SHOW_IGNORE = 0x40,
153: HT_ERR_SHOW_FIRST = 0x80,
154: HT_ERR_SHOW_LINKS = 0x100,
155: HT_ERR_SHOW_DEFAULT = 0x13,
156: HT_ERR_SHOW_DETAILED = 0x1F,
157: HT_ERR_SHOW_DEBUG = 0x7F
158: } HTErrorShow;
2.19 roeber 159:
2.42 ! eric 160: typedef struct _HTErrorMessage {
! 161: int code; /* Error number */
! 162: char * msg; /* Short explanation */
! 163: char * url; /* Explaning URL */
! 164: } HTErrorMessage;
! 165:
! 166: /* CODE ERROR MESSAGE ERROR URL */
! 167: #define HTERR_ENGLISH_INITIALIZER \
! 168: { 100, "Continue", "information" }, \
! 169: { 101, "Switching Protocols", "information" }, \
! 170: { 200, "OK", "success" }, \
! 171: { 201, "Created", "success" }, \
! 172: { 202, "Accepted", "success" }, \
! 173: { 203, "Non-authoritative Information", "success" }, \
! 174: { 204, "No Content", "success" }, \
! 175: { 205, "Reset Content", "success" }, \
! 176: { 206, "Partial Content", "success" }, \
! 177: { 300, "Multiple Choices", "redirection" }, \
! 178: { 301, "Moved Permanently", "redirection" }, \
! 179: { 302, "Moved Temporarily", "redirection" }, \
! 180: { 303, "See Other", "redirection" }, \
! 181: { 304, "Not Modified", "redirection" }, \
! 182: { 305, "Use Proxy", "redirection" }, \
! 183: { 400, "Bad Request", "client_error" }, \
! 184: { 401, "Unauthorized", "client_error" }, \
! 185: { 402, "Payment Required", "client_error" }, \
! 186: { 403, "Forbidden", "client_error" }, \
! 187: { 404, "Not Found", "client_error" }, \
! 188: { 405, "Method Not Allowed", "client_error" }, \
! 189: { 406, "Not Acceptable", "client_error" }, \
! 190: { 407, "Proxy Authentication Required", "client_error" }, \
! 191: { 408, "Request Timeout", "client_error" }, \
! 192: { 409, "Conflict", "client_error" }, \
! 193: { 410, "Gone", "client_error" }, \
! 194: { 411, "Length Required", "client_error" }, \
! 195: { 412, "Precondition Failed", "client_error" }, \
! 196: { 413, "Request Entity Too Large", "client_error" }, \
! 197: { 414, "Request-URI Too Large", "client_error" }, \
! 198: { 415, "Unsupported Media Type", "client_error" }, \
! 199: { 500, "Internal Server Error", "server_error" }, \
! 200: { 501, "Not Implemented", "server_error" }, \
! 201: { 502, "Bad Gateway", "server_error" }, \
! 202: { 503, "Service Unavailable", "server_error" }, \
! 203: { 504, "Gateway Timeout", "server_error" }, \
! 204: { 505, "HTTP Version not supported", "server_error" }, \
! 205: \
! 206: /* Cache Warnings */ \
! 207: { 10, "Response is Stale", "cache" }, \
! 208: { 11, "Revalidation Failed", "cache" }, \
! 209: { 12, "Disconnected Opeartion", "cache" }, \
! 210: { 13, "Heuristic Expiration", "cache" }, \
! 211: { 14, "Transformation Applied", "cache" }, \
! 212: { 99, "Cache warning", "cache" }, \
! 213: \
! 214: /* Non-HTTP Error codes and warnings */ \
! 215: { 0, "Can't locate remote host", "internal" }, \
! 216: { 0, "No host name found", "internal" }, \
! 217: { 0, "No file name found or file not accessible", "internal" }, \
! 218: { 0, "FTP-server replies", "internal" }, \
! 219: { 0, "FTP-server doesn't reply", "internal" }, \
! 220: { 0, "Server timed out", "internal" }, \
! 221: { 0, "Gopher-server replies", "internal" }, \
! 222: { 0, "Data transfer interrupted", "internal" }, \
! 223: { 0, "Connection establishment interrupted", "internal" }, \
! 224: { 0, "CSO-server replies", "internal" }, \
! 225: { 0, "This is probably a HTTP server 0.9 or less","internal" }, \
! 226: { 0, "Bad, Incomplete, or Unknown Response", "internal" }, \
! 227: { 0, "Unknown access authentication scheme", "internal" }, \
! 228: { 0, "News-server replies", "internal" }, \
! 229: { 0, "Trying `ftp://' instead of `file://'", "internal" }, \
! 230: { 0, "Too many redirections", "internal" }, \
! 231: { 0, "Method not suited for automatic redirection","internal" }, \
! 232: { 0, "Premature End Of File", "internal" }, \
! 233: { 0, "Response from WAIS Server too Large - Extra lines \
! 234: ignored","internal"}, \
! 235: { 0, "WAIS-server doesn't return any data", "internal" }, \
! 236: { 0, "Can't connect to WAIS-server", "internal" }, \
! 237: { 0, "System replies", "internal" }, \
! 238: { 0, "Wrong or unknown access scheme", "internal" }, \
! 239: { 0, "Access scheme not allowed in this context", "internal" }, \
! 240: { 0, "When you are connected, you can log in", "internal" }, \
! 241: { 0, "This version has expired and will be automatically reloaded", "internal" }
! 242:
2.37 frystyk 243: extern HTErrorShow HTError_show (void);
244: extern BOOL HTError_setShow (HTErrorShow mask);
245: </PRE>
246: <H2>
247: Creation and Deletion Methods
248: </H2>
249: <H3>
250: Add an Error
251: </H3>
252: <P>
253: Add an error message to the error list. `par' and `where' might be set to
254: NULL. If par is a string, it is sufficient to let length be unspecified,
255: i.e., 0. If only a part of the string is wanted then specify a length inferior
256: to strlen((char *) par). The string is '\0' terminated automaticly. See also
257: HTError_addSystem for system errors. Returns YES if OK, else NO.
2.30 frystyk 258: <PRE>
259: extern BOOL HTError_add (HTList * list,
260: HTSeverity severity,
261: BOOL ignore,
262: int element,
263: void * par,
264: unsigned int length,
265: char * where);
266:
267: </PRE>
2.37 frystyk 268: <H3>
269: Add a System Error
270: </H3>
271: <P>
272: Add a system error message to the error list. syscall is the name of the
273: system call, e.g. "close". The message put to the list is that corresponds
274: to the error number passed. See also HTError_add. Returns YES if OK, else
275: NO.
2.30 frystyk 276: <PRE>
277: extern BOOL HTError_addSystem (HTList * list,
278: HTSeverity severity,
279: int errornumber,
280: BOOL ignore,
281: char * syscall);
282: </PRE>
2.37 frystyk 283: <H3>
284: Delete an Entire Error Stack
285: </H3>
286: <P>
2.30 frystyk 287: Deletes all errors in a list.
288: <PRE>
289: extern BOOL HTError_deleteAll (HTList * list);
2.1 frystyk 290: </PRE>
2.37 frystyk 291: <H3>
292: Deletes the Last Edded Entry
293: </H3>
294: <P>
2.30 frystyk 295: Deletes the last error entry added to the list. Return YES if OK, else NO
296: <PRE>
297: extern BOOL HTError_deleteLast (HTList * list);
298: </PRE>
2.37 frystyk 299: <H2>
2.40 frystyk 300: Object Methods
2.37 frystyk 301: </H2>
302: <H3>
303: Show the Error Entry?
304: </H3>
305: <P>
2.30 frystyk 306: Should we show this entry in the list or just continue to the next one?
2.1 frystyk 307: <PRE>
2.30 frystyk 308: extern BOOL HTError_doShow (HTError * info);
2.1 frystyk 309: </PRE>
2.37 frystyk 310: <H3>
311: Ignore last Added Error
312: </H3>
313: <P>
314: Turns on the `ignore' flag for the most recent error entered the error list.
315: Returns YES if OK else NO
2.1 frystyk 316: <PRE>
2.30 frystyk 317: extern BOOL HTError_ignoreLast (HTList * list);
318: extern BOOL HTError_setIgnore (HTError * info);
2.2 frystyk 319: </PRE>
2.37 frystyk 320: <H3>
321: Error Index Number
322: </H3>
323: <P>
324: Each error object is assigned an index number as defined by the
325: <CODE>HTErrorElement</CODE> above. The mapping from this index to an error
326: code and a message must be done by the application. The Library provides
327: a default implementation in the <A HREF="HTDialog.html"> HTDialog module</A>,
328: but that can of course be changed depending on the application.
2.15 frystyk 329: <PRE>
2.31 frystyk 330: extern int HTError_index (HTError * info);
2.37 frystyk 331: </PRE>
332: <H3>
333: Error Severity
334: </H3>
2.40 frystyk 335: <P>
336: This function returns the severity of the error object passed by the caller
337: <PRE>extern HTSeverity HTError_severity (HTError * info);
338: </PRE>
339: <P>
340: You can ask whether a list of errors contains any error object with a severity
341: level which is higher than the one specifed.
342: <PRE>extern BOOL HTError_hasSeverity (HTList * list, HTSeverity severity);
2.37 frystyk 343: </PRE>
344: <H3>
345: Parameters Asscotiated with Error
346: </H3>
347: <PRE>
2.30 frystyk 348: extern void * HTError_parameter (HTError * info, int * length);
2.37 frystyk 349: </PRE>
350: <H3>
351: Where did it happen?
352: </H3>
353: <PRE>
2.34 frystyk 354: extern const char * HTError_location (HTError * info);
2.1 frystyk 355: </PRE>
356: <PRE>
357: #endif
358: </PRE>
2.37 frystyk 359: <P>
360: <HR>
2.36 frystyk 361: <ADDRESS>
2.42 ! eric 362: @(#) $Id: HTError.html,v 2.41 1996/08/24 18:09:52 frystyk Exp $
2.36 frystyk 363: </ADDRESS>
2.37 frystyk 364: </BODY></HTML>
Webmaster