ホーム › Networking.HttpServer › HttpReceiveHttpRequest

HttpReceiveHttpRequest

関数

キューからHTTPリクエストを受信する。

DLLHTTPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// HTTPAPI.dll
#include <windows.h>

DWORD HttpReceiveHttpRequest(
    HANDLE RequestQueueHandle,
    ULONGLONG RequestId,
    HTTP_RECEIVE_HTTP_REQUEST_FLAGS Flags,
    HTTP_REQUEST_V2* RequestBuffer,
    DWORD RequestBufferLength,
    DWORD* BytesReturned,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前

型

方向

説明

RequestQueueHandle

HANDLE

次に利用可能なリクエストを取得するリクエストキューへのハンドルです。リクエストキューは HttpCreateRequestQueue 関数の呼び出しによって作成され、そのハンドルが返されます。

Windows Server 2003 with SP1 および Windows XP with SP2: リクエストキューへのハンドルは HttpCreateHttpHandle 関数によって作成されます。

RequestId

ULONGLONG

リクエストを取得する最初の呼び出しでは、このパラメーターを HTTP_NULL_ID に設定します。その後、リクエスト全体を取得するために複数回の呼び出しが必要な場合は、pRequestBuffer が指す HTTP_REQUEST 構造体の RequestId メンバーで返された値を RequestID に設定して、 HttpReceiveHttpRequest または HttpReceiveRequestEntityBody を呼び出すことができます。

Flags

HTTP_RECEIVE_HTTP_REQUEST_FLAGS

次のいずれかの値を指定できるパラメーターです。

値	意味
0 (zero)	リクエストヘッダーのみを取得します。エンティティボディはコピーされません。
HTTP_RECEIVE_REQUEST_FLAG_COPY_BODY	利用可能なエンティティボディがリクエストヘッダーとともにコピーされます。 HTTP_REQUEST 構造体の pEntityChunks メンバーがエンティティボディを指します。
HTTP_RECEIVE_REQUEST_FLAG_FLUSH_BODY	すべてのエンティティボディがリクエストヘッダーとともにコピーされます。 HTTP_REQUEST 構造体の pEntityChunks メンバーがエンティティボディを指します。

RequestBuffer

HTTP_REQUEST_V2*

out

関数が HTTP リクエストの HTTP_REQUEST 構造体とエンティティボディをコピーするバッファーへのポインターです。HTTP_REQUEST.RequestId にはこの HTTP リクエストの識別子が格納され、アプリケーションは後続の HttpReceiveRequestEntityBody、 HttpSendHttpResponse、または HttpSendResponseEntityBody の呼び出しでこれを使用できます。

RequestBufferLength

DWORD

pRequestBuffer バッファーのサイズ(バイト単位)です。

BytesReturned

DWORD*

outoptional

省略可能。エンティティボディのサイズ、またはエンティティボディの残りの部分のサイズ(バイト単位)を受け取る変数へのポインターです。

pOverlapped を使用して非同期呼び出しを行う場合は、pBytesReceived を NULL に設定します。それ以外の場合、pOverlapped が NULL に設定されているときは、pBytesReceived は有効なメモリアドレスを格納している必要があり、NULL に設定してはなりません。

Overlapped

OVERLAPPED*

inoutoptional

非同期呼び出しの場合は、pOverlapped が OVERLAPPED 構造体を指すように設定します。同期呼び出しの場合は NULL に設定します。

同期呼び出しは、指定したキューにリクエストが到着し、その一部またはすべてが取得されるまでブロックします。一方、非同期呼び出しはただちに ERROR_IO_PENDING を返し、呼び出し元のアプリケーションは GetOverlappedResult または I/O 完了ポートを使用して操作が完了したことを判断します。同期処理のための OVERLAPPED 構造体の使用方法の詳細については、 Synchronization and Overlapped Input and Output を参照してください。

戻り値の型: DWORD

公式ドキュメント

指定したリクエストキューから、次に利用可能な HTTP リクエストを同期または非同期で取得します。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数を非同期的に使用している場合、戻り値 ERROR_IO_PENDING は、次のリクエストがまだ準備できておらず、通常のオーバーラップ I/O 完了メカニズムを通じて後で取得されることを示します。

関数が失敗した場合、戻り値は次のエラーコードのいずれかです。

値	意味
ERROR_INVALID_PARAMETER	指定されたパラメーターのうち、1 つ以上が使用できない形式です。
ERROR_NOACCESS	指定されたパラメーターのうち、1 つ以上が無効またはアラインメントされていないメモリバッファーを指しています。pRequestBuffer パラメーターは、HTTP_REQUEST 構造体のメモリアラインメント要件以上のメモリアラインメントを持つ有効なメモリバッファーを指す必要があります。
ERROR_MORE_DATA	RequestBufferLength の値は、受信したリクエストヘッダーのサイズ以上ですが、リクエスト構造体とエンティティボディを合わせたサイズには満たないものです。エンティティボディの残りの部分を読み取るために必要なバッファーサイズは、pBytesReceived が非 NULL で、かつ呼び出しが同期である場合に、このパラメーターで返されます。すべてのデータを取得するには、十分な大きさのバッファーを指定して関数を再度呼び出してください。
ERROR_HANDLE_EOF	指定されたリクエストはすでに完全に取得されています。この場合、pBytesReceived が指す値は意味を持たず、pRequestBuffer を参照すべきではありません。
その他	WinError.h で定義されているシステムエラーコード。

解説(Remarks)

特定のリクエストを取得するには、複数回の呼び出しが必要になる場合があります。たとえば、Flags パラメーターが 0 に設定されている場合、 HttpReceiveHttpRequest はリクエストヘッダー構造体のみをバッファーにコピーし、エンティティボディはコピーしません。この場合、 HttpReceiveRequestEntityBody 関数を使用してエンティティボディを取得するか、 HttpReceiveHttpRequest を 2 回目に呼び出すことができます。

あるいは、アプリケーションが提供したバッファーが、リクエストの全体または一部を受信するには小さすぎる場合があります。リクエストの少なくとも一部を確実に受信するために、アプリケーションは、ほとんどの HTTP リクエストに対応できる少なくとも 4 KB のバッファーを提供することをお勧めします。あるいは、不明なヘッダーとして解析される認証ヘッダーがそれにさらに最大 12 KB を追加することがあるため、認証/承認を使用する場合は、少なくとも 16 KB のバッファーサイズをお勧めします。

HttpReceiveHttpRequest が ERROR_MORE_DATA を返した場合、アプリケーションは追加の呼び出しを続けます。その際、各追加呼び出しで最初の呼び出しが返した HTTP_REQUEST.RequestId の値を渡してリクエストを識別し、ERROR_HANDLE_EOF が返されるまで続けます。

注意アプリケーションは、コンテンツネゴシエーションヘッダーが使用されている場合はそれを含め、関連するすべてのリクエストヘッダーを検査し、ヘッダーの内容に基づいて適切にリクエストを失敗させる必要があります。HttpReceiveHttpRequest は、ヘッダー行が適切に終端され、不正な文字を含んでいないことのみを保証します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// HTTPAPI.dll
#include <windows.h>

DWORD HttpReceiveHttpRequest(
    HANDLE RequestQueueHandle,
    ULONGLONG RequestId,
    HTTP_RECEIVE_HTTP_REQUEST_FLAGS Flags,
    HTTP_REQUEST_V2* RequestBuffer,
    DWORD RequestBufferLength,
    DWORD* BytesReturned,   // optional
    OVERLAPPED* Overlapped   // optional
);

[DllImport("HTTPAPI.dll", ExactSpelling = true)]
static extern uint HttpReceiveHttpRequest(
    IntPtr RequestQueueHandle,   // HANDLE
    ulong RequestId,   // ULONGLONG
    uint Flags,   // HTTP_RECEIVE_HTTP_REQUEST_FLAGS
    IntPtr RequestBuffer,   // HTTP_REQUEST_V2* out
    uint RequestBufferLength,   // DWORD
    IntPtr BytesReturned,   // DWORD* optional, out
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);

<DllImport("HTTPAPI.dll", ExactSpelling:=True)>
Public Shared Function HttpReceiveHttpRequest(
    RequestQueueHandle As IntPtr,   ' HANDLE
    RequestId As ULong,   ' ULONGLONG
    Flags As UInteger,   ' HTTP_RECEIVE_HTTP_REQUEST_FLAGS
    RequestBuffer As IntPtr,   ' HTTP_REQUEST_V2* out
    RequestBufferLength As UInteger,   ' DWORD
    BytesReturned As IntPtr,   ' DWORD* optional, out
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As UInteger
End Function

' RequestQueueHandle : HANDLE
' RequestId : ULONGLONG
' Flags : HTTP_RECEIVE_HTTP_REQUEST_FLAGS
' RequestBuffer : HTTP_REQUEST_V2* out
' RequestBufferLength : DWORD
' BytesReturned : DWORD* optional, out
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function HttpReceiveHttpRequest Lib "httpapi" ( _
    ByVal RequestQueueHandle As LongPtr, _
    ByVal RequestId As LongLong, _
    ByVal Flags As Long, _
    ByVal RequestBuffer As LongPtr, _
    ByVal RequestBufferLength As Long, _
    ByVal BytesReturned As LongPtr, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

HttpReceiveHttpRequest = ctypes.windll.httpapi.HttpReceiveHttpRequest
HttpReceiveHttpRequest.restype = wintypes.DWORD
HttpReceiveHttpRequest.argtypes = [
    wintypes.HANDLE,  # RequestQueueHandle : HANDLE
    ctypes.c_ulonglong,  # RequestId : ULONGLONG
    wintypes.DWORD,  # Flags : HTTP_RECEIVE_HTTP_REQUEST_FLAGS
    ctypes.c_void_p,  # RequestBuffer : HTTP_REQUEST_V2* out
    wintypes.DWORD,  # RequestBufferLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # BytesReturned : DWORD* optional, out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('HTTPAPI.dll')
HttpReceiveHttpRequest = Fiddle::Function.new(
  lib['HttpReceiveHttpRequest'],
  [
    Fiddle::TYPE_VOIDP,  # RequestQueueHandle : HANDLE
    -Fiddle::TYPE_LONG_LONG,  # RequestId : ULONGLONG
    -Fiddle::TYPE_INT,  # Flags : HTTP_RECEIVE_HTTP_REQUEST_FLAGS
    Fiddle::TYPE_VOIDP,  # RequestBuffer : HTTP_REQUEST_V2* out
    -Fiddle::TYPE_INT,  # RequestBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # BytesReturned : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "httpapi")]
extern "system" {
    fn HttpReceiveHttpRequest(
        RequestQueueHandle: *mut core::ffi::c_void,  // HANDLE
        RequestId: u64,  // ULONGLONG
        Flags: u32,  // HTTP_RECEIVE_HTTP_REQUEST_FLAGS
        RequestBuffer: *mut HTTP_REQUEST_V2,  // HTTP_REQUEST_V2* out
        RequestBufferLength: u32,  // DWORD
        BytesReturned: *mut u32,  // DWORD* optional, out
        Overlapped: *mut OVERLAPPED  // OVERLAPPED* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("HTTPAPI.dll")]
public static extern uint HttpReceiveHttpRequest(IntPtr RequestQueueHandle, ulong RequestId, uint Flags, IntPtr RequestBuffer, uint RequestBufferLength, IntPtr BytesReturned, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'HTTPAPI_HttpReceiveHttpRequest' -Namespace Win32 -PassThru
# $api::HttpReceiveHttpRequest(RequestQueueHandle, RequestId, Flags, RequestBuffer, RequestBufferLength, BytesReturned, Overlapped)

#uselib "HTTPAPI.dll"
#func global HttpReceiveHttpRequest "HttpReceiveHttpRequest" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; HttpReceiveHttpRequest RequestQueueHandle, RequestId, Flags, varptr(RequestBuffer), RequestBufferLength, varptr(BytesReturned), varptr(Overlapped)   ; 戻り値は stat
; RequestQueueHandle : HANDLE -> "sptr"
; RequestId : ULONGLONG -> "sptr"
; Flags : HTTP_RECEIVE_HTTP_REQUEST_FLAGS -> "sptr"
; RequestBuffer : HTTP_REQUEST_V2* out -> "sptr"
; RequestBufferLength : DWORD -> "sptr"
; BytesReturned : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "HTTPAPI.dll"
#cfunc global HttpReceiveHttpRequest "HttpReceiveHttpRequest" sptr, int64, int, var, int, var, var
; res = HttpReceiveHttpRequest(RequestQueueHandle, RequestId, Flags, RequestBuffer, RequestBufferLength, BytesReturned, Overlapped)
; RequestQueueHandle : HANDLE -> "sptr"
; RequestId : ULONGLONG -> "int64"
; Flags : HTTP_RECEIVE_HTTP_REQUEST_FLAGS -> "int"
; RequestBuffer : HTTP_REQUEST_V2* out -> "var"
; RequestBufferLength : DWORD -> "int"
; BytesReturned : DWORD* optional, out -> "var"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "HTTPAPI.dll"
#cfunc global HttpReceiveHttpRequest "HttpReceiveHttpRequest" sptr, int64, int, sptr, int, sptr, sptr
; res = HttpReceiveHttpRequest(RequestQueueHandle, RequestId, Flags, varptr(RequestBuffer), RequestBufferLength, varptr(BytesReturned), varptr(Overlapped))
; RequestQueueHandle : HANDLE -> "sptr"
; RequestId : ULONGLONG -> "int64"
; Flags : HTTP_RECEIVE_HTTP_REQUEST_FLAGS -> "int"
; RequestBuffer : HTTP_REQUEST_V2* out -> "sptr"
; RequestBufferLength : DWORD -> "int"
; BytesReturned : DWORD* optional, out -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。