ホーム › Networking.WebSocket › WebSocketBeginServerHandshake

WebSocketBeginServerHandshake

関数

WebSocketサーバーのハンドシェイクを開始する。

DLLwebsocket.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT WebSocketBeginServerHandshake(
    WEB_SOCKET_HANDLE hWebSocket,
    LPCSTR pszSubprotocolSelected,   // optional
    LPCSTR* pszExtensionSelected,   // optional
    DWORD ulExtensionSelectedCount,
    const WEB_SOCKET_HTTP_HEADER* pRequestHeaders,
    DWORD ulRequestHeaderCount,
    WEB_SOCKET_HTTP_HEADER** pResponseHeaders,
    DWORD* pulResponseHeaderCount
);

パラメーター

名前	型	方向	説明
hWebSocket	WEB_SOCKET_HANDLE	in	対象のWebSocketセッションハンドル。
pszSubprotocolSelected	LPCSTR	inoptional	サーバーが選択したサブプロトコル名。なければNULL可。
pszExtensionSelected	LPCSTR*	inoptional	サーバーが選択した拡張名の文字列配列。NULL可。
ulExtensionSelectedCount	DWORD	in	pszExtensionSelected配列の要素数。
pRequestHeaders	WEB_SOCKET_HTTP_HEADER*	in	クライアントから受信したハンドシェイク要求HTTPヘッダー配列。
ulRequestHeaderCount	DWORD	in	pRequestHeaders配列の要素数。
pResponseHeaders	WEB_SOCKET_HTTP_HEADER**	out	生成された応答HTTPヘッダー配列を受け取る出力ポインタ。
pulResponseHeaderCount	DWORD*	out	pResponseHeaders配列の要素数を受け取る出力ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WebSocketBeginServerHandshake(
    WEB_SOCKET_HANDLE hWebSocket,
    LPCSTR pszSubprotocolSelected,   // optional
    LPCSTR* pszExtensionSelected,   // optional
    DWORD ulExtensionSelectedCount,
    const WEB_SOCKET_HTTP_HEADER* pRequestHeaders,
    DWORD ulRequestHeaderCount,
    WEB_SOCKET_HTTP_HEADER** pResponseHeaders,
    DWORD* pulResponseHeaderCount
);

[DllImport("websocket.dll", ExactSpelling = true)]
static extern int WebSocketBeginServerHandshake(
    IntPtr hWebSocket,   // WEB_SOCKET_HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string pszSubprotocolSelected,   // LPCSTR optional
    IntPtr pszExtensionSelected,   // LPCSTR* optional
    uint ulExtensionSelectedCount,   // DWORD
    IntPtr pRequestHeaders,   // WEB_SOCKET_HTTP_HEADER*
    uint ulRequestHeaderCount,   // DWORD
    IntPtr pResponseHeaders,   // WEB_SOCKET_HTTP_HEADER** out
    out uint pulResponseHeaderCount   // DWORD* out
);

<DllImport("websocket.dll", ExactSpelling:=True)>
Public Shared Function WebSocketBeginServerHandshake(
    hWebSocket As IntPtr,   ' WEB_SOCKET_HANDLE
    <MarshalAs(UnmanagedType.LPStr)> pszSubprotocolSelected As String,   ' LPCSTR optional
    pszExtensionSelected As IntPtr,   ' LPCSTR* optional
    ulExtensionSelectedCount As UInteger,   ' DWORD
    pRequestHeaders As IntPtr,   ' WEB_SOCKET_HTTP_HEADER*
    ulRequestHeaderCount As UInteger,   ' DWORD
    pResponseHeaders As IntPtr,   ' WEB_SOCKET_HTTP_HEADER** out
    <Out> ByRef pulResponseHeaderCount As UInteger   ' DWORD* out
) As Integer
End Function

