#include <http.h>
Inheritance diagram for PHTTPServer:
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 PFalse. This will then call the appropriate virtual function on parsing the POP3 protocol.
| 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 | ) |
| urlSpace | Name space to use for URLs received. |
| virtual PString PHTTPServer::GetServerName | ( | ) | const [virtual] |
Get the name of the server.
| PHTTPSpace& PHTTPServer::GetURLSpace | ( | ) | [inline] |
Get the name space being used by the HTTP server socket.
| void PHTTPServer::SetURLSpace | ( | const PHTTPSpace & | space | ) |
Use a new URL name space for this HTTP socket.
| space | New URL name space to use. |
| virtual PBoolean PHTTPServer::ProcessCommand | ( | ) | [virtual] |
Process commands, dispatching to the appropriate virtual function. This is used when the socket is acting as a server.
| virtual PBoolean 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.
| url | Universal Resource Locator for document. |
| info | Extra MIME information in command. |
| conInfo | HTTP connection information |
| virtual PBoolean 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.
| url | Universal Resource Locator for document. |
| info | Extra MIME information in command. |
| conInfo | HTTP connection information |
| virtual PBoolean 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.
| url | Universal Resource Locator for document. |
| info | Extra MIME information in command. |
| data | Variables provided in the POST data. |
| conInfo | HTTP connection information |
| virtual PBoolean 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).
| conInfo | HTTP connection information |
| virtual PString PHTTPServer::ReadEntityBody | ( | ) | [virtual] |
Read the entity body associated with a HTTP request, and close the socket if not a persistant connection.
| virtual PBoolean PHTTPServer::OnUnknown | ( | const PCaselessString & | command, | |
| const PHTTPConnectionInfo & | connectInfo | |||
| ) | [virtual] |
Handle an unknown command.
| command | Complete command line received. |
| connectInfo | HTTP connection information |
| PBoolean 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.
| code | Status code for the response. |
| headers | MIME variables included in response. |
| bodySize | Size of the rest of the response. |
| virtual PBoolean 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.
| code | Status code for the error response. |
| extra | Extra information included in the response. |
| connectInfo | HTTP connection information |
| void PHTTPServer::SetDefaultMIMEInfo | ( | PMIMEInfo & | info, | |
| const PHTTPConnectionInfo & | connectInfo | |||
| ) |
Set the default mime info
| info | Extra MIME information in command. |
| PHTTPConnectionInfo& PHTTPServer::GetConnectionInfo | ( | ) | [inline] |
Get the connection info for this connection.
| void PHTTPServer::Construct | ( | ) | [protected] |
Reimplemented from PChannel.
PHTTPSpace PHTTPServer::urlSpace [protected] |
PHTTPConnectionInfo PHTTPServer::connectInfo [protected] |
unsigned PHTTPServer::transactionCount [protected] |
PTimeInterval PHTTPServer::nextTimeout [protected] |
1.5.1