class HCHttpRequest

HTTP Request/Response class

Public Methods

const char* GetResponseMessage( int iCode )

This function make reponse message for response code

HCHttpRequest()

Constructor - initialize internal variables

~HCHttpRequest()

Destructor

void SetMethod( int iMethod )

set HTTP method

int ParseRequest(char* pszRequest, int iRequestLen, int* piParseLen, int iFlags )

parse HTTP Request.

char* MakeRequest( char* pszInput )

make HTTP Protocol to string

int GetRequestSize()

calculate HTTP request's size

const char* GetMethod()

return HTTP.

int GetMethodInt()

return integer value for HTTP method.

const char* GetUri()

return Uri string

const char* GetHostName()

return attribute value of HOST.

int GetResponseCode()

return response code

char GetProtocol()

return code for HTTP protocol version

const char* GetIp()

return domain address or IP address of HTTP server

int GetPort()

return port number of HTTP server.

AttrMap* GetAttrMap()

return pointer of Attribute Map

int DeleteAllAttrMap()

delete all item of attribute map.

const char* GetAttributeValue( const char* szKey )

return attribute value of attribute.

int GetContentLength( )

return length of body.

int IsChunk()

Is using chunk option?

int IsConnectionClose()

close connection?

int IsConnectionKeepAlive()

is continuing connection?

void Clear( int fisDeleteAttribute )

Initialize internal variables.

int ParseUri( const char* szUri, string & strHostName, int & iPort )

parse uri to host name and port

void ArrangeAttribute()

Store cost to spend often to reduce attribute retrieval time in other internal variable or establish to flag

void ProcessAttribute( string & strKey, string & strValue )

covert special attribute value to lower case string.

int SetAttributeValue( const char* szKey, const char* szValue )

modify value of attribute in attribute map.

int AddAttributeValue( const char* szKey, const char* szValue )

add attribute to attribute map.

void SetContentLength( int iLength )

set length of body.

Documentation

HTTP Request/Response class

contain data of HTTP Request Header in internal variable and parse and make HTTP Request data

const char* GetResponseMessage( int iCode )

This function make reponse message for response code

Parameters:

iCode - response code

Returns:

returns pointer of reponse message string.

HCHttpRequest()

Constructor - initialize internal variables

~HCHttpRequest()

Destructor

void SetMethod( int iMethod )

set HTTP method

Parameters:

iMethod - HTTP method ( HC_HTTP_GET, HC_HTTP_POST )

int ParseRequest(char* pszRequest, int iRequestLen, int* piParseLen, int iFlags )

parse HTTP Request.

Parameters:

pszRequest - HTTP request string
iRequestLen - pszRequest length
piParseLen - [out] Variable to store construed position

Returns:

if it success, it returns HC_OK. if there needs more Request data, it returns HC_MORE_REQUEST. if it failed, it returns HC_ERROR.

char* MakeRequest( char* pszInput )

make HTTP Protocol to string

[note] if you do not insert pszInput variable, you must delete pointer of this function's return.

Parameters:

pszInput - [out] buffer for http protocol request string

Returns:

if it is successes, it returns HTTP Protocol Request string. otherwise it returns NULL.

int GetRequestSize()

calculate HTTP request's size

Returns:

if there is no error, it returns request header size. otherwise it returns HC_ERROR.

const char* GetMethod()

return HTTP.

Returns:

HTTP method string

int GetMethodInt()

return integer value for HTTP method.

Returns:

integer value for HTTP method

const char* GetUri()

return Uri string

Returns:

uri string like "http://www.enpia.net/cgi-bin/test.cgi"

const char* GetHostName()

return attribute value of HOST.

Returns:

attribute value of HOST

int GetResponseCode()

return response code

Returns:

response code

char GetProtocol()

return code for HTTP protocol version

Returns:

protocol verison ( HC_HTTP_VERSION_0_9, HC_HTTP_VERSION_1_0, HC_HTTP_VERSION_1_1 )

const char* GetIp()

return domain address or IP address of HTTP server

Returns:

domain address or IP address of HTTP server

int GetPort()

return port number of HTTP server.

Returns:

port number of HTTP server

AttrMap* GetAttrMap()

return pointer of Attribute Map

Returns:

attribute map's pointer

int DeleteAllAttrMap()

delete all item of attribute map.

Returns:

HC_OK.

const char* GetAttributeValue( const char* szKey )

return attribute value of attribute.

Parameters:

szKey - attribute name

Returns:

attribute value

int GetContentLength( )

return length of body.

Returns:

body length

int IsChunk()

Is using chunk option?

Returns:

if use chunk option, return HC_OK. otherwise return HC_ERROR.

int IsConnectionClose()

close connection?

Returns:

if close connection, return HC_OK. otherwise return HC_ERROR.

int IsConnectionKeepAlive()

is continuing connection?

Returns:

if continue connection, return HC_OK. otherwise return HC_ERROR.

void Clear( int fisDeleteAttribute )

Initialize internal variables.

Parameters:

fisDeleteAttribute - if set 1, delete attribute list.

int ParseUri( const char* szUri, string & strHostName, int & iPort )

parse uri to host name and port

Parameters:

szUri - [in] Uri ex) http://www.enpia.net, www.enpia.net, http://www.enpia.net:8080/
strHostName - [out] Host Name
iPort - [out] port number

Returns:

if success, return HC_OK. otherwise return HC_ERROR.

void ArrangeAttribute()

Store cost to spend often to reduce attribute retrieval time in other internal variable or establish to flag

void ProcessAttribute( string & strKey, string & strValue )

covert special attribute value to lower case string.

Parameters:

strKey - attribute key string
strValue - attribute value string

int SetAttributeValue( const char* szKey, const char* szValue )

modify value of attribute in attribute map.

Parameters:

szKey - attribute key
szValue - attribute value

Returns:

if success, return HC_OK. otherwise return HC_ERROR.

int AddAttributeValue( const char* szKey, const char* szValue )

add attribute to attribute map.

Parameters:

szKey - attribute key
szValue - attribute value

Returns:

if success, return HC_OK. otherwise return HC_ERROR.

void SetContentLength( int iLength )

set length of body.

Parameters:

iLength - content-length

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java