' hWebSocket : WEB_SOCKET_HANDLE
' pszSubprotocolSelected : LPCSTR optional
' pszExtensionSelected : LPCSTR* optional
' ulExtensionSelectedCount : DWORD
' pRequestHeaders : WEB_SOCKET_HTTP_HEADER*
' ulRequestHeaderCount : DWORD
' pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out
' pulResponseHeaderCount : DWORD* out
Declare PtrSafe Function WebSocketBeginServerHandshake Lib "websocket" ( _
    ByVal hWebSocket As LongPtr, _
    ByVal pszSubprotocolSelected As String, _
    ByVal pszExtensionSelected As LongPtr, _
    ByVal ulExtensionSelectedCount As Long, _
    ByVal pRequestHeaders As LongPtr, _
    ByVal ulRequestHeaderCount As Long, _
    ByVal pResponseHeaders As LongPtr, _
    ByRef pulResponseHeaderCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WebSocketBeginServerHandshake = ctypes.windll.websocket.WebSocketBeginServerHandshake
WebSocketBeginServerHandshake.restype = ctypes.c_int
WebSocketBeginServerHandshake.argtypes = [
    wintypes.HANDLE,  # hWebSocket : WEB_SOCKET_HANDLE
    wintypes.LPCSTR,  # pszSubprotocolSelected : LPCSTR optional
    ctypes.c_void_p,  # pszExtensionSelected : LPCSTR* optional
    wintypes.DWORD,  # ulExtensionSelectedCount : DWORD
    ctypes.c_void_p,  # pRequestHeaders : WEB_SOCKET_HTTP_HEADER*
    wintypes.DWORD,  # ulRequestHeaderCount : DWORD
    ctypes.c_void_p,  # pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out
    ctypes.POINTER(wintypes.DWORD),  # pulResponseHeaderCount : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('websocket.dll')
WebSocketBeginServerHandshake = Fiddle::Function.new(
  lib['WebSocketBeginServerHandshake'],
  [
    Fiddle::TYPE_VOIDP,  # hWebSocket : WEB_SOCKET_HANDLE
    Fiddle::TYPE_VOIDP,  # pszSubprotocolSelected : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # pszExtensionSelected : LPCSTR* optional
    -Fiddle::TYPE_INT,  # ulExtensionSelectedCount : DWORD
    Fiddle::TYPE_VOIDP,  # pRequestHeaders : WEB_SOCKET_HTTP_HEADER*
    -Fiddle::TYPE_INT,  # ulRequestHeaderCount : DWORD
    Fiddle::TYPE_VOIDP,  # pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out
    Fiddle::TYPE_VOIDP,  # pulResponseHeaderCount : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "websocket")]
extern "system" {
    fn WebSocketBeginServerHandshake(
        hWebSocket: *mut core::ffi::c_void,  // WEB_SOCKET_HANDLE
        pszSubprotocolSelected: *const u8,  // LPCSTR optional
        pszExtensionSelected: *const *const u8,  // LPCSTR* optional
        ulExtensionSelectedCount: u32,  // DWORD
        pRequestHeaders: *const WEB_SOCKET_HTTP_HEADER,  // WEB_SOCKET_HTTP_HEADER*
        ulRequestHeaderCount: u32,  // DWORD
        pResponseHeaders: *mut *mut WEB_SOCKET_HTTP_HEADER,  // WEB_SOCKET_HTTP_HEADER** out
        pulResponseHeaderCount: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("websocket.dll")]
public static extern int WebSocketBeginServerHandshake(IntPtr hWebSocket, [MarshalAs(UnmanagedType.LPStr)] string pszSubprotocolSelected, IntPtr pszExtensionSelected, uint ulExtensionSelectedCount, IntPtr pRequestHeaders, uint ulRequestHeaderCount, IntPtr pResponseHeaders, out uint pulResponseHeaderCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'websocket_WebSocketBeginServerHandshake' -Namespace Win32 -PassThru
# $api::WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount)

#uselib "websocket.dll"
#func global WebSocketBeginServerHandshake "WebSocketBeginServerHandshake" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WebSocketBeginServerHandshake hWebSocket, pszSubprotocolSelected, varptr(pszExtensionSelected), ulExtensionSelectedCount, varptr(pRequestHeaders), ulRequestHeaderCount, varptr(pResponseHeaders), varptr(pulResponseHeaderCount)   ; 戻り値は stat
; hWebSocket : WEB_SOCKET_HANDLE -> "sptr"
; pszSubprotocolSelected : LPCSTR optional -> "sptr"
; pszExtensionSelected : LPCSTR* optional -> "sptr"
; ulExtensionSelectedCount : DWORD -> "sptr"
; pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> "sptr"
; ulRequestHeaderCount : DWORD -> "sptr"
; pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> "sptr"
; pulResponseHeaderCount : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "websocket.dll"
#cfunc global WebSocketBeginServerHandshake "WebSocketBeginServerHandshake" sptr, str, var, int, var, int, var, var
; res = WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount)
; hWebSocket : WEB_SOCKET_HANDLE -> "sptr"
; pszSubprotocolSelected : LPCSTR optional -> "str"
; pszExtensionSelected : LPCSTR* optional -> "var"
; ulExtensionSelectedCount : DWORD -> "int"
; pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> "var"
; ulRequestHeaderCount : DWORD -> "int"
; pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> "var"
; pulResponseHeaderCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "websocket.dll"
#cfunc global WebSocketBeginServerHandshake "WebSocketBeginServerHandshake" sptr, str, sptr, int, sptr, int, sptr, sptr
; res = WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, varptr(pszExtensionSelected), ulExtensionSelectedCount, varptr(pRequestHeaders), ulRequestHeaderCount, varptr(pResponseHeaders), varptr(pulResponseHeaderCount))
; hWebSocket : WEB_SOCKET_HANDLE -> "sptr"
; pszSubprotocolSelected : LPCSTR optional -> "str"
; pszExtensionSelected : LPCSTR* optional -> "sptr"
; ulExtensionSelectedCount : DWORD -> "int"
; pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> "sptr"
; ulRequestHeaderCount : DWORD -> "int"
; pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> "sptr"
; pulResponseHeaderCount : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; HRESULT WebSocketBeginServerHandshake(WEB_SOCKET_HANDLE hWebSocket, LPCSTR pszSubprotocolSelected, LPCSTR* pszExtensionSelected, DWORD ulExtensionSelectedCount, WEB_SOCKET_HTTP_HEADER* pRequestHeaders, DWORD ulRequestHeaderCount, WEB_SOCKET_HTTP_HEADER** pResponseHeaders, DWORD* pulResponseHeaderCount)
#uselib "websocket.dll"
#cfunc global WebSocketBeginServerHandshake "WebSocketBeginServerHandshake" intptr, str, var, int, var, int, var, var
; res = WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount)
; hWebSocket : WEB_SOCKET_HANDLE -> "intptr"
; pszSubprotocolSelected : LPCSTR optional -> "str"
; pszExtensionSelected : LPCSTR* optional -> "var"
; ulExtensionSelectedCount : DWORD -> "int"
; pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> "var"
; ulRequestHeaderCount : DWORD -> "int"
; pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> "var"
; pulResponseHeaderCount : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT WebSocketBeginServerHandshake(WEB_SOCKET_HANDLE hWebSocket, LPCSTR pszSubprotocolSelected, LPCSTR* pszExtensionSelected, DWORD ulExtensionSelectedCount, WEB_SOCKET_HTTP_HEADER* pRequestHeaders, DWORD ulRequestHeaderCount, WEB_SOCKET_HTTP_HEADER** pResponseHeaders, DWORD* pulResponseHeaderCount)
#uselib "websocket.dll"
#cfunc global WebSocketBeginServerHandshake "WebSocketBeginServerHandshake" intptr, str, intptr, int, intptr, int, intptr, intptr
; res = WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, varptr(pszExtensionSelected), ulExtensionSelectedCount, varptr(pRequestHeaders), ulRequestHeaderCount, varptr(pResponseHeaders), varptr(pulResponseHeaderCount))
; hWebSocket : WEB_SOCKET_HANDLE -> "intptr"
; pszSubprotocolSelected : LPCSTR optional -> "str"
; pszExtensionSelected : LPCSTR* optional -> "intptr"
; ulExtensionSelectedCount : DWORD -> "int"
; pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> "intptr"
; ulRequestHeaderCount : DWORD -> "int"
; pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> "intptr"
; pulResponseHeaderCount : DWORD* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	websocket = windows.NewLazySystemDLL("websocket.dll")
	procWebSocketBeginServerHandshake = websocket.NewProc("WebSocketBeginServerHandshake")
)

// hWebSocket (WEB_SOCKET_HANDLE), pszSubprotocolSelected (LPCSTR optional), pszExtensionSelected (LPCSTR* optional), ulExtensionSelectedCount (DWORD), pRequestHeaders (WEB_SOCKET_HTTP_HEADER*), ulRequestHeaderCount (DWORD), pResponseHeaders (WEB_SOCKET_HTTP_HEADER** out), pulResponseHeaderCount (DWORD* out)
r1, _, err := procWebSocketBeginServerHandshake.Call(
	uintptr(hWebSocket),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszSubprotocolSelected))),
	uintptr(pszExtensionSelected),
	uintptr(ulExtensionSelectedCount),
	uintptr(pRequestHeaders),
	uintptr(ulRequestHeaderCount),
	uintptr(pResponseHeaders),
	uintptr(pulResponseHeaderCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function WebSocketBeginServerHandshake(
  hWebSocket: THandle;   // WEB_SOCKET_HANDLE
  pszSubprotocolSelected: PAnsiChar;   // LPCSTR optional
  pszExtensionSelected: PPAnsiChar;   // LPCSTR* optional
  ulExtensionSelectedCount: DWORD;   // DWORD
  pRequestHeaders: Pointer;   // WEB_SOCKET_HTTP_HEADER*
  ulRequestHeaderCount: DWORD;   // DWORD
  pResponseHeaders: Pointer;   // WEB_SOCKET_HTTP_HEADER** out
  pulResponseHeaderCount: Pointer   // DWORD* out
): Integer; stdcall;
  external 'websocket.dll' name 'WebSocketBeginServerHandshake';

result := DllCall("websocket\WebSocketBeginServerHandshake"
    , "Ptr", hWebSocket   ; WEB_SOCKET_HANDLE
    , "AStr", pszSubprotocolSelected   ; LPCSTR optional
    , "Ptr", pszExtensionSelected   ; LPCSTR* optional
    , "UInt", ulExtensionSelectedCount   ; DWORD
    , "Ptr", pRequestHeaders   ; WEB_SOCKET_HTTP_HEADER*
    , "UInt", ulRequestHeaderCount   ; DWORD
    , "Ptr", pResponseHeaders   ; WEB_SOCKET_HTTP_HEADER** out
    , "Ptr", pulResponseHeaderCount   ; DWORD* out
    , "Int")   ; return: HRESULT

●WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount) = DLL("websocket.dll", "int WebSocketBeginServerHandshake(void*, char*, void*, dword, void*, dword, void*, void*)")
# 呼び出し: WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount)
# hWebSocket : WEB_SOCKET_HANDLE -> "void*"
# pszSubprotocolSelected : LPCSTR optional -> "char*"
# pszExtensionSelected : LPCSTR* optional -> "void*"
# ulExtensionSelectedCount : DWORD -> "dword"
# pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> "void*"
# ulRequestHeaderCount : DWORD -> "dword"
# pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> "void*"
# pulResponseHeaderCount : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "websocket" fn WebSocketBeginServerHandshake(
    hWebSocket: ?*anyopaque, // WEB_SOCKET_HANDLE
    pszSubprotocolSelected: [*c]const u8, // LPCSTR optional
    pszExtensionSelected: [*c][*c]u8, // LPCSTR* optional
    ulExtensionSelectedCount: u32, // DWORD
    pRequestHeaders: [*c]WEB_SOCKET_HTTP_HEADER, // WEB_SOCKET_HTTP_HEADER*
    ulRequestHeaderCount: u32, // DWORD
    pResponseHeaders: [*c][*c]WEB_SOCKET_HTTP_HEADER, // WEB_SOCKET_HTTP_HEADER** out
    pulResponseHeaderCount: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;

