This documentation is archived and is not being maintained.

HTTP Client Reference 

In addition to providing the code for generating HTTP responses, ATL Server provides code in atlhttp.h for generating HTTP requests allowing lightweight HTTP clients with minimal dependencies to be written in C++.

Interfaces

IAuthInfo Class

This interface defines methods used to retrieve authentication credentials required for accessing protected URLs.

Classes

CAtlHttpClientT Class

This class provides support for making requests and receiving responses from HTTP servers.

CAtlNavigateData Class

This class represents HTTP transaction options for use with the CAtlHttpClientT class.

CAtlBaseAuthObject Class

This is an abstract base class that defines the interface for HTTP client authorization objects.

CBasicAuthObject Class

This class implements support for performing HTTP navigation using the BASIC authentication scheme.

CNTLMAuthObject Class

This class implements support for performing HTTP navigation using the NTLM authentication scheme.

Structures

ATL_NAVIGATE_DATA Structure

This class represents HTTP client settings as required by CAtlHttpClientT.

Typedefs

CAtlHttpClient

A synonym for a class that provides HTTP client support based on the CAtlHttpClientT class.

PFNATLCHUNKEDCB

A pointer to a function suitable for use as a callback used to prepare chunked-encoded HTTP requests.

PFNATLSTATUSCALLBACK

A pointer to a function suitable for use as a callback used to monitor either HTTP request or response transfer status.

Macros

ATL_HTTP_AUTHTYPE_BASIC

This macro defines a string that can be used to indicate the BASIC HTTP authorization scheme.

ATL_HTTP_AUTHTYPE_NTLM

This macro defines a string that can be used to indicate the NTLM authorization scheme.

ATL_HTTP_DEFAULT_BLOCK_SIZE

This macro represents the default memory block sizes used for both incoming and out-going HTTP transaction buffers.

ATL_HTTP_FLAG_AUTO_REDIRECT

This macro is a behavior modification flag for HTTP request transactions that specifies whether redirections should be pursued automatically.

ATL_HTTP_FLAG_INVALID_FLAGS

This macro can be used to test for an invalid state of the HTTP behavior-control flags used by the CAtlNavigateData and CAtlHttpClientT classes.

ATL_HTTP_FLAG_PROCESS_RESULT

This macro is a behavior modification flag for HTTP request transactions that specifies whether additional actions, such as redirection or authorization, should be pursued.

ATL_HTTP_FLAG_SEND_CALLBACK

This macro is a behavior modification flag that specifies whether HTTP requests should be chunk-transfer encoded.

ATL_HTTP_FLAG_SEND_BLOCKS

This macro is a behavior modification flag that indicates default HTTP request behavior.

ATL_HTTP_USERAGENT

This macro defines the user agent string that is embedded into each request.

ATL_HTTP_METHOD_GET

This macro defines a string that indicates HTTP requests based on the GET method.

ATL_HTTP_METHOD_POST

This macro defines a string that indicates HTTP requests based on the POST method.

ATL_INVALID_STATUS

This macro defines a value that represents an invalid HTTP response status code.

See Also

Show: