Annotation of Amaya/amaya/libwww.h, revision 1.45

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

Webmaster