Annotation of Amaya/amaya/libwww.h, revision 1.30
1.1 cvs 1: /*
2: *
3: * (c) COPYRIGHT MIT and INRIA, 1996.
4: * Please first read the full copyright statement in file COPYRIGHT.
5: *
6: */
7:
8: #ifndef AMAYA_LIBWWW_H
9: #define AMAYA_LIBWWW_H
10:
1.15 cvs 11: /***********
12: Things to put in sysdep.h???
13: **********/
14: /*typedef u_long SockOps; */
15: #ifndef _WINSOCKAPI_
16: #define FD_READ 0x01
17: #define FD_WRITE 0x02
18: #define FD_OOB 0x04
19: #define FD_ACCEPT 0x08
20: #define FD_CONNECT 0x10
21: #define FD_CLOSE 0x20
22: #endif /* _WINSOCKAPI_ */
23: typedef unsigned long ms_t;
24: /************/
1.6 cvs 25:
1.1 cvs 26: #include "WWWLib.h"
1.22 cvs 27: #include "AHTInit.h"
1.1 cvs 28: #include "WWWApp.h"
29: #include "WWWHTTP.h"
30: #include "HTReqMan.h"
31: #include "HTReq.h"
32: #include "HTAncMan.h"
33: #include "HTAccess.h"
34: #include "HTAlert.h"
35: #include "HTNetMan.h"
36: #include "HTBInit.h"
37: #include "WWWHTTP.h" /* HTTP access module */
38: #include "HTProxy.h"
1.9 cvs 39: #include "HTHost.h"
40:
1.1 cvs 41: typedef struct _AHTDocIdStatus
42: {
43: int docid; /* a docid */
44: int counter; /* number of open requests associated with dicid */
45: }
46: AHTDocId_Status;
47:
48:
49: typedef struct __AmayaContext
50: {
51: HTList *reqlist; /* List of current requests */
52: HTList *docid_status; /* Status for each active docid */
1.15 cvs 53: int open_requests; /* number of open requests */
1.1 cvs 54: }
55: AmayaContext;
56:
57: /* the possible states for a request */
58:
59: typedef enum _AHTReqStatus
60: {
61: HT_NEW = 0, /* new request */
62: HT_NEW_PENDING = 1, /* new request, waiting for a socket */
63: HT_WAITING = 2, /* active request, waiting for socket events */
64: HT_BUSY = 4, /* the request is currently being processed */
65: HT_END = 8, /* the request has ended */
66: HT_ABORT = 16, /* user aborted the request */
1.15 cvs 67: HT_CACHE = 32,
68: HT_ERR = 64 /* an error happened during the request */
1.1 cvs 69: }
70: AHTReqStatus;
71:
72: typedef struct _AHTReqContext
73: {
1.18 cvs 74: HTRequest *request; /* Pointer to the associated request object */
75: HTParentAnchor *anchor;
1.24 cvs 76: HTMethod method; /* What method are we invoking */
1.18 cvs 77: int docid; /* docid to which this request belongs */
78: AHTReqStatus reqStatus; /* status of the request */
1.19 cvs 79: HTEventType read_type; /* The type operation which must be used during
1.18 cvs 80: ** an Xt read callback */
1.24 cvs 81: char *default_put_name; /* @@what's the def name? */
82:
1.19 cvs 83: HTEventType write_type; /* The type operation which must be used during
1.18 cvs 84: ** an Xt write callback */
85:
1.19 cvs 86: HTEventType except_type; /* The type operation which must be used during
87: ** an Xt exception callback */
1.18 cvs 88:
1.1 cvs 89: #ifdef WWW_XWINDOWS
1.18 cvs 90: XtInputId read_xtinput_id; /* The read xt event id assocciated with
1.1 cvs 91: the request */
1.18 cvs 92: XtInputId write_xtinput_id; /* The write xt event id assocciated with
1.1 cvs 93: the request */
1.18 cvs 94: XtInputId except_xtinput_id; /* The except xt event id assocciated with
1.1 cvs 95: the request */
96: #endif /* WWW_XWINDOWS */
1.18 cvs 97:
1.1 cvs 98: /*** Experimental ****/
1.18 cvs 99: SOCKET read_sock; /* read socket associated with the request */
100: SOCKET write_sock; /* write socket associated with the request */
101: SOCKET except_sock; /* except socket associated with the request */
1.1 cvs 102: /*** End of experimental stuff ****/
1.18 cvs 103:
1.30 ! cvs 104: char* outputfile; /* file to receive incoming data */
1.19 cvs 105: FILE *output; /* file pointer to outputfile */
1.26 cvs 106: int mode; /* Mode of request: SYNC/ASYNC/IASYNC/FORM POST/FORM GET */
1.30 ! cvs 107: char* urlName; /* url to retrieve/or that was retrieved */
! 108: char status_urlName [MAX_LENGTH]; /* url name to be displayed on the status bar */
1.18 cvs 109: TIcbf *incremental_cbf; /* For IASYNC mode, @ of callback function */
110: /* It'll be called each time a new data package */
111: /* is received */
112: void *context_icbf; /* Context for the above cbf */
113: TTcbf *terminate_cbf; /* optional CBF which will be invoked after */
114: /* a file has been received */
115: void *context_tcbf; /* Context for the above cbf */
116:
1.28 cvs 117: /* the following structure holds a copy of the
118: HTTP headers that the application is interested in */
119: AHTHeaders http_headers;
1.10 cvs 120:
1.18 cvs 121: /* The following elements are used for the PUT and POST */
1.19 cvs 122: HTAnchor *source;
123: HTAnchor *dest; /* Destination for PUT etc. */
124: unsigned long block_size; /* size in bytes of the file to put */
125: int put_counter; /* number of bytes already put */
1.15 cvs 126: HTAssocList *formdata; /* ptr to a struct containing the formdata used with POST */
127:
1.23 cvs 128: char* error_stream; /* pointer to an error message associated with the
1.19 cvs 129: request */
130: int error_stream_size; /* size of the above message */
1.21 cvs 131: ThotBool error_html; /* If TRUE, means the applications wants to display
1.19 cvs 132: error_stream. If false, error_stream is not
133: displayed at all */
1.25 cvs 134: char *document;
1.1 cvs 135: }
136: AHTReqContext;
137:
1.29 kahan 138: /*
139: ** the HTTP error messages
140: */
141: /* an interpreted version of the error */
1.30 ! cvs 142: THOT_EXPORT char AmayaLastHTTPErrorMsg [MAX_LENGTH];
1.29 kahan 143: /* the reason string sent by the server */
1.30 ! cvs 144: THOT_EXPORT char AmayaLastHTTPErrorMsgR [MAX_LENGTH];
1.1 cvs 145: THOT_EXPORT HTList *conv; /* List of global converters */
146: THOT_EXPORT AmayaContext *Amaya; /* Amaya's request global context */
147: #endif /* AMAYA_LIBWWW_H */
1.15 cvs 148:
Webmaster