proc WebSocketBeginServerHandshake(
    hWebSocket: pointer,  # WEB_SOCKET_HANDLE
    pszSubprotocolSelected: cstring,  # LPCSTR optional
    pszExtensionSelected: ptr cstring,  # LPCSTR* optional
    ulExtensionSelectedCount: uint32,  # DWORD
    pRequestHeaders: ptr WEB_SOCKET_HTTP_HEADER,  # WEB_SOCKET_HTTP_HEADER*
    ulRequestHeaderCount: uint32,  # DWORD
    pResponseHeaders: ptr WEB_SOCKET_HTTP_HEADER,  # WEB_SOCKET_HTTP_HEADER** out
    pulResponseHeaderCount: ptr uint32  # DWORD* out
): int32 {.importc: "WebSocketBeginServerHandshake", stdcall, dynlib: "websocket.dll".}

pragma(lib, "websocket");
extern(Windows)
int WebSocketBeginServerHandshake(
    void* hWebSocket,   // WEB_SOCKET_HANDLE
    const(char)* pszSubprotocolSelected,   // LPCSTR optional
    char** pszExtensionSelected,   // LPCSTR* optional
    uint ulExtensionSelectedCount,   // DWORD
    WEB_SOCKET_HTTP_HEADER* pRequestHeaders,   // WEB_SOCKET_HTTP_HEADER*
    uint ulRequestHeaderCount,   // DWORD
    WEB_SOCKET_HTTP_HEADER** pResponseHeaders,   // WEB_SOCKET_HTTP_HEADER** out
    uint* pulResponseHeaderCount   // DWORD* out
);

