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