ホーム › NetworkManagement.QoS › QOSAddSocketToFlow

QOSAddSocketToFlow

関数

ソケットをQoSフローに追加しトラフィック種別を割り当てる。

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

シグネチャ

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

BOOL QOSAddSocketToFlow(
    HANDLE QOSHandle,
    SOCKET Socket,
    SOCKADDR* DestAddr,   // optional
    QOS_TRAFFIC_TYPE TrafficType,
    DWORD Flags,   // optional
    DWORD* FlowId
);

パラメーター

名前

型

方向

説明

QOSHandle

HANDLE

QOSCreateHandle によって返された QOS サブシステムへのハンドル。

Socket

SOCKET

アプリケーションがトラフィックを流すために使用するソケットを指定します。

DestAddr

SOCKADDR*

inoptional

アプリケーションがトラフィックを送信する宛先 IP アドレスを格納した sockaddr 構造体へのポインター。sockaddr 構造体には宛先ポートを指定する必要があります。

メモソケットが既に接続されている場合、DestAddr は省略可能です。このパラメーターを指定する場合、リモートの IP アドレスとポートは、そのソケットの connect 呼び出しで使用したものと一致する必要があります。

ソケットが接続されていない場合は、このパラメーターを指定する必要があります。ソケットが既に接続されている場合は、このパラメーターを指定する必要はありません。その場合でもこのパラメーターを指定するときは、宛先ホストとポートが、ソケットの connect 呼び出しで指定した値と一致している必要があります。

TCP ではソケットの connect 呼び出しが遅延することがあるため、接続が確立される前に QOSAddSocketToFlow を呼び出し、DestAddr パラメーターにリモートシステムの IP アドレスとポート番号を渡すことができます。

TrafficType

QOS_TRAFFIC_TYPE

このフローで使用するトラフィックの種類を指定する QOS_TRAFFIC_TYPE 定数。

Flags

DWORD

inoptional

省略可能なフラグ値。

値

意味

QOS_NON_ADAPTIVE_FLOW

指定した場合、QoS サブシステムはこのフローのネットワークパスに関するデータを収集しません。そのため、帯域幅の推定技術に依存する関数は使用できなくなります。たとえば、Operation の値に QOSQueryFlowFundamentals を指定した QOSQueryFlow や、Operation の値に QOSNotifyCongested、QOSNotifyUncongested、QOSNotifyAvailable を指定した QOSNotifyFlow が使用できなくなります。

FlowId

DWORD*

inout

フロー識別子を受け取るバッファーへのポインター。入力時、この値は 0 でなければなりません。出力時、呼び出しが成功するとバッファーにフロー識別子が格納されます。

既存のフローにソケットを追加する場合、このパラメーターはそのフローの識別子になります。

複数のソケットが同じ QoS フローのプロパティを共有できる場合、アプリケーションはこのパラメーターを利用できます。これにより QoS サブシステムは、同じプロパティを持つ後続のソケットのために新しいフローをプロビジョニングするオーバーヘッドを負わずに済みます。既存のフローに複数のソケットを接続できるのは、非適応型フローのみである点に注意してください。

QOS_FLOWID は符号なし 32 ビット整数です。

戻り値の型: BOOL

公式ドキュメント

トラフィック用の新しいフローを追加します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。考えられるエラーコードを次に示します。

戻り値	説明
ERROR_CONNECTION_REFUSED	リモートシステムがネットワーク接続を拒否しました。
ERROR_INVALID_HANDLE	QOSHandle パラメーターが無効です。
ERROR_INVALID_PARAMETER	FlowId パラメーターが無効です。メモこの値は、DestAddr パラメーターに IPv4/v6 混在アドレスが指定された場合にも返されます。
ERROR_NOT_ENOUGH_MEMORY	メモリの割り当てに失敗しました。
ERROR_NO_SYSTEM_RESOURCES	操作を実行するためのリソースが不足しています。
ERROR_IO_DEVICE	I/O デバイスのエラーにより、要求を実行できませんでした。
ERROR_DEVICE_REINITIALIZATION_NEEDED	ハードウェアエラーのため、対象のデバイスは再初期化が必要です。アプリケーションはクリーンアップを行い、QOSCreateHandle を再度呼び出してください。
ERROR_NOT_SUPPORTED	この要求はサポートされていません。
ERROR_ADAP_HDW_ERR	ネットワークアダプターのハードウェアエラーが発生しました。
ERROR_HOST_UNREACHABLE	ネットワーク上の場所に到達できません。

解説(Remarks)

qWAVE では IPv4/v6 混在アドレスの使用はサポートされていません。DestAddr パラメーターで指定するアドレスは、IPv4 または IPv6 のいずれかである必要があります。

特定のネットワークインターフェイス上でネットワーク測定を行う必要がある場合は、そのインターフェイスにソケットをバインドする必要があります。バインドしない場合は、ネットワークスタックが示す最も適切なインターフェイスが qWAVE サブシステムによって割り当てられます。

この呼び出しを行っただけでは、このフローに関連付けられたネットワークトラフィックには影響しません。たとえば、パケットの優先順位付けはすぐには行われません。

この関数を使用するアプリケーションには、適応型 (adaptive) と非適応型 (non-adaptive) の 2 種類があります。適応型アプリケーションは、通知や QOS_FLOW_FUNDAMENTALS 構造体の情報を利用して、輻輳などのネットワークの変化に適応します。qWAVE サービスは、適応型フローに対して、宛先デバイスに実装されている場合がある Link Layer Topology Discovery (LLTD) の QoS 拡張を使用します。

適応型の A/V アプリケーションは、この関数を呼び出した後、ネットワークトラフィックに影響を与えるために、Operation の値に QOSSetFlowRate を指定して QOSSetFlow 関数を呼び出す必要があります。

非適応型アプリケーションとは、ネットワーク特性の変化に適応しないアプリケーション、または ERROR_NOT_SUPPORTED によって示されるように適応機能をサポートしないエンドポイントへトラフィックを送信するアプリケーションです。

非適応型アプリケーション、および非適応型フローを作成する適応型アプリケーションは、QOS_NON_ADAPTIVE_FLOW フラグを指定してこの関数を呼び出してください。この関数を呼び出した後、A/V アプリケーションは Operation を指定して QOSSetFlow 関数を呼び出します。シェーピングが必要でない限り、QOSSetFlow を呼び出す必要はありません。

例

次のコードは QOSAddSocketFromFlow の使用方法を示しています。QOSAddSocketFromFlow で使用するパラメーターの初期化に関する情報を示すため、QOSCreateHandle 関数も併せて示しています。

完全なサンプルコードについては Windows SDK を参照してください。SDK のフォルダー: Samples\NetDs\GQos\Qos2

WSAGetLastError やその他の Winsock 関数を使用するには、Winsock2.h ヘッダーファイルをインクルードする必要があります。

QOS_VERSION    Version;
HANDLE         QoSHandle = NULL;
QOS_FLOWID     QoSFlowId = 0; // フロー ID は 0 でなければなりません。
SOCKET        ConnectionSocket;
BOOL          QoSResult;


// QoS のバージョンパラメーターを初期化します。
Version.MajorVersion = 1;
Version.MinorVersion = 0;

// QoS サブシステムへのハンドルを取得します。
QoSResult = QOSCreateHandle(
    &Version, 
    &QoSHandle );

if (QoSResult != TRUE)
{
    std::cerr << "QOSCreateHandle failed. Error: "; 
    std::cerr << WSAGetLastError() << std::endl;
}

// ConnectionSocket の初期化は簡潔さのため   
// 省略していますが、実際には必要です。
/////////////////////////////////////
 
// ソケットをフローに追加します。
QoSResult = QOSAddSocketToFlow(
    QoSHandle,
    ConnectionSocket,
    NULL,
    QOSTrafficTypeExcellentEffort, 
     QOS_NON_ADAPTIVE_FLOW, 
    &QoSFlowId);

if (QoSResult != TRUE)
{
    std::cerr << "QOSAddSocketToFlow failed. Error: "; 
    std::cerr << WSAGetLastError() << std::endl;
}

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

各言語での呼び出し定義

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

BOOL QOSAddSocketToFlow(
    HANDLE QOSHandle,
    SOCKET Socket,
    SOCKADDR* DestAddr,   // optional
    QOS_TRAFFIC_TYPE TrafficType,
    DWORD Flags,   // optional
    DWORD* FlowId
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("qwave.dll", ExactSpelling = true)]
static extern bool QOSAddSocketToFlow(
    IntPtr QOSHandle,   // HANDLE
    UIntPtr Socket,   // SOCKET
    IntPtr DestAddr,   // SOCKADDR* optional
    int TrafficType,   // QOS_TRAFFIC_TYPE
    uint Flags,   // DWORD optional
    ref uint FlowId   // DWORD* in/out
);

<DllImport("qwave.dll", ExactSpelling:=True)>
Public Shared Function QOSAddSocketToFlow(
    QOSHandle As IntPtr,   ' HANDLE
    Socket As UIntPtr,   ' SOCKET
    DestAddr As IntPtr,   ' SOCKADDR* optional
    TrafficType As Integer,   ' QOS_TRAFFIC_TYPE
    Flags As UInteger,   ' DWORD optional
    ByRef FlowId As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' QOSHandle : HANDLE
' Socket : SOCKET
' DestAddr : SOCKADDR* optional
' TrafficType : QOS_TRAFFIC_TYPE
' Flags : DWORD optional
' FlowId : DWORD* in/out
Declare PtrSafe Function QOSAddSocketToFlow Lib "qwave" ( _
    ByVal QOSHandle As LongPtr, _
    ByVal Socket As LongPtr, _
    ByVal DestAddr As LongPtr, _
    ByVal TrafficType As Long, _
    ByVal Flags As Long, _
    ByRef FlowId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

QOSAddSocketToFlow = ctypes.windll.qwave.QOSAddSocketToFlow
QOSAddSocketToFlow.restype = wintypes.BOOL
QOSAddSocketToFlow.argtypes = [
    wintypes.HANDLE,  # QOSHandle : HANDLE
    ctypes.c_size_t,  # Socket : SOCKET
    ctypes.c_void_p,  # DestAddr : SOCKADDR* optional
    ctypes.c_int,  # TrafficType : QOS_TRAFFIC_TYPE
    wintypes.DWORD,  # Flags : DWORD optional
    ctypes.POINTER(wintypes.DWORD),  # FlowId : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('qwave.dll')
QOSAddSocketToFlow = Fiddle::Function.new(
  lib['QOSAddSocketToFlow'],
  [
    Fiddle::TYPE_VOIDP,  # QOSHandle : HANDLE
    Fiddle::TYPE_UINTPTR_T,  # Socket : SOCKET
    Fiddle::TYPE_VOIDP,  # DestAddr : SOCKADDR* optional
    Fiddle::TYPE_INT,  # TrafficType : QOS_TRAFFIC_TYPE
    -Fiddle::TYPE_INT,  # Flags : DWORD optional
    Fiddle::TYPE_VOIDP,  # FlowId : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "qwave")]
extern "system" {
    fn QOSAddSocketToFlow(
        QOSHandle: *mut core::ffi::c_void,  // HANDLE
        Socket: usize,  // SOCKET
        DestAddr: *mut SOCKADDR,  // SOCKADDR* optional
        TrafficType: i32,  // QOS_TRAFFIC_TYPE
        Flags: u32,  // DWORD optional
        FlowId: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("qwave.dll")]
public static extern bool QOSAddSocketToFlow(IntPtr QOSHandle, UIntPtr Socket, IntPtr DestAddr, int TrafficType, uint Flags, ref uint FlowId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'qwave_QOSAddSocketToFlow' -Namespace Win32 -PassThru
# $api::QOSAddSocketToFlow(QOSHandle, Socket, DestAddr, TrafficType, Flags, FlowId)

#uselib "qwave.dll"
#func global QOSAddSocketToFlow "QOSAddSocketToFlow" sptr, sptr, sptr, sptr, sptr, sptr
; QOSAddSocketToFlow QOSHandle, Socket, varptr(DestAddr), TrafficType, Flags, varptr(FlowId)   ; 戻り値は stat
; QOSHandle : HANDLE -> "sptr"
; Socket : SOCKET -> "sptr"
; DestAddr : SOCKADDR* optional -> "sptr"
; TrafficType : QOS_TRAFFIC_TYPE -> "sptr"
; Flags : DWORD optional -> "sptr"
; FlowId : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "qwave.dll"
#cfunc global QOSAddSocketToFlow "QOSAddSocketToFlow" sptr, sptr, var, int, int, var
; res = QOSAddSocketToFlow(QOSHandle, Socket, DestAddr, TrafficType, Flags, FlowId)
; QOSHandle : HANDLE -> "sptr"
; Socket : SOCKET -> "sptr"
; DestAddr : SOCKADDR* optional -> "var"
; TrafficType : QOS_TRAFFIC_TYPE -> "int"
; Flags : DWORD optional -> "int"
; FlowId : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "qwave.dll"
#cfunc global QOSAddSocketToFlow "QOSAddSocketToFlow" sptr, sptr, sptr, int, int, sptr
; res = QOSAddSocketToFlow(QOSHandle, Socket, varptr(DestAddr), TrafficType, Flags, varptr(FlowId))
; QOSHandle : HANDLE -> "sptr"
; Socket : SOCKET -> "sptr"
; DestAddr : SOCKADDR* optional -> "sptr"
; TrafficType : QOS_TRAFFIC_TYPE -> "int"
; Flags : DWORD optional -> "int"
; FlowId : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。