ccall((:WebSocketBeginServerHandshake, "websocket.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Ptr{Ptr{UInt8}}, UInt32, Ptr{WEB_SOCKET_HTTP_HEADER}, UInt32, Ptr{WEB_SOCKET_HTTP_HEADER}, Ptr{UInt32}),
      hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount)
# hWebSocket : WEB_SOCKET_HANDLE -> Ptr{Cvoid}
# pszSubprotocolSelected : LPCSTR optional -> Cstring
# pszExtensionSelected : LPCSTR* optional -> Ptr{Ptr{UInt8}}
# ulExtensionSelectedCount : DWORD -> UInt32
# pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> Ptr{WEB_SOCKET_HTTP_HEADER}
# ulRequestHeaderCount : DWORD -> UInt32
# pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> Ptr{WEB_SOCKET_HTTP_HEADER}
# pulResponseHeaderCount : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t WebSocketBeginServerHandshake(
    void* hWebSocket,
    const char* pszSubprotocolSelected,
    char** pszExtensionSelected,
    uint32_t ulExtensionSelectedCount,
    void* pRequestHeaders,
    uint32_t ulRequestHeaderCount,
    void* pResponseHeaders,
    uint32_t* pulResponseHeaderCount);
]]
local websocket = ffi.load("websocket")
-- websocket.WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount)
-- hWebSocket : WEB_SOCKET_HANDLE
-- pszSubprotocolSelected : LPCSTR optional
-- pszExtensionSelected : LPCSTR* optional
-- ulExtensionSelectedCount : DWORD
-- pRequestHeaders : WEB_SOCKET_HTTP_HEADER*
-- ulRequestHeaderCount : DWORD
-- pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out
-- pulResponseHeaderCount : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('websocket.dll');
const WebSocketBeginServerHandshake = lib.func('__stdcall', 'WebSocketBeginServerHandshake', 'int32_t', ['void *', 'str', 'void *', 'uint32_t', 'void *', 'uint32_t', 'void *', 'uint32_t *']);
// WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount)
// hWebSocket : WEB_SOCKET_HANDLE -> 'void *'
// pszSubprotocolSelected : LPCSTR optional -> 'str'
// pszExtensionSelected : LPCSTR* optional -> 'void *'
// ulExtensionSelectedCount : DWORD -> 'uint32_t'
// pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> 'void *'
// ulRequestHeaderCount : DWORD -> 'uint32_t'
// pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> 'void *'
// pulResponseHeaderCount : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("websocket.dll", {
  WebSocketBeginServerHandshake: { parameters: ["pointer", "buffer", "pointer", "u32", "pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount)
// hWebSocket : WEB_SOCKET_HANDLE -> "pointer"
// pszSubprotocolSelected : LPCSTR optional -> "buffer"
// pszExtensionSelected : LPCSTR* optional -> "pointer"
// ulExtensionSelectedCount : DWORD -> "u32"
// pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> "pointer"
// ulRequestHeaderCount : DWORD -> "u32"
// pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> "pointer"
// pulResponseHeaderCount : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t WebSocketBeginServerHandshake(
    void* hWebSocket,
    const char* pszSubprotocolSelected,
    char** pszExtensionSelected,
    uint32_t ulExtensionSelectedCount,
    void* pRequestHeaders,
    uint32_t ulRequestHeaderCount,
    void* pResponseHeaders,
    uint32_t* pulResponseHeaderCount);
C, "websocket.dll");
// $ffi->WebSocketBeginServerHandshake(hWebSocket, pszSubprotocolSelected, pszExtensionSelected, ulExtensionSelectedCount, pRequestHeaders, ulRequestHeaderCount, pResponseHeaders, pulResponseHeaderCount);
// hWebSocket : WEB_SOCKET_HANDLE
// pszSubprotocolSelected : LPCSTR optional
// pszExtensionSelected : LPCSTR* optional
// ulExtensionSelectedCount : DWORD
// pRequestHeaders : WEB_SOCKET_HTTP_HEADER*
// ulRequestHeaderCount : DWORD
// pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out
// pulResponseHeaderCount : DWORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。

