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

Syntax

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

Arguments

Name Description
out pHeaderBuf Buffer that stores the message header.
in bufSize Data size of pHeaderBuf.
in timeout Timeout interval.
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 a timeout argument.

Description

This version of GetHeaderAll has a timeout.

Other than the ability to specify a timeout, this version functions identically to GetHeaderAll. For feature details, see the function reference for the version without a timeout. Returns ResultTimeout if no HTTP response header has been fully received within the timeout period. If ResultTimeout is returned, the connection is automatically canceled. (In other words, the function internally implements Cancel.)

Revision History

2010/06/14
Initial version.

CONFIDENTIAL