Win32 API 日本語リファレンス
ホームNetworking.HttpServer › HTTP_FLOWRATE_INFO

HTTP_FLOWRATE_INFO

構造体
サイズx64: 16 バイト / x86: 16 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
FlagsHTTP_PROPERTY_FLAGS4+0+0プロパティが存在するかどうかを指定する HTTP_PROPERTY_FLAGS 構造体です。
MaxBandwidthDWORD4+4+4バイト/秒 で表される最大帯域幅です。これは、BurstSize でサイズを指定したバースト コンテンツの送信が完了した後の、レスポンスの最大帯域幅です。
MaxPeakBandwidthDWORD4+8+8バイト/秒 で表されるピーク帯域幅です。これは、バーストが配信されるときの最大帯域幅です。
BurstSizeDWORD4+12+12MaxPeakBandwidth で配信されるコンテンツのサイズ (バイト単位) です。このコンテンツが配信されると、レスポンスは MaxBandwidth に制限されます。HTTP サーバー アプリケーションが MaxBandwidth より遅い速度でレスポンスを送信した場合、帯域幅の利用効率を最大化するため、レスポンスは再び MaxPeakBandwidth でのバーストの対象となります。

公式ドキュメント

レスポンスの転送速度

解説(Remarks)

この構造体を使用すると、HTTP サーバー アプリケーションは HTTP レスポンスの転送速度を制限することで、ネットワーク帯域幅の利用効率を最大化できます。これは、コンテンツの最初のバーストを高い転送速度で配信し、その後に速度を制限するメディア コンテンツの配信で特に有用です。これにより、より多くのメディアのコンテンツを同時に配信できます。

次の 2 つの場合には、転送速度が MaxBandwidth を超えることが許可されます。

MaxBandwidth を超えた場合でも、 MaxPeakBandwidth が絶対的な上限であることに変わりはありません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// HTTP_PROPERTY_FLAGS  (x64 4 / x86 4 バイト)
typedef struct HTTP_PROPERTY_FLAGS {
    DWORD _bitfield;
} HTTP_PROPERTY_FLAGS;

// HTTP_FLOWRATE_INFO  (x64 16 / x86 16 バイト)
typedef struct HTTP_FLOWRATE_INFO {
    HTTP_PROPERTY_FLAGS Flags;
    DWORD MaxBandwidth;
    DWORD MaxPeakBandwidth;
    DWORD BurstSize;
} HTTP_FLOWRATE_INFO;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct HTTP_PROPERTY_FLAGS
{
    public uint _bitfield;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct HTTP_FLOWRATE_INFO
{
    public HTTP_PROPERTY_FLAGS Flags;
    public uint MaxBandwidth;
    public uint MaxPeakBandwidth;
    public uint BurstSize;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure HTTP_PROPERTY_FLAGS
    Public _bitfield As UInteger
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure HTTP_FLOWRATE_INFO
    Public Flags As HTTP_PROPERTY_FLAGS
    Public MaxBandwidth As UInteger
    Public MaxPeakBandwidth As UInteger
    Public BurstSize As UInteger
End Structure
import ctypes
from ctypes import wintypes

class HTTP_PROPERTY_FLAGS(ctypes.Structure):
    _fields_ = [
        ("_bitfield", wintypes.DWORD),
    ]

class HTTP_FLOWRATE_INFO(ctypes.Structure):
    _fields_ = [
        ("Flags", HTTP_PROPERTY_FLAGS),
        ("MaxBandwidth", wintypes.DWORD),
        ("MaxPeakBandwidth", wintypes.DWORD),
        ("BurstSize", wintypes.DWORD),
    ]
#[repr(C)]
pub struct HTTP_PROPERTY_FLAGS {
    pub _bitfield: u32,
}

#[repr(C)]
pub struct HTTP_FLOWRATE_INFO {
    pub Flags: HTTP_PROPERTY_FLAGS,
    pub MaxBandwidth: u32,
    pub MaxPeakBandwidth: u32,
    pub BurstSize: u32,
}
import "golang.org/x/sys/windows"

type HTTP_PROPERTY_FLAGS struct {
	_bitfield uint32
}

type HTTP_FLOWRATE_INFO struct {
	Flags HTTP_PROPERTY_FLAGS
	MaxBandwidth uint32
	MaxPeakBandwidth uint32
	BurstSize uint32
}
type
  HTTP_PROPERTY_FLAGS = record
    _bitfield: DWORD;
  end;

  HTTP_FLOWRATE_INFO = record
    Flags: HTTP_PROPERTY_FLAGS;
    MaxBandwidth: DWORD;
    MaxPeakBandwidth: DWORD;
    BurstSize: DWORD;
  end;
const HTTP_PROPERTY_FLAGS = extern struct {
    _bitfield: u32,
};

const HTTP_FLOWRATE_INFO = extern struct {
    Flags: HTTP_PROPERTY_FLAGS,
    MaxBandwidth: u32,
    MaxPeakBandwidth: u32,
    BurstSize: u32,
};
type
  HTTP_PROPERTY_FLAGS {.bycopy.} = object
    _bitfield: uint32

  HTTP_FLOWRATE_INFO {.bycopy.} = object
    Flags: HTTP_PROPERTY_FLAGS
    MaxBandwidth: uint32
    MaxPeakBandwidth: uint32
    BurstSize: uint32
struct HTTP_PROPERTY_FLAGS
{
    uint _bitfield;
}

struct HTTP_FLOWRATE_INFO
{
    HTTP_PROPERTY_FLAGS Flags;
    uint MaxBandwidth;
    uint MaxPeakBandwidth;
    uint BurstSize;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; HTTP_FLOWRATE_INFO サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; Flags : HTTP_PROPERTY_FLAGS (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; MaxBandwidth : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; MaxPeakBandwidth : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; BurstSize : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global HTTP_PROPERTY_FLAGS
    #field int _bitfield
#endstruct

#defstruct global HTTP_FLOWRATE_INFO
    #field HTTP_PROPERTY_FLAGS Flags
    #field int MaxBandwidth
    #field int MaxPeakBandwidth
    #field int BurstSize
#endstruct

stdim st, HTTP_FLOWRATE_INFO        ; NSTRUCT 変数を確保
st->MaxBandwidth = 100
mes "MaxBandwidth=" + st->MaxBandwidth