Main Page   Data Structures   File List   Data Fields   Globals   Related Pages  

http.h File Reference

PDepp's http level module. More...

#include "common.h"
#include <time.h>
#include "buffer.h"
#include "conn_handler.h"

Include dependency graph for http.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Typedefs

typedef HttpProtHandler * HttpProtHandler
 the struct containing all necessary information (on http-level) for a connection.


Functions

int htModulePreInit ()
 pre-initialise module.

int htModuleTerminate ()
 clean up rssources allocated by module.

HttpProtHandler htInit (ConnHandler parent)
 creates, initializes and returns a Http Protokoll Handler. More...

int htReceive (HttpProtHandler this, struct Buffer buf)
 orders a ProtHandler to Recieve data. More...

int htSend (HttpProtHandler this, struct Buffer **buf)
 orders a ProtHandler to send buffered data. More...

int htProcess (HttpProtHandler this)
 gives the chance to do some internal job. More...

int htIsDataPending (HttpProtHandler this)
 checks if data is pending. More...

int htTerminate (HttpProtHandler this)
 terminates this. More...

int htGetError (HttpProtHandler this)
 returns the error of this. More...


Detailed Description

PDepp's http level module.

This Module contains necessary operations for internal data exchange on http-level.

Definition in file http.h.


Function Documentation

int htGetError HttpProtHandler    this
 

returns the error of this.

Parameters:
this  the struct to be manipulated
Returns:
error of this

HttpProtHandler htInit ConnHandler    parent
 

creates, initializes and returns a Http Protokoll Handler.

Parameters:
parent  Parent ie. caller
htInit just initialises some std. values and resets data

Returns:
an initialized HttpProtHandler

Referenced by chInit().

int htIsDataPending HttpProtHandler    this
 

checks if data is pending.

Parameters:
this  the struct containing data information
Returns:
true if data pending, else false

Referenced by forwardSendToProtHandler().

int htProcess HttpProtHandler    this
 

gives the chance to do some internal job.

Parameters:
this  the struct containing data information
gives this the chance to do some internal work. NOTHING IMPLEMENTED NOW

Returns:
0 on success, -1 on error (error of this is set to apropriate error)

Referenced by chProcess().

int htReceive HttpProtHandler    this,
struct Buffer    buf
 

orders a ProtHandler to Recieve data.

Parameters:
this  the struct to be manipulated
str  the string containing the data to be recieved
htRecieve has to be understood as htRecieve!, because it is a call to do so. The data to be recieved is a buffer, which will be processed and validated.

Returns:
0 on success, -1 if any error occured (error of this is set to concrete error)

Referenced by chReceive().

int htSend HttpProtHandler    this,
struct Buffer **    buf
 

orders a ProtHandler to send buffered data.

Parameters:
this  the struct containing data information
buf  the buffer (pnter), in which the data will be stored
htSend has to be understood as htSend!, because it is a call to do so. If data is waiting, it will be stored in buf, else (*buf)->data is set to NULL.

Returns:
0 on success, -1 on error (error of this is set to concrete error)

Referenced by forwardSendToProtHandler().

int htTerminate HttpProtHandler    this
 

terminates this.

Parameters:
this  the struct to be terminated
terminates this and frees all allocated memory used by this. Also calls underlying terminate functions

Returns:
0 on success, -1 on error (error of this is set to apropriate error)

Referenced by chTerminate().


Generated on Fri Jan 25 22:40:48 2002 for PDepp Webserver by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001