Structure Reference PIX_REQUEST

#include "dinamo.h"

Data Fields
DWORD	dwVersion
DWORD	dwMethod
const char *	szURL
const char **	pszHeaderList
DWORD	dwHeaderCount
BYTE *	pbBody
DWORD	dwBodyLen
DWORD	dwTimeOut
DWORD	dwParam

Detailed description

Data from an HTTP request from PIX.

Note

The pointers in this structure are only borrowed: the library reads the content during the call and does not copy anything. Everything that szURL, pszHeaderList, and pbBody point to must remain valid until DPIXRequest() returns. In C++, be careful with expressions such as str().c_str() stored in the field: the temporary object is destroyed at the end of the statement, even before the call takes place.

This structure is used by the DPIXRequest() function.

Examples

pix_handle_no_cache.c, pix_handle_request.c, and pix_handle_stats.c.

Fields

dwVersion

DWORD dwVersion

Structure version. Must be PIX_REQUEST_VERSION.

Examples

pix_handle_no_cache.c, pix_handle_request.c, and pix_handle_stats.c.

dwMethod

DWORD dwMethod

HTTP method: PIX_HTTP_POST, PIX_HTTP_PUT, PIX_HTTP_GET, or PIX_HTTP_DELETE.

Examples

pix_handle_no_cache.c, pix_handle_request.c, and pix_handle_stats.c.

szURL

const char* szURL

Destination URL.

Examples

pix_handle_no_cache.c, pix_handle_request.c, and pix_handle_stats.c.

pszHeaderList

const char** pszHeaderList

Additional headers, one per element. NULL if none.

Examples

pix_handle_request.c.

dwHeaderCount

DWORD dwHeaderCount

Number of elements in pszHeaderList.

Examples

pix_handle_request.c.

pbBody

BYTE* pbBody

Request body. NULL if none. In PIX_HTTP_GET and PIX_HTTP_DELETE, a body is uncommon, but if one is provided, the library sends it.

Examples

pix_handle_request.c, pix, and _handle_stats.c.

dwBodyLen

DWORD dwBodyLen

Size of pbBody, in bytes.

Examples

pix_handle_request.c, pix, and _handle_stats.c.

dwTimeOut

DWORD dwTimeOut

Operation timeout duration in milliseconds. Set to zero to disable the timeout.

Examples

pix_handle_no_cache.c, pix_handle_request.c, and pix_handle_stats.c.

dwParam

DWORD dwParam

Request options: PIX_VERIFY_HOST_NAME, PIX_BASIC_HTTP_HEADER, PIX_GZIP.

Examples

pix_handle_request.c.

---

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

• dinamo.h