Метод IWinHttpRequest::SetTimeouts

Статья
06/13/2023

Метод SetTimeouts задает отдельные компоненты времени ожидания операции отправки и получения в миллисекундах.

Синтаксис

HRESULT SetTimeouts(
  [in] long ResolveTimeout,
  [in] long ConnectTimeout,
  [in] long SendTimeout,
  [in] long ReceiveTimeout
);

Параметры

ResolveTimeout [in]: Значение времени ожидания, применяемое при разрешении имени узла (например, www.microsoft.com) в IP-адрес (например, 192.168.131.199) в миллисекундах. Значение по умолчанию равно нулю, что означает отсутствие времени ожидания (бесконечное). Если время ожидания DNS указано с помощью NAME_RESOLUTION_TIMEOUT, на каждый запрос приходится один поток.
ConnectTimeout [in]: Значение времени ожидания, применяемое при установке сокета связи с целевым сервером, в миллисекундах. По умолчанию установлено значение 60000 (60 секунд).
SendTimeout [вход]: Значение времени ожидания, применяемое при отправке отдельного пакета данных запроса в сокете связи на целевой сервер в миллисекундах. Большой запрос, отправляемый на HTTP-сервер, обычно разбивается на несколько пакетов; Время ожидания отправки применяется к отправке каждого пакета по отдельности. Значение по умолчанию — 30 000 (30 секунд).
ReceiveTimeout [in]: Значение времени ожидания, применяемое при получении пакета данных ответа от целевого сервера, в миллисекундах. Большие ответы разбиваются на несколько пакетов; Время ожидания получения применяется к извлечению каждого пакета данных из сокета. Значение по умолчанию — 30 000 (30 секунд).

Возвращаемое значение

Возвращаемое значение S_OK при успешном выполнении или значение ошибки в противном случае.

Все параметры обязательные. Значение 0 или -1 задает время ожидания бесконечного ожидания. Значение больше 0 задает значение времени ожидания в миллисекундах. Например, 30 000 установят время ожидания в 30 секунд. Все отрицательные значения, отличные от -1, приводят к сбою этого метода.

Значения времени ожидания применяются на уровне Winsock.

Примечание

Для Windows XP и Windows 2000 см. раздел Требования к времени выполнения начальной страницы WinHttp.

Примеры

В следующем примере показано, как задать время ожидания WinHTTP равным 30 секундам, открыть HTTP-подключение, отправить HTTP-запрос и прочитать текст ответа.

#include <windows.h>
#include <stdio.h>
#include <objbase.h>

#include "httprequest.h"

#pragma comment(lib, "ole32.lib")
#pragma comment(lib, "oleaut32.lib")

// IID for IWinHttpRequest.
const IID IID_IWinHttpRequest =
{
  0x06f29373,
  0x5c5a,
  0x4b54,
  {0xb0, 0x25, 0x6e, 0xf1, 0xbf, 0x8a, 0xbf, 0x0e}
};

int main()
{
    // variable for return value
    HRESULT    hr;

    // initialize COM
    hr = CoInitialize( NULL );

    IWinHttpRequest *  pIWinHttpRequest = NULL;

    BSTR            bstrResponse = NULL;
    VARIANT         varFalse;
    VARIANT         varEmpty;

    CLSID           clsid;

    VariantInit(&varFalse);
    V_VT(&varFalse)   = VT_BOOL;
    V_BOOL(&varFalse) = VARIANT_FALSE;

    VariantInit(&varEmpty);
    V_VT(&varEmpty) = VT_ERROR;

    hr = CLSIDFromProgID(L"WinHttp.WinHttpRequest.5.1", &clsid);

    if (SUCCEEDED(hr))
    {
        hr = CoCreateInstance(clsid, NULL,
                              CLSCTX_INPROC_SERVER,
                              IID_IWinHttpRequest,
                              (void **)&pIWinHttpRequest);
    }

    if (SUCCEEDED(hr))
    {    // Set Time-outs.
        hr = pIWinHttpRequest->SetTimeouts(30000, 30000,
                                           30000, 30000);
    }
    if (SUCCEEDED(hr))
    {    // Open WinHttpRequest.
        BSTR bstrMethod  = SysAllocString(L"GET");
        BSTR bstrUrl = SysAllocString(L"https://microsoft.com");
        hr = pIWinHttpRequest->Open(bstrMethod,
                                    bstrUrl,
                                    varFalse);
        SysFreeString(bstrMethod);
        SysFreeString(bstrUrl);
    }
    if (SUCCEEDED(hr))
    {    // Send Request.
        hr = pIWinHttpRequest->Send(varEmpty);
    }
    if (SUCCEEDED(hr))
    {    // Get Response text.
        hr = pIWinHttpRequest->GetAllResponseHeaders(&bstrResponse);
    }
    if (SUCCEEDED(hr))
    {    // Print response to console.
        wprintf(L"%.256s",bstrResponse);
    }

    // Release memory.
    if (pIWinHttpRequest)
        pIWinHttpRequest->Release();
    if (bstrResponse)
        SysFreeString(bstrResponse);

    CoUninitialize();
    return 0;
}

В следующем примере скрипта показано, как задать для всех тайм-аутов WinHTTP 30 секунд, открыть HTTP-подключение и отправить HTTP-запрос.

// Instantiate a WinHttpRequest object.
var WinHttpReq = new ActiveXObject("WinHttp.WinHttpRequest.5.1");

// Set time-outs. If time-outs are set, they must 
// be set before open.
WinHttpReq.SetTimeouts(30000, 30000, 30000, 30000);

// Initialize an HTTP request.  
WinHttpReq.Open("GET", "https://www.microsoft.com", false);

// Send the HTTP request.
WinHttpReq.Send();

Требования

Требование	Значение
Минимальная версия клиента	Windows XP, Windows 2000 Профессиональная с пакетом обновления 3 (SP3) [только классические приложения]
Минимальная версия сервера	Windows Server 2003, Windows 2000 Server с пакетом обновления 3 (SP3) [только классические приложения]
Распространяемые компоненты	WinHTTP 5.0 и Internet Обозреватель 5.01 или более поздней версии в Windows XP и Windows 2000.
IDL	HttpRequest.idl
Библиотека	Winhttp.lib
DLL	Winhttp.dll

См. также раздел

IWinHttpRequest
WinHttpRequest
Версии WinHTTP

Поделиться через