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