nn::http::Connection::GetHeaderAll Member Function

Syntax

nn::Result GetHeaderAll(
     char * pHeaderBuf,
     size_t bufSize,
     size_t * pLengthCourier = NULL
) const;

Arguments

Name Description
out pHeaderBuf Buffer that stores the message header.
in bufSize Data size of pHeaderBuf.
out pLengthCourier Buffer that stores the size of the message header. This argument can be omitted if the size of the message header is not required.

Return Values

Returns the function's execution result. The Result value is the same as for the GetHeaderField function version that has no timeout argument.

Description

Gets the message header for the HTTP response that was received.

This function blocks until the header is completely received. See the description of GetHeaderField for more details about this specification.

Note: If the pHeaderBuf size is smaller than the header size, as much data is stored in pHeaderBuf as will fit, and the header size is stored in pLengthCourier.

Note: If pHeaderBuf==NULL or bufSize==0, and if pLengthCourier!=NULL, the field length is stored in pLengthCourier.

Note: Unlike the version of GetHeaderAll that includes a timeout, this function does not time out. In other words, control will not return from this function until processing has ended. In environments where communications are slow you can expect a long time to pass before processing ends and control returns from this function.

Revision History

2010/06/14
Initial version.

CONFIDENTIAL