ホーム › Networking.WebSocket › WebSocketReceive
WebSocketReceive
関数WebSocket経由でデータバッファを受信する。
シグネチャ
// websocket.dll
#include <windows.h>
HRESULT WebSocketReceive(
WEB_SOCKET_HANDLE hWebSocket,
WEB_SOCKET_BUFFER* pBuffer, // optional
void* pvContext // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hWebSocket | WEB_SOCKET_HANDLE | in | 対象のWebSocketセッションハンドル。 |
| pBuffer | WEB_SOCKET_BUFFER* | inoptional | 受信データの格納先WEB_SOCKET_BUFFER共用体へのポインタ。NULLで内部既定を使用可。 |
| pvContext | void* | inoptional | 操作に関連付けるアプリケーション定義のコンテキスト値。NULL可。 |
戻り値の型: HRESULT
各言語での呼び出し定義
// websocket.dll
#include <windows.h>
HRESULT WebSocketReceive(
WEB_SOCKET_HANDLE hWebSocket,
WEB_SOCKET_BUFFER* pBuffer, // optional
void* pvContext // optional
);[DllImport("websocket.dll", ExactSpelling = true)]
static extern int WebSocketReceive(
IntPtr hWebSocket, // WEB_SOCKET_HANDLE
IntPtr pBuffer, // WEB_SOCKET_BUFFER* optional
IntPtr pvContext // void* optional
);<DllImport("websocket.dll", ExactSpelling:=True)>
Public Shared Function WebSocketReceive(
hWebSocket As IntPtr, ' WEB_SOCKET_HANDLE
pBuffer As IntPtr, ' WEB_SOCKET_BUFFER* optional
pvContext As IntPtr ' void* optional
) As Integer
End Function' hWebSocket : WEB_SOCKET_HANDLE
' pBuffer : WEB_SOCKET_BUFFER* optional
' pvContext : void* optional
Declare PtrSafe Function WebSocketReceive Lib "websocket" ( _
ByVal hWebSocket As LongPtr, _
ByVal pBuffer As LongPtr, _
ByVal pvContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
WebSocketReceive = ctypes.windll.websocket.WebSocketReceive
WebSocketReceive.restype = ctypes.c_int
WebSocketReceive.argtypes = [
wintypes.HANDLE, # hWebSocket : WEB_SOCKET_HANDLE
ctypes.c_void_p, # pBuffer : WEB_SOCKET_BUFFER* optional
ctypes.POINTER(None), # pvContext : void* optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('websocket.dll')
WebSocketReceive = Fiddle::Function.new(
lib['WebSocketReceive'],
[
Fiddle::TYPE_VOIDP, # hWebSocket : WEB_SOCKET_HANDLE
Fiddle::TYPE_VOIDP, # pBuffer : WEB_SOCKET_BUFFER* optional
Fiddle::TYPE_VOIDP, # pvContext : void* optional
],
Fiddle::TYPE_INT)#[link(name = "websocket")]
extern "system" {
fn WebSocketReceive(
hWebSocket: *mut core::ffi::c_void, // WEB_SOCKET_HANDLE
pBuffer: *mut WEB_SOCKET_BUFFER, // WEB_SOCKET_BUFFER* optional
pvContext: *mut () // void* optional
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("websocket.dll")]
public static extern int WebSocketReceive(IntPtr hWebSocket, IntPtr pBuffer, IntPtr pvContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'websocket_WebSocketReceive' -Namespace Win32 -PassThru
# $api::WebSocketReceive(hWebSocket, pBuffer, pvContext)#uselib "websocket.dll"
#func global WebSocketReceive "WebSocketReceive" sptr, sptr, sptr
; WebSocketReceive hWebSocket, varptr(pBuffer), pvContext ; 戻り値は stat
; hWebSocket : WEB_SOCKET_HANDLE -> "sptr"
; pBuffer : WEB_SOCKET_BUFFER* optional -> "sptr"
; pvContext : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "websocket.dll" #cfunc global WebSocketReceive "WebSocketReceive" sptr, var, sptr ; res = WebSocketReceive(hWebSocket, pBuffer, pvContext) ; hWebSocket : WEB_SOCKET_HANDLE -> "sptr" ; pBuffer : WEB_SOCKET_BUFFER* optional -> "var" ; pvContext : void* optional -> "sptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "websocket.dll" #cfunc global WebSocketReceive "WebSocketReceive" sptr, sptr, sptr ; res = WebSocketReceive(hWebSocket, varptr(pBuffer), pvContext) ; hWebSocket : WEB_SOCKET_HANDLE -> "sptr" ; pBuffer : WEB_SOCKET_BUFFER* optional -> "sptr" ; pvContext : void* optional -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT WebSocketReceive(WEB_SOCKET_HANDLE hWebSocket, WEB_SOCKET_BUFFER* pBuffer, void* pvContext) #uselib "websocket.dll" #cfunc global WebSocketReceive "WebSocketReceive" intptr, var, intptr ; res = WebSocketReceive(hWebSocket, pBuffer, pvContext) ; hWebSocket : WEB_SOCKET_HANDLE -> "intptr" ; pBuffer : WEB_SOCKET_BUFFER* optional -> "var" ; pvContext : void* optional -> "intptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT WebSocketReceive(WEB_SOCKET_HANDLE hWebSocket, WEB_SOCKET_BUFFER* pBuffer, void* pvContext) #uselib "websocket.dll" #cfunc global WebSocketReceive "WebSocketReceive" intptr, intptr, intptr ; res = WebSocketReceive(hWebSocket, varptr(pBuffer), pvContext) ; hWebSocket : WEB_SOCKET_HANDLE -> "intptr" ; pBuffer : WEB_SOCKET_BUFFER* optional -> "intptr" ; pvContext : void* optional -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
websocket = windows.NewLazySystemDLL("websocket.dll")
procWebSocketReceive = websocket.NewProc("WebSocketReceive")
)
// hWebSocket (WEB_SOCKET_HANDLE), pBuffer (WEB_SOCKET_BUFFER* optional), pvContext (void* optional)
r1, _, err := procWebSocketReceive.Call(
uintptr(hWebSocket),
uintptr(pBuffer),
uintptr(pvContext),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction WebSocketReceive(
hWebSocket: THandle; // WEB_SOCKET_HANDLE
pBuffer: Pointer; // WEB_SOCKET_BUFFER* optional
pvContext: Pointer // void* optional
): Integer; stdcall;
external 'websocket.dll' name 'WebSocketReceive';result := DllCall("websocket\WebSocketReceive"
, "Ptr", hWebSocket ; WEB_SOCKET_HANDLE
, "Ptr", pBuffer ; WEB_SOCKET_BUFFER* optional
, "Ptr", pvContext ; void* optional
, "Int") ; return: HRESULT●WebSocketReceive(hWebSocket, pBuffer, pvContext) = DLL("websocket.dll", "int WebSocketReceive(void*, void*, void*)")
# 呼び出し: WebSocketReceive(hWebSocket, pBuffer, pvContext)
# hWebSocket : WEB_SOCKET_HANDLE -> "void*"
# pBuffer : WEB_SOCKET_BUFFER* optional -> "void*"
# pvContext : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "websocket" fn WebSocketReceive(
hWebSocket: ?*anyopaque, // WEB_SOCKET_HANDLE
pBuffer: [*c]WEB_SOCKET_BUFFER, // WEB_SOCKET_BUFFER* optional
pvContext: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;proc WebSocketReceive(
hWebSocket: pointer, # WEB_SOCKET_HANDLE
pBuffer: ptr WEB_SOCKET_BUFFER, # WEB_SOCKET_BUFFER* optional
pvContext: pointer # void* optional
): int32 {.importc: "WebSocketReceive", stdcall, dynlib: "websocket.dll".}pragma(lib, "websocket");
extern(Windows)
int WebSocketReceive(
void* hWebSocket, // WEB_SOCKET_HANDLE
WEB_SOCKET_BUFFER* pBuffer, // WEB_SOCKET_BUFFER* optional
void* pvContext // void* optional
);ccall((:WebSocketReceive, "websocket.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{WEB_SOCKET_BUFFER}, Ptr{Cvoid}),
hWebSocket, pBuffer, pvContext)
# hWebSocket : WEB_SOCKET_HANDLE -> Ptr{Cvoid}
# pBuffer : WEB_SOCKET_BUFFER* optional -> Ptr{WEB_SOCKET_BUFFER}
# pvContext : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t WebSocketReceive(
void* hWebSocket,
void* pBuffer,
void* pvContext);
]]
local websocket = ffi.load("websocket")
-- websocket.WebSocketReceive(hWebSocket, pBuffer, pvContext)
-- hWebSocket : WEB_SOCKET_HANDLE
-- pBuffer : WEB_SOCKET_BUFFER* optional
-- pvContext : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('websocket.dll');
const WebSocketReceive = lib.func('__stdcall', 'WebSocketReceive', 'int32_t', ['void *', 'void *', 'void *']);
// WebSocketReceive(hWebSocket, pBuffer, pvContext)
// hWebSocket : WEB_SOCKET_HANDLE -> 'void *'
// pBuffer : WEB_SOCKET_BUFFER* optional -> 'void *'
// pvContext : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("websocket.dll", {
WebSocketReceive: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.WebSocketReceive(hWebSocket, pBuffer, pvContext)
// hWebSocket : WEB_SOCKET_HANDLE -> "pointer"
// pBuffer : WEB_SOCKET_BUFFER* optional -> "pointer"
// pvContext : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t WebSocketReceive(
void* hWebSocket,
void* pBuffer,
void* pvContext);
C, "websocket.dll");
// $ffi->WebSocketReceive(hWebSocket, pBuffer, pvContext);
// hWebSocket : WEB_SOCKET_HANDLE
// pBuffer : WEB_SOCKET_BUFFER* optional
// pvContext : void* optional
// 構造体/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 WebSocketReceive(
Pointer hWebSocket, // WEB_SOCKET_HANDLE
Pointer pBuffer, // WEB_SOCKET_BUFFER* optional
Pointer pvContext // void* optional
);
}@[Link("websocket")]
lib Libwebsocket
fun WebSocketReceive = WebSocketReceive(
hWebSocket : Void*, # WEB_SOCKET_HANDLE
pBuffer : WEB_SOCKET_BUFFER*, # WEB_SOCKET_BUFFER* optional
pvContext : Void* # void* optional
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef WebSocketReceiveNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef WebSocketReceiveDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final WebSocketReceive = DynamicLibrary.open('websocket.dll')
.lookupFunction<WebSocketReceiveNative, WebSocketReceiveDart>('WebSocketReceive');
// hWebSocket : WEB_SOCKET_HANDLE -> Pointer<Void>
// pBuffer : WEB_SOCKET_BUFFER* optional -> Pointer<Void>
// pvContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function WebSocketReceive(
hWebSocket: THandle; // WEB_SOCKET_HANDLE
pBuffer: Pointer; // WEB_SOCKET_BUFFER* optional
pvContext: Pointer // void* optional
): Integer; stdcall;
external 'websocket.dll' name 'WebSocketReceive';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "WebSocketReceive"
c_WebSocketReceive :: Ptr () -> Ptr () -> Ptr () -> IO Int32
-- hWebSocket : WEB_SOCKET_HANDLE -> Ptr ()
-- pBuffer : WEB_SOCKET_BUFFER* optional -> Ptr ()
-- pvContext : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let websocketreceive =
foreign "WebSocketReceive"
((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hWebSocket : WEB_SOCKET_HANDLE -> (ptr void) *)
(* pBuffer : WEB_SOCKET_BUFFER* optional -> (ptr void) *)
(* pvContext : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library websocket (t "websocket.dll"))
(cffi:use-foreign-library websocket)
(cffi:defcfun ("WebSocketReceive" web-socket-receive :convention :stdcall) :int32
(h-web-socket :pointer) ; WEB_SOCKET_HANDLE
(p-buffer :pointer) ; WEB_SOCKET_BUFFER* optional
(pv-context :pointer)) ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $WebSocketReceive = Win32::API::More->new('websocket',
'int WebSocketReceive(HANDLE hWebSocket, LPVOID pBuffer, LPVOID pvContext)');
# my $ret = $WebSocketReceive->Call($hWebSocket, $pBuffer, $pvContext);
# hWebSocket : WEB_SOCKET_HANDLE -> HANDLE
# pBuffer : WEB_SOCKET_BUFFER* optional -> LPVOID
# pvContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
使用する型