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