NetBurner 3.5.0
PDF Version
 
HtmlPageHandler Class Referenceabstract

Base class for all GET handlers. To handle GET requests for a specific URL in your application, build a GET handler object for that specifif URL. A NULL name will be a catch all for all GET requests. More...

#include <http.h>

Inherited by AcmeAuthItem, CallBackFunctionPageHandler, CallBackWSEndPoint, HtmlConfigExposer, and HtmlPostHandler.

Public Member Functions

 HtmlPageHandler (const char *url, HTTP_RequestTypes rt=tGet, int accessGroup=0, bool Before_Files=false)
 Register handler.
 
virtual int ProcessRaw (int sock, HTTP_Request &pd)=0
 This class will do a callback with data for each request to the specified url.
 
int GetGroup ()
 Returns access group setting.
 

Protected Member Functions

void InsertSort (HtmlPageHandler *&ph)
 Insert sort.
 
int SortValue (HtmlPageHandler *pv)
 Returns the value of the sort compare: -1, 0, 1.
 

Protected Attributes

HtmlPageHandlerm_pNextHandler
 Pointer to next page handle object.
 
const char * m_pUrlName
 Pointer to URL. Performs a length match, an empty string matches everything.
 
int m_access_group
 The access group for this request see CheckHttpAccess.
 
HTTP_RequestTypes m_requestTypes
 Type of request, HTTP_RequestTypes.
 

Detailed Description

Base class for all GET handlers. To handle GET requests for a specific URL in your application, build a GET handler object for that specifif URL. A NULL name will be a catch all for all GET requests.

Constructor & Destructor Documentation

◆ HtmlPageHandler()

HtmlPageHandler::HtmlPageHandler ( const char * url,
HTTP_RequestTypes rt = tGet,
int accessGroup = 0,
bool Before_Files = false )

Register handler.

Parameters
urlThe URL name to register. A NULL string matches everything
rtThe GET request type to respond to
accessGroupAccess group of the URL
Before_FilesSpecify if the response should be before or after the compiled in HTML files

Member Function Documentation

◆ GetGroup()

int HtmlPageHandler::GetGroup ( )
inline

Returns access group setting.

Returns
HTTP_ACCESS

◆ ProcessRaw()

virtual int HtmlPageHandler::ProcessRaw ( int sock,
HTTP_Request & pd )
pure virtual

This class will do a callback with data for each request to the specified url.

Returns
0 if the request was not processed.

Implemented in CallBackFunctionPageHandler, and CallBackFunctionPostHandler.


The documentation for this class was generated from the following file: