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

WEB_SOCKET_PROPERTY_TYPE

列挙型
基底型i4

メンバー 7

名前10進16進説明
WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE00x0

Property type: ULONG

この WebSocket プロパティは、内部受信バッファーのサイズです。バッファーは 256 バイトより小さくすることはできません。

既定値は 4096 です。

WebSocketCreateClientHandle および WebSocketCreateServerHandle で使用します。

WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE10x1

Property type: ULONG

この WebSocket プロパティは、内部送信バッファーのサイズです。バッファーは 256 バイトより小さくすることはできません。

既定値は、WebSocketCreateClientHandle で作成したハンドルでは 4096、WebSocketCreateServerHandle で作成したハンドルでは 16 です。

WebSocketCreateClientHandle および WebSocketCreateServerHandle で使用します。

WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE20x2

Property type: BOOL

この WebSocket プロパティは、クライアントフレームのマスクビットを無効にするものです。クライアント側では、このプロパティによりマスクキーが 0 に設定されます。サーバー側では、このプロパティにより、マスクビットが 0 に設定されたクライアントフレームをサーバーが受け入れられるようになります。このプロパティは、セキュリティ上の重大な影響を及ぼす可能性があります。 既定ではこのプロパティは使用されず、マスク処理は有効です。

WebSocketCreateClientHandle および WebSocketCreateServerHandle で使用します。

WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE30x3

Property type: PVOID

この WebSocket プロパティは、内部バッファーとして使用されるバッファーです。渡されたバッファーが使用されない場合は、WebSocket ライブラリがバッファーの管理を行います。 渡すバッファーは 8 バイト境界に整列されている必要があり、そのサイズは受信バッファーサイズ + 送信バッファーサイズ + 256 バイトより大きくなければなりません。

WebSocketCreateClientHandle および WebSocketCreateServerHandle で使用します。

WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE40x4

Property type: BOOL

この WebSocket プロパティは、UTF-8 の検証を無効にします。

WebSocketCreateClientHandle および WebSocketCreateServerHandle で使用します。

WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE50x5

Property type: ULONG

この WebSocket プロパティは、接続上でキープアライブパケットを送信する間隔 (ミリ秒単位) です。既定の間隔は 30000 (30 秒) です。最小の間隔は 15000 (15 秒) です。

メモ キープアライブ間隔の既定値は HKLM:\SOFTWARE\Microsoft\WebSocket\KeepaliveInterval から読み取られます。値が設定されていない場合は、既定値の 30000 が使用されます。キープアライブ間隔を 15000 ミリ秒より短くすることはできません。それより小さい値が設定された場合は、15000 ミリ秒が使用されます。

WebSocketGetGlobalProperty で使用します。

WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE60x6

Property type: ULONG array

この WebSocket プロパティは、サポートされている WebSocket プロトコルのバージョンです。

WebSocketGetGlobalProperty で使用します。

公式ドキュメント

WEB_SOCKET_PROPERTY_TYPE 列挙型は、WebSocket のプロパティの種類を指定します。

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

各言語での定義

列挙メンバーの定義。HSP タブは #define global(値は16進)。

typedef enum WEB_SOCKET_PROPERTY_TYPE : int {
    WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE = 0,
    WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE = 1,
    WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE = 2,
    WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE = 3,
    WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE = 4,
    WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE = 5,
    WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE = 6
} WEB_SOCKET_PROPERTY_TYPE;
public enum WEB_SOCKET_PROPERTY_TYPE : int
{
    WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE = 0,
    WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE = 1,
    WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE = 2,
    WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE = 3,
    WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE = 4,
    WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE = 5,
    WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE = 6,
}
Public Enum WEB_SOCKET_PROPERTY_TYPE As Integer
    WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE = 0
    WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE = 1
    WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE = 2
    WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE = 3
    WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE = 4
    WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE = 5
    WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE = 6
End Enum
import enum

class WEB_SOCKET_PROPERTY_TYPE(enum.IntEnum):
    WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE = 0
    WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE = 1
    WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE = 2
    WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE = 3
    WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE = 4
    WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE = 5
    WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE = 6
// WEB_SOCKET_PROPERTY_TYPE
pub const WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE: i32 = 0;
pub const WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE: i32 = 1;
pub const WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE: i32 = 2;
pub const WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE: i32 = 3;
pub const WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE: i32 = 4;
pub const WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE: i32 = 5;
pub const WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE: i32 = 6;
// WEB_SOCKET_PROPERTY_TYPE
const (
	WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE int32 = 0
	WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE int32 = 1
	WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE int32 = 2
	WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE int32 = 3
	WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE int32 = 4
	WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE int32 = 5
	WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE int32 = 6
)
const
  WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE = 0;
  WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE = 1;
  WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE = 2;
  WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE = 3;
  WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE = 4;
  WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE = 5;
  WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE = 6;
// WEB_SOCKET_PROPERTY_TYPE
pub const WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE: i32 = 0;
pub const WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE: i32 = 1;
pub const WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE: i32 = 2;
pub const WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE: i32 = 3;
pub const WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE: i32 = 4;
pub const WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE: i32 = 5;
pub const WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE: i32 = 6;
const
  WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE* = 0
  WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE* = 1
  WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE* = 2
  WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE* = 3
  WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE* = 4
  WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE* = 5
  WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE* = 6
enum WEB_SOCKET_PROPERTY_TYPE : int {
    WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE = 0,
    WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE = 1,
    WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE = 2,
    WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE = 3,
    WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE = 4,
    WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE = 5,
    WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE = 6,
}
#define global WEB_SOCKET_RECEIVE_BUFFER_SIZE_PROPERTY_TYPE       0x0
#define global WEB_SOCKET_SEND_BUFFER_SIZE_PROPERTY_TYPE          0x1
#define global WEB_SOCKET_DISABLE_MASKING_PROPERTY_TYPE           0x2
#define global WEB_SOCKET_ALLOCATED_BUFFER_PROPERTY_TYPE          0x3
#define global WEB_SOCKET_DISABLE_UTF8_VERIFICATION_PROPERTY_TYPE 0x4
#define global WEB_SOCKET_KEEPALIVE_INTERVAL_PROPERTY_TYPE        0x5
#define global WEB_SOCKET_SUPPORTED_VERSIONS_PROPERTY_TYPE        0x6