import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Websocket extends StdCallLibrary {
    Websocket INSTANCE = Native.load("websocket", Websocket.class);
    int WebSocketBeginServerHandshake(
        Pointer hWebSocket,   // WEB_SOCKET_HANDLE
        String pszSubprotocolSelected,   // LPCSTR optional
        PointerByReference pszExtensionSelected,   // LPCSTR* optional
        int ulExtensionSelectedCount,   // DWORD
        Pointer pRequestHeaders,   // WEB_SOCKET_HTTP_HEADER*
        int ulRequestHeaderCount,   // DWORD
        Pointer pResponseHeaders,   // WEB_SOCKET_HTTP_HEADER** out
        IntByReference pulResponseHeaderCount   // DWORD* out
    );
}

@[Link("websocket")]
lib Libwebsocket
  fun WebSocketBeginServerHandshake = WebSocketBeginServerHandshake(
    hWebSocket : Void*,   # WEB_SOCKET_HANDLE
    pszSubprotocolSelected : UInt8*,   # LPCSTR optional
    pszExtensionSelected : UInt8**,   # LPCSTR* optional
    ulExtensionSelectedCount : UInt32,   # DWORD
    pRequestHeaders : WEB_SOCKET_HTTP_HEADER*,   # WEB_SOCKET_HTTP_HEADER*
    ulRequestHeaderCount : UInt32,   # DWORD
    pResponseHeaders : WEB_SOCKET_HTTP_HEADER**,   # WEB_SOCKET_HTTP_HEADER** out
    pulResponseHeaderCount : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WebSocketBeginServerHandshakeNative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Pointer<Utf8>>, Uint32, Pointer<Void>, Uint32, Pointer<Void>, Pointer<Uint32>);
