ホーム › Networking.WebSocket › WebSocketBeginServerHandshake
WebSocketBeginServerHandshake
関数WebSocketサーバーのハンドシェイクを開始する。
シグネチャ
// 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 |
| pszSubprotocolSelected | LPCSTR | inoptional |
| pszExtensionSelected | LPCSTR* | inoptional |
| ulExtensionSelectedCount | DWORD | in |
| pRequestHeaders | WEB_SOCKET_HTTP_HEADER* | in |
| ulRequestHeaderCount | DWORD | in |
| pResponseHeaders | WEB_SOCKET_HTTP_HEADER** | out |
| pulResponseHeaderCount | DWORD* | out |
戻り値の型: 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 // HRESULTfunction 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)。