Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

PHTTPServer Class Reference

#include <http.h>

Inheritance diagram for PHTTPServer:

PHTTP PInternetProtocol PIndirectChannel PChannel PObject List of all members.

Public Member Functions

 PHTTPServer ()
 PHTTPServer (const PHTTPSpace &urlSpace)
virtual PString GetServerName () const
PHTTPSpaceGetURLSpace ()
void SetURLSpace (const PHTTPSpace &space)
 Use a new URL name space for this HTTP socket.

virtual BOOL ProcessCommand ()
virtual BOOL OnGET (const PURL &url, const PMIMEInfo &info, const PHTTPConnectionInfo &conInfo)
virtual BOOL OnHEAD (const PURL &url, const PMIMEInfo &info, const PHTTPConnectionInfo &conInfo)
virtual BOOL OnPOST (const PURL &url, const PMIMEInfo &info, const PStringToString &data, const PHTTPConnectionInfo &conInfo)
virtual BOOL OnProxy (const PHTTPConnectionInfo &conInfo)
virtual PString ReadEntityBody ()
virtual BOOL OnUnknown (const PCaselessString &command, const PHTTPConnectionInfo &connectInfo)
BOOL StartResponse (StatusCode code, PMIMEInfo &headers, long bodySize)
virtual BOOL OnError (StatusCode code, const PCaselessString &extra, const PHTTPConnectionInfo &connectInfo)
void SetDefaultMIMEInfo (PMIMEInfo &info, const PHTTPConnectionInfo &connectInfo)
PHTTPConnectionInfoGetConnectionInfo ()

Protected Member Functions

void Construct ()

Protected Attributes

PHTTPSpace urlSpace
PHTTPConnectionInfo connectInfo
unsigned transactionCount
PTimeInterval nextTimeout

Detailed Description

A TCP/IP socket for the HyperText Transfer Protocol version 1.0.

When acting as a server, a descendant class would be created to override at least the #HandleOpenMailbox()#, #HandleSendMessage()# and #HandleDeleteMessage()# functions. Other functions may be overridden for further enhancement to the sockets capabilities, but these will give a basic POP3 server functionality.

The server socket thread would continuously call the #ProcessMessage()# function until it returns FALSE. This will then call the appropriate virtual function on parsing the POP3 protocol.


Constructor & Destructor Documentation

PHTTPServer::PHTTPServer  ) 
 

Create a TCP/IP HTTP protocol socket channel. The form with the single port parameter creates an unopened socket, the form with the address parameter makes a connection to a remote system, opening the socket. The form with the socket parameter opens the socket to an incoming call from a "listening" socket.

PHTTPServer::PHTTPServer const PHTTPSpace urlSpace  ) 
 


Member Function Documentation

void PHTTPServer::Construct  )  [protected]
 

Reimplemented from PChannel.

PHTTPConnectionInfo& PHTTPServer::GetConnectionInfo  )  [inline]
 

Get the connection info for this connection.

virtual PString PHTTPServer::GetServerName  )  const [virtual]
 

Get the name of the server.

Returns:
String name of the server.

PHTTPSpace& PHTTPServer::GetURLSpace  )  [inline]
 

Get the name space being used by the HTTP server socket.

Returns:
URL name space tree.

virtual BOOL PHTTPServer::OnError StatusCode  code,
const PCaselessString extra,
const PHTTPConnectionInfo connectInfo
[virtual]
 

Write an error response for the specified code.

Depending on the code parameter this function will also send a HTML version of the status code for display on the remote client viewer.

Returns:
TRUE if the connection may persist, FALSE if the connection must close

virtual BOOL PHTTPServer::OnGET const PURL url,
const PMIMEInfo info,
const PHTTPConnectionInfo conInfo
[virtual]
 

Handle a GET command from a client.

The default implementation looks up the URL in the name space declared by the PHTTPSpace# class tree and despatches to the PHTTPResource# object contained therein.

Returns:
TRUE if the connection may persist, FALSE if the connection must close If there is no ContentLength field in the response, this value must be FALSE for correct operation.

virtual BOOL PHTTPServer::OnHEAD const PURL url,
const PMIMEInfo info,
const PHTTPConnectionInfo conInfo
[virtual]
 

Handle a HEAD command from a client.

The default implemetation looks up the URL in the name space declared by the PHTTPSpace# class tree and despatches to the PHTTPResource# object contained therein.

Returns:
TRUE if the connection may persist, FALSE if the connection must close If there is no ContentLength field in the response, this value must be FALSE for correct operation.

virtual BOOL PHTTPServer::OnPOST const PURL url,
const PMIMEInfo info,
const PStringToString data,
const PHTTPConnectionInfo conInfo
[virtual]
 

Handle a POST command from a client.

The default implementation looks up the URL in the name space declared by the PHTTPSpace# class tree and despatches to the PHTTPResource# object contained therein.

Returns:
TRUE if the connection may persist, FALSE if the connection must close If there is no ContentLength field in the response, this value must be FALSE for correct operation.

virtual BOOL PHTTPServer::OnProxy const PHTTPConnectionInfo conInfo  )  [virtual]
 

Handle a proxy command request from a client. This will only get called if the request was not for this particular server. If it was a proxy request for this server (host and port number) then the appropriate #OnGET()#, #OnHEAD()# or #OnPOST()# command is called.

The default implementation returns OnError(BadGateway).

Returns:
TRUE if the connection may persist, FALSE if the connection must close If there is no ContentLength field in the response, this value must be FALSE for correct operation.

virtual BOOL PHTTPServer::OnUnknown const PCaselessString command,
const PHTTPConnectionInfo connectInfo
[virtual]
 

Handle an unknown command.

Returns:
TRUE if the connection may persist, FALSE if the connection must close

virtual BOOL PHTTPServer::ProcessCommand  )  [virtual]
 

Process commands, dispatching to the appropriate virtual function. This is used when the socket is acting as a server.

Returns:
TRUE if the request specified persistant mode and the request version allows it, FALSE if the socket closed, timed out, the protocol does not allow persistant mode, or the client did not request it timed out

virtual PString PHTTPServer::ReadEntityBody  )  [virtual]
 

Read the entity body associated with a HTTP request, and close the socket if not a persistant connection.

Returns:
The entity body of the command

void PHTTPServer::SetDefaultMIMEInfo PMIMEInfo info,
const PHTTPConnectionInfo connectInfo
 

Set the default mime info

void PHTTPServer::SetURLSpace const PHTTPSpace space  ) 
 

Use a new URL name space for this HTTP socket.

BOOL PHTTPServer::StartResponse StatusCode  code,
PMIMEInfo headers,
long  bodySize
 

Write a command reply back to the client, and construct some of the outgoing MIME fields. The MIME fields are not sent.

The bodySize parameter determines the size of the entity body associated with the response. If bodySize is >= 0, then a ContentLength field will be added to the outgoing MIME headers if one does not already exist.

If bodySize is < 0, then it is assumed that the size of the entity body is unknown, or has already been added, and no ContentLength field will be constructed.

If the version of the request is less than 1.0, then this function does nothing.

Returns:
TRUE if requires v1.1 chunked transfer encoding.


Member Data Documentation

PHTTPConnectionInfo PHTTPServer::connectInfo [protected]
 

PTimeInterval PHTTPServer::nextTimeout [protected]
 

unsigned PHTTPServer::transactionCount [protected]
 

PHTTPSpace PHTTPServer::urlSpace [protected]
 


The documentation for this class was generated from the following file:
Generated on Sat Jul 24 15:35:58 2004 for PWLib by doxygen 1.3.7