typedef WebSocketBeginServerHandshakeDart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Pointer<Utf8>>, int, Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>);
final WebSocketBeginServerHandshake = DynamicLibrary.open('websocket.dll')
    .lookupFunction<WebSocketBeginServerHandshakeNative, WebSocketBeginServerHandshakeDart>('WebSocketBeginServerHandshake');
// hWebSocket : WEB_SOCKET_HANDLE -> Pointer<Void>
// pszSubprotocolSelected : LPCSTR optional -> Pointer<Utf8>
// pszExtensionSelected : LPCSTR* optional -> Pointer<Pointer<Utf8>>
// ulExtensionSelectedCount : DWORD -> Uint32
// pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> Pointer<Void>
// ulRequestHeaderCount : DWORD -> Uint32
// pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> Pointer<Void>
// pulResponseHeaderCount : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function WebSocketBeginServerHandshake(
  hWebSocket: THandle;   // WEB_SOCKET_HANDLE
  pszSubprotocolSelected: PAnsiChar;   // LPCSTR optional
  pszExtensionSelected: PPAnsiChar;   // LPCSTR* optional
  ulExtensionSelectedCount: DWORD;   // DWORD
  pRequestHeaders: Pointer;   // WEB_SOCKET_HTTP_HEADER*
  ulRequestHeaderCount: DWORD;   // DWORD
  pResponseHeaders: Pointer;   // WEB_SOCKET_HTTP_HEADER** out
  pulResponseHeaderCount: Pointer   // DWORD* out
): Integer; stdcall;
  external 'websocket.dll' name 'WebSocketBeginServerHandshake';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WebSocketBeginServerHandshake"
  c_WebSocketBeginServerHandshake :: Ptr () -> CString -> Ptr CString -> Word32 -> Ptr () -> Word32 -> Ptr () -> Ptr Word32 -> IO Int32
-- hWebSocket : WEB_SOCKET_HANDLE -> Ptr ()
-- pszSubprotocolSelected : LPCSTR optional -> CString
-- pszExtensionSelected : LPCSTR* optional -> Ptr CString
-- ulExtensionSelectedCount : DWORD -> Word32
-- pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> Ptr ()
-- ulRequestHeaderCount : DWORD -> Word32
-- pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> Ptr ()
-- pulResponseHeaderCount : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let websocketbeginserverhandshake =
  foreign "WebSocketBeginServerHandshake"
    ((ptr void) @-> string @-> (ptr string) @-> uint32_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* hWebSocket : WEB_SOCKET_HANDLE -> (ptr void) *)
(* pszSubprotocolSelected : LPCSTR optional -> string *)
(* pszExtensionSelected : LPCSTR* optional -> (ptr string) *)
(* ulExtensionSelectedCount : DWORD -> uint32_t *)
(* pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> (ptr void) *)
(* ulRequestHeaderCount : DWORD -> uint32_t *)
(* pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> (ptr void) *)
(* pulResponseHeaderCount : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library websocket (t "websocket.dll"))
(cffi:use-foreign-library websocket)

(cffi:defcfun ("WebSocketBeginServerHandshake" web-socket-begin-server-handshake :convention :stdcall) :int32
  (h-web-socket :pointer)   ; WEB_SOCKET_HANDLE
  (psz-subprotocol-selected :string)   ; LPCSTR optional
  (psz-extension-selected :pointer)   ; LPCSTR* optional
  (ul-extension-selected-count :uint32)   ; DWORD
  (p-request-headers :pointer)   ; WEB_SOCKET_HTTP_HEADER*
  (ul-request-header-count :uint32)   ; DWORD
  (p-response-headers :pointer)   ; WEB_SOCKET_HTTP_HEADER** out
  (pul-response-header-count :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $WebSocketBeginServerHandshake = Win32::API::More->new('websocket',
    'int WebSocketBeginServerHandshake(HANDLE hWebSocket, LPCSTR pszSubprotocolSelected, LPVOID pszExtensionSelected, DWORD ulExtensionSelectedCount, LPVOID pRequestHeaders, DWORD ulRequestHeaderCount, LPVOID pResponseHeaders, LPVOID pulResponseHeaderCount)');
# my $ret = $WebSocketBeginServerHandshake->Call($hWebSocket, $pszSubprotocolSelected, $pszExtensionSelected, $ulExtensionSelectedCount, $pRequestHeaders, $ulRequestHeaderCount, $pResponseHeaders, $pulResponseHeaderCount);
# hWebSocket : WEB_SOCKET_HANDLE -> HANDLE
# pszSubprotocolSelected : LPCSTR optional -> LPCSTR
# pszExtensionSelected : LPCSTR* optional -> LPVOID
# ulExtensionSelectedCount : DWORD -> DWORD
# pRequestHeaders : WEB_SOCKET_HTTP_HEADER* -> LPVOID
# ulRequestHeaderCount : DWORD -> DWORD
# pResponseHeaders : WEB_SOCKET_HTTP_HEADER** out -> LPVOID
# pulResponseHeaderCount : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

WebSocketBeginServerHandshake

シグネチャ

パラメーター

各言語での呼び出し定義

関連項目