Click here to Skip to main content
Click here to Skip to main content
Go to top

Using WinInet HTTP functions in Full Asynchronous Mode

, 29 Jan 2001
Rate this:
Please Sign up or sign in to vote.
Using WinInet functions asynchronously is a nightmare since no samples exist. Here's one!

Introduction

If you have ever dug into the MSDN for WinInet API, you noticed that it can be used asynchronously and that it is the recommended way to use it.

If then you decide to use it, you won’t find any explanation of how to use it asynchronously. And no samples are available anywhere on Internet. After a long research and lots of testing, I finally managed to reconstruct a big part of the (voluntary?) missing documentation.

Why asynchronous is better? Because it can handle timeouts correctly. Just what’s missing in WinInet under IE5.5.

If you try to use TerminateThread or CloseHandle functions to handle timeouts (these methods are given in MSDN articles), you’ll fall into unrecoverable leaks of all kinds.

This has been tested successfully with: IE4.01SP3, IE5.0, IE5.01, IE5.5SP1 under WinNT4 on mono and multiprocessor machines, under a stressed environment (15 concurrent instances running non-stop for 12 hours on multi-proc NT server machines).

Theory

To use WinInet functions in full asynchronous mode, you must do things in the right order:

  1. Use INTERNET_FLAG_ASYNC to open the session
  2. Set a status callback using InternetSetStatusCallback
  3. Open the connection using InternetOpenUrl
  4. If InternetOpenUrl returned NULL and GetLastError is ERROR_IO_PENDING:
    • wait for the INTERNET_STATUS_HANDLE_CREATED notification in the callback, and save the connection Handle.
    • wait for the INTERNET_STATUS_REQUEST_COMPLETE notification in the callback before going further.
  5. Extract the content-length from the header and set up an INTERNET_BUFFERS structure:
    • dwStructSize = sizeof(INTERNET_BUFFERS)
    • lpvBuffer = your allocated buffer
    • dwBufferLength = its length
  6. Use InternetReadFileEx with the IRF_ASYNC flag to read the remaining data asynchronously. Don’t use InternetReadFile since it is a synchronous function.
  7. If InternetReadFileEx returned False and GetLastError is ERROR_IO_PENDING: wait for the INTERNET_STATUS_REQUEST_COMPLETE notification in the callback before going further.

    Warning: INTERNET_BUFFERS members are modified asynchronously (only the dwBufferLength member and the content of the buffer).

  8. If the dwBufferLength member is not 0, move the lpvBuffer pointer from this amount and subtract this amount from the buffer length so dwBufferLength reflects the remaining size lpvBuffer points to, then loop to 6.
  9. Close the connection handle with InternetCloseHandle and wait for INTERNET_STATUS_HANDLE_CLOSING and the facultative INTERNET_STATUS_REQUEST_COMPLETE notification (sent only if an error occurs – like a sudden closed connection -, you must test the cases).

At this state, you can either begin a new connection process or close the session handle. But before closing it, you should un-register the callback function.

Detail

After the theory, let’s look at some code for some of the points:

1&2: Create the connection using INTERNET_FLAG_ASYNC and setup the callback func:

m_Session = InternetOpen(AGENT_NAME, INTERNET_OPEN_TYPE_PRECONFIG, 
                          NULL, NULL, INTERNET_FLAG_ASYNC);
InternetSetStatusCallback( m_Session, 
      (INTERNET_STATUS_CALLBACK)InternetCallbackFunc );

3&4: Open the connection using InternetOpenUrl and wait for INTERNET_STATUS_REQUEST_COMPLETE

Use the lParam to send a session identifier to your callback. I always use the this pointer of my class for it. I assume you know how to handle callbacks.

InternetOpenUrl( m_Session, uurl, NULL, 0, 
      INTERNET_FLAG_RELOAD | INTERNET_FLAG_PRAGMA_NOCACHE | 
      INTERNET_FLAG_NO_CACHE_WRITE, (LPARAM)this );

The callback will receive a lots of messages then. Here are their orders along with the dwInternetStatus value:

[openUrl] InternetStatus: 60 INTERNET_STATUS_HANDLE_CREATED
**At this point you can save the HINTERNET handle using code like this in your callback:
INTERNET_ASYNC_RESULT* res = (INTERNET_ASYNC_RESULT*)lpvStatusInformation;
m_hHttpFile = (HINTERNET)(res->dwResult);

[openUrl] InternetStatus: 10
[openUrl] InternetStatus: 11
[openUrl] InternetStatus: 20
[openUrl] InternetStatus: 21
[openUrl] InternetStatus: 30
[openUrl] InternetStatus: 31
[openUrl] InternetStatus: 40
[openUrl] InternetStatus: 41
[openUrl] InternetStatus: 100 INTERNET_STATUS_REQUEST_COMPLETE

5: Extract the content-length and set up the INTERNET_BUFFERS structure

Once you have the handle, try to call HttpQueryInfo with HTTP_QUERY_CONTENT_LENGTH to get the size of the data to retrieve. This function can fail if the content-length field is not in the HTTP header.

Set up the INTERNET_BUFFERS structure.

INTERNET_BUFFERS ib = { sizeof(INTERNET_BUFFERS) };
ib.lpvBuffer = your allocated buffer
ib.dwBufferLength = its length

The dwBufferTotal is provided for your own use and is never modified by WinInet (as far as I know). I use it to store the total size of the received data.

6&7&8 Read the remaining data in a loop

Use InternetReadFileEx with the IRF_ASYNC flag to read the remaining data asynchronously. Don’t use InternetReadFile since it is a synchronous function. You must loop on InternetReadFileEx while the ib.dwBufferLength is not 0. Before each iteration you must adjust the lpvBuffer pointer and reset the dwBufferLength members of ib: add the received length to the pointer and set dwBufferLength to your remaining buffer size.

//Start the pump
BOOL bOk = InternetReadFileEx( m_hHttpFile, &ib, IRF_ASYNC, (LPARAM)this );
if(!bOk && GetLastError()==ERROR_IO_PENDING)
  wait...

//Pump
while( bOk && ib.dwBufferLength!=0 )
{
  (adjust ib values)
  bOk = InternetReadFileEx( m_hHttpFile, &ib, IRF_ASYNC, (LPARAM)this );
  if(!bOk && GetLastError()==ERROR_IO_PENDING)
    wait...
}

Your callback should receive these notifications (maybe more than once):

[connect] InternetStatus: 40 (receiving response)
[connect] InternetStatus: 41 (response received)
[connect] InternetStatus: 50
[connect] InternetStatus: 51
and maybe 
[connect] InternetStatus: 100 INTERNET_STATUS_REQUEST_COMPLETE

The last is received only if GetLastError() returned ERROR_IO_PENDING. If you stored the total data size (in bytes) in the dwBufferTotal member, use it to set the final “0” in your string buffer (if it’s a string).

buf[ib.dwBufferTotal] = 0;

9 Close the connection handle

InternetCloseHandle( m_httpFile );

The callback will receive this notification when the handle is closed:

[connect] InternetStatus: 70 INTERNET_STATUS_HANDLE_CLOSING

In most error cases, the connection is closed unexpectedly. If it happens you’ll receive a 70 followed by a 100 (INTERNET_STATUS_REQUEST_COMPLETE). This can happen anywhere during the process.

10 Before closing the m_Session handle

You must deregister the callback:

InternetSetStatusCallback( m_Session, NULL );

This should help those who tried to go through asynchronous mode in WinInet! Sorry, there are no attached files but you should be able to use the functions and create nice classes now. If you liked this article please add an entry in my guestbook and buy me a license of my shareware.

Bibliography

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Benjamin Mayrargue

United States United States
No Biography provided

Comments and Discussions

 
SuggestionI propose to get rid of async mode [modified] PinmemberXinyiChen20-Aug-11 6:19 
GeneralAsyncdemo no longer available PinmemberMike Ady5-Jul-10 3:49 
GeneralDownload manager using InternetReadFileEx Pinmembersairamdp11-Apr-10 23:22 
Questionhow to use InternetSetFilePointer in asyc mode? Pinmemberliaosea17-Jun-08 20:59 
QuestionQuestion PinmemberAlireza_136210-Feb-08 21:50 
QuestionWhat if I don't need to read any reply? PinmemberSean OConnor21-Aug-07 9:49 
AnswerRe: What if I don't need to read any reply? [modified] PinmemberBenjamin.Mayrargue17-Nov-07 1:24 
GeneralRe: What if I don't need to read any reply? PinmemberSean O'Connor31-Mar-08 23:06 
GeneralDoes not work when using modem Pinmembervonuyx6-Jun-07 3:36 
Generalman, YOUR "code" is a nightmare Pinmemberkkez30-Jan-05 5:12 
GeneralRe: man, YOUR "code" is a nightmare Pinmembercristip3216-Mar-05 21:41 
GeneralRe: man, YOUR "code" is a nightmare PinmemberUltra_Ca30-Aug-06 9:40 
GeneralRe: man, YOUR "code" is a nightmare PinmemberBenjamin.Mayrargue17-Nov-07 1:25 
GeneralInternetReadFileEx returns truncated data when HTTP answers are in “Transfer-Encoding: chunked” mode PinsussAnonymous17-Nov-04 3:52 
Questionhow to do HttpQueryInfo? PinmemberHuaHsin12-Jul-04 22:20 
AnswerRe: how to do HttpQueryInfo? PinmemberAbhijeet Dev5-Nov-04 9:05 
GeneralWinInet by MSDN!!! PinmemberChulips2-Jun-04 7:19 
GeneralRe: WinInet by MSDN!!! Pinmembercristip3216-Mar-05 21:45 
GeneralDetecting a resource PinmemberChulips1-Jun-04 11:51 
GeneralRe: Detecting a resource Pinmemberbbb28046710-Jul-08 2:31 
GeneralCookie Pinsussrgm20-May-04 9:02 
QuestionHTTP_QUERY_CONTENT_LENGTH not returning size.. ? PinmemberG33K31-Mar-04 11:58 
AnswerRe: HTTP_QUERY_CONTENT_LENGTH not returning size.. ? Pinmembertomwg1234529-Dec-09 18:46 
GeneralHttpQueryInfo API is not retrieving the proper Cookie data. Pinmembershanpalaniram25-Jan-04 23:40 
Hi,
 
I want to connect to HTTPS password server to authenticate login&password and to get Cookie.
Using HttpQueryInfo to get Cookie data from the handle of HttpOpenRequest after calling
HttpSendRequest successfully. With the Cookie data, again I want to connect to the HTTPS web
sever to Upload a file.
The above whole concept is working fine in VC++ 6.0, Win2000 Prof. But, HttpQueryInfo fails )
to get Cookie data when I use the same code for Pocket PC 2002 with Windows CE and eVC++ 3.0.
Even if HttpQueryInfo succeeds, it is not retrieving the proper Cookie data.
I want to know whether Windows CE & Pocket PC 2000 supports HttpQueryInfo API. If it supports,
Pls let me know the proper code.
Pls help me.
 
Thanks and Regards,
Shan ( shanpalaniram@rediffmail.com )
GeneralERROR_HTTP_HEADER_NOT_FOUND PinmemberK-PAX15-Sep-03 22:59 
GeneralRe: ERROR_HTTP_HEADER_NOT_FOUND PinmemberZinkyu19-Sep-07 4:22 
GeneralSSL and/or authentication PinmemberRobert J28-Aug-03 2:11 
GeneralNeed full code Pinmemberno_body6915-Jun-03 22:21 
GeneralDont't use aync mode anymore! PinsussLucky Hocking30-Jan-03 19:34 
QuestionWininet. Really works? PinsussEric CHAUVET29-Dec-02 14:20 
QuestionHow to implemente proxy authentication PinmemberAnonymous26-Mar-02 15:51 
GeneralInternetWriteFile PinmemberEd K28-Dec-01 12:06 
GeneralRe: InternetWriteFile PinmemberChaitanya Ram31-Jan-02 19:04 
GeneralRe: InternetWriteFile Pinmembertyounsi4-May-04 11:10 
GeneralRe: InternetWriteFile PinsussAnonymous7-Jun-05 4:13 
GeneralRe: InternetWriteFile PinmemberMember 342329118-May-09 2:36 
GeneralERROR_INTERNET_INCORRECT_HANDLE_STATE PinmemberVolodya Orlenko7-Dec-01 6:22 
GeneralRe: ERROR_INTERNET_INCORRECT_HANDLE_STATE PinmemberVolodya Orlenko12-Dec-01 4:26 
GeneralRe: ERROR_INTERNET_INCORRECT_HANDLE_STATE PinsussAnonymous31-Mar-03 21:23 
GeneralRe: ERROR_INTERNET_INCORRECT_HANDLE_STATE Pinmemberjweston25-Aug-04 11:43 
GeneralRe: ERROR_INTERNET_INCORRECT_HANDLE_STATE Pinmemberfoetalstalk29-Oct-04 3:48 
GeneralRe: ERROR_INTERNET_INCORRECT_HANDLE_STATE PinsussLou Montulli6-Jul-05 17:25 
GeneralAsync Challenge PinmemberF X3-Dec-01 23:20 
GeneralThe wonderful world of the WinInet Async API PinmemberRhea1-Dec-01 5:13 
GeneralRe: The wonderful world of the WinInet Async API Pinmembertntntn2-Dec-01 5:14 
GeneralInternetReadFileEx & Unicode Pinmembertntntn22-Nov-01 21:17 
GeneralRe: InternetReadFileEx & Unicode PinmemberNiels Keurentjes30-Nov-01 3:30 
GeneralRe: InternetReadFileEx & Unicode PinmemberRhea1-Dec-01 4:46 
GeneralFinding out the file's size PinmemberAnonymous12-Sep-01 12:30 
GeneralRe: Finding out the file's size PinmemberAnonymous26-Oct-01 23:44 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140916.1 | Last Updated 30 Jan 2001
Article Copyright 2000 by Benjamin Mayrargue
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid