httpserverapi Class Reference

#include <httpserverapi.h>

Inherits input, and output.

Inherited by apachehttpserverapi, and cgihttpserverapi.

Public Member Functions
virtual const char *	getType ()=0
Public Member Functions inherited from input
	input ()
virtual	~input ()
virtual off64_t	setPositionRelativeToBeginning (off64_t offset)
virtual off64_t	setPositionRelativeToCurrent (off64_t offset)
virtual off64_t	setPositionRelativeToEnd (off64_t offset)
virtual off64_t	getPosition ()
virtual ssize_t	read (byte_t *buffer, size_t size)=0
virtual ssize_t	read (char *buffer, size_t length)=0
virtual ssize_t	read (char *buffer)=0
virtual ssize_t	read (wchar_t *buffer, size_t length)=0
virtual ssize_t	read (wchar_t *buffer)=0
virtual ssize_t	readUcs2 (ucs2_t *buffer, size_t length)=0
virtual ssize_t	readUcs2 (ucs2_t *buffer)=0
virtual ssize_t	read (int16_t *buffer)=0
virtual ssize_t	read (int32_t *buffer)=0
virtual ssize_t	read (int64_t *buffer)=0
virtual ssize_t	read (byte_t *buffer)=0
virtual ssize_t	read (uint16_t *buffer)=0
virtual ssize_t	read (uint32_t *buffer)=0
virtual ssize_t	read (uint64_t *buffer)=0
virtual ssize_t	read (float *buffer)=0
virtual ssize_t	read (double *buffer)=0
ssize_t	read (char **buffer, const char *terminator)
ssize_t	read (char **buffer, const char *terminator, size_t maxbytes)
virtual ssize_t	read (byte_t *buffer, size_t size, int32_t sec, int32_t usec)
virtual ssize_t	read (char *buffer, size_t length, int32_t sec, int32_t usec)
virtual ssize_t	read (char *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (wchar_t *buffer, size_t length, int32_t sec, int32_t usec)
virtual ssize_t	read (wchar_t *buffer, int32_t sec, int32_t usec)
virtual ssize_t	readUcs2 (ucs2_t *buffer, size_t length, int32_t sec, int32_t usec)
virtual ssize_t	readUcs2 (ucs2_t *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (int16_t *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (int32_t *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (int64_t *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (byte_t *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (uint16_t *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (uint32_t *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (uint64_t *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (float *buffer, int32_t sec, int32_t usec)
virtual ssize_t	read (double *buffer, int32_t sec, int32_t usec)
ssize_t	read (char **buffer, const char *terminator, int32_t sec, int32_t usec)
ssize_t	read (char **buffer, const char *terminator, size_t maxbytes, int32_t sec, int32_t usec)
ssize_t	read (char **buffer, const char *terminator, size_t maxbytes, char escapechar, int32_t sec, int32_t usec)
Public Member Functions inherited from object
virtual	~object ()
Public Member Functions inherited from output
	output ()
virtual	~output ()
virtual off64_t	setPositionRelativeToBeginning (off64_t offset)
virtual off64_t	setPositionRelativeToCurrent (off64_t offset)
virtual off64_t	setPositionRelativeToEnd (off64_t offset)
virtual off64_t	getPosition ()
virtual ssize_t	write (const byte_t *string, size_t size)=0
virtual ssize_t	write (const char *string)=0
virtual ssize_t	write (const char *string, size_t length)=0
virtual ssize_t	write (char character)=0
virtual ssize_t	write (const wchar_t *string)=0
virtual ssize_t	write (const wchar_t *string, size_t length)=0
virtual ssize_t	write (wchar_t character)=0
virtual ssize_t	writeUcs2 (const ucs2_t *string)=0
virtual ssize_t	writeUcs2 (const ucs2_t *string, size_t length)=0
virtual ssize_t	writeUcs2 (ucs2_t character)=0
virtual ssize_t	write (int16_t number)=0
virtual ssize_t	write (int32_t number)=0
virtual ssize_t	write (int64_t number)=0
virtual ssize_t	write (byte_t character)=0
virtual ssize_t	write (uint16_t number)=0
virtual ssize_t	write (uint32_t number)=0
virtual ssize_t	write (uint64_t number)=0
virtual ssize_t	write (float number)=0
virtual ssize_t	write (double number)=0
virtual ssize_t	write (const byte_t *string, size_t size, int32_t sec, int32_t usec)
virtual ssize_t	write (const char *string, int32_t sec, int32_t usec)
virtual ssize_t	write (const char *string, size_t length, int32_t sec, int32_t usec)
virtual ssize_t	write (char character, int32_t sec, int32_t usec)
virtual ssize_t	write (const wchar_t *string, int32_t sec, int32_t usec)
virtual ssize_t	write (const wchar_t *string, size_t length, int32_t sec, int32_t usec)
virtual ssize_t	write (wchar_t character, int32_t sec, int32_t usec)
virtual ssize_t	writeUcs2 (const ucs2_t *string, int32_t sec, int32_t usec)
virtual ssize_t	writeUcs2 (const ucs2_t *string, size_t length, int32_t sec, int32_t usec)
virtual ssize_t	writeUcs2 (ucs2_t character, int32_t sec, int32_t usec)
virtual ssize_t	write (int16_t number, int32_t sec, int32_t usec)
virtual ssize_t	write (int32_t number, int32_t sec, int32_t usec)
virtual ssize_t	write (int64_t number, int32_t sec, int32_t usec)
virtual ssize_t	write (byte_t character, int32_t sec, int32_t usec)
virtual ssize_t	write (uint16_t number, int32_t sec, int32_t usec)
virtual ssize_t	write (uint32_t number, int32_t sec, int32_t usec)
virtual ssize_t	write (uint64_t number, int32_t sec, int32_t usec)
virtual ssize_t	write (float number, int32_t sec, int32_t usec)
virtual ssize_t	write (double number, int32_t sec, int32_t usec)
virtual ssize_t	printf (const char *format,...)
virtual ssize_t	printf (const char *format, va_list *argp)
virtual ssize_t	printf (const wchar_t *format,...)
virtual ssize_t	printf (const wchar_t *format, va_list *argp)
virtual ssize_t	printfUcs2 (const ucs2_t *format,...)
virtual ssize_t	printfUcs2 (const ucs2_t *format, va_list *argp)
void	safePrint (byte_t c)
void	safePrint (const byte_t *str)
void	safePrint (const byte_t *str, int32_t length)
void	safePrint (char c)
void	safePrint (const char *str)
void	safePrint (const char *str, int32_t length)
void	printBits (byte_t value)
void	printBits (uint16_t value)
void	printBits (uint32_t value)
void	printBits (uint64_t value)
void	printBits (char value)
void	printBits (int16_t value)
void	printBits (int32_t value)
void	printBits (int64_t value)
void	printBits (const byte_t *bits, uint64_t size)
void	printHex (const byte_t *data, uint64_t size)
void	printHex (const byte_t *data, uint64_t size, uint16_t indent)

Detailed Description

The httpserverapi class provides a base class for developing web based applications using http server APIs.

Note that this class and its parenet classes define an interface, and cannot be instantiated directly. Its children are also not intended to be instantiated directly.

Rather, an application should define one of HTTP_MODULE_CGI, HTTP_MODULE_APACHE, etc., include <rudiments/httpserverapimain.h>, and then implement the method httpModuleMain(httpserverapi *sapi) as the main body of the application. The methods of "sapi" can then be used directly.

Member Function Documentation

getType()

virtual const char * httpserverapi::getType ( )

pure virtual

Returns the type of httpserverapi, eg. "apache1", "apache2", "cgi", etc.

Implemented in apachehttpserverapi, and cgihttpserverapi.