ホーム › Networking.WinSock › WSASendDisconnect

WSASendDisconnect

関数

切断時に相手へ終了データを送信する。

DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT WSASendDisconnect(
    SOCKET s,
    WSABUF* lpOutboundDisconnectData   // optional
);

パラメーター

名前	型	方向	説明
s	SOCKET	in	ソケットを識別する記述子。
lpOutboundDisconnectData	WSABUF*	inoptional	送信する切断データへのポインター。

戻り値の型: INT

公式ドキュメント

WSASendDisconnect 関数は、ソケットの接続終了を開始し、切断データを送信します。

戻り値

エラーが発生しなかった場合、 WSASendDisconnect はゼロを返します。それ以外の場合は SOCKET_ERROR の値が返され、 WSAGetLastError を呼び出すことで特定のエラーコードを取得できます。

エラーコード	意味
WSANOTINITIALISED	この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN	ネットワークサブシステムが失敗しました。
WSAENOPROTOOPT	lpOutboundDisconnectData パラメーターが NULL ではなく、切断データがサービスプロバイダーでサポートされていません。
WSAEINPROGRESS	ブロッキング型の Windows Sockets 1.1 呼び出しが進行中であるか、サービスプロバイダーがコールバック関数をまだ処理中です。
WSAENOTCONN	ソケットが接続されていません(コネクション指向のソケットのみ)。
WSAENOTSOCK	記述子がソケットではありません。
WSAEFAULT	lpOutboundDisconnectData パラメーターの全体が、ユーザーアドレス空間の有効な部分に収まっていません。

解説(Remarks)

WSASendDisconnect 関数は、コネクション指向のソケットで使用され、送信を無効にし、切断データ(存在する場合)の送信とともに接続の終了を開始します。これは shutdown (SD_SEND) と同等ですが、 WSASendDisconnect は(それをサポートするプロトコルにおいて)切断データの送信も可能にする点が異なります。

この関数が正常に発行された後は、以降の送信は許可されません。

lpOutboundDisconnectData パラメーターは、NULL でない場合、リモート側が WSARecvDisconnect を使用して取得するために送信される、送信用の切断データを格納したバッファーを指します。

注意 Windows におけるネイティブの TCP/IP 実装は、切断データをサポートしていません。切断データは、その WSAPROTOCOL_INFO 構造体に XP1_DISCONNECT_DATA フラグを持つ Windows Sockets プロバイダーでのみサポートされます。インストールされているすべてのプロバイダーの WSAPROTOCOL_INFO 構造体を取得するには、 WSAEnumProtocols 関数を使用してください。

WSASendDisconnect 関数はソケットをクローズしません。また、ソケットに関連付けられたリソースは、 closesocket が呼び出されるまで解放されません。

WSASendDisconnect 関数は、ソケットの SO_LINGER 設定にかかわらずブロックしません。

アプリケーションは、WSASendDisconnect を呼び出した後にソケットを再利用できることを当てにすべきではありません。特に、Windows Sockets プロバイダーは、そのようなソケットに対する connect/WSAConnect の使用をサポートする必要はありません。

注意 WSASendDisconnect のようなブロッキング型の Winsock 呼び出しを発行する際、Winsock は呼び出しが完了する前にネットワークイベントを待機する必要がある場合があります。この状況では Winsock はアラート可能な待機を実行し、同じスレッドでスケジュールされた非同期プロシージャ呼び出し (APC) によって中断される可能性があります。同じスレッドで進行中のブロッキング型 Winsock 呼び出しを中断した APC の内部で、別のブロッキング型 Winsock 呼び出しを発行すると、未定義の動作を引き起こすため、Winsock クライアントは決してこれを試みてはなりません。

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

各言語での呼び出し定義

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

INT WSASendDisconnect(
    SOCKET s,
    WSABUF* lpOutboundDisconnectData   // optional
);

[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int WSASendDisconnect(
    UIntPtr s,   // SOCKET
    IntPtr lpOutboundDisconnectData   // WSABUF* optional
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSASendDisconnect(
    s As UIntPtr,   ' SOCKET
    lpOutboundDisconnectData As IntPtr   ' WSABUF* optional
) As Integer
End Function

' s : SOCKET
' lpOutboundDisconnectData : WSABUF* optional
Declare PtrSafe Function WSASendDisconnect Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal lpOutboundDisconnectData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSASendDisconnect = ctypes.windll.ws2_32.WSASendDisconnect
WSASendDisconnect.restype = ctypes.c_int
WSASendDisconnect.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_void_p,  # lpOutboundDisconnectData : WSABUF* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSASendDisconnect = Fiddle::Function.new(
  lib['WSASendDisconnect'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    Fiddle::TYPE_VOIDP,  # lpOutboundDisconnectData : WSABUF* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn WSASendDisconnect(
        s: usize,  // SOCKET
        lpOutboundDisconnectData: *mut WSABUF  // WSABUF* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int WSASendDisconnect(UIntPtr s, IntPtr lpOutboundDisconnectData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSASendDisconnect' -Namespace Win32 -PassThru
# $api::WSASendDisconnect(s, lpOutboundDisconnectData)

#uselib "WS2_32.dll"
#func global WSASendDisconnect "WSASendDisconnect" sptr, sptr
; WSASendDisconnect s, varptr(lpOutboundDisconnectData)   ; 戻り値は stat
; s : SOCKET -> "sptr"
; lpOutboundDisconnectData : WSABUF* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSASendDisconnect "WSASendDisconnect" sptr, var
; res = WSASendDisconnect(s, lpOutboundDisconnectData)
; s : SOCKET -> "sptr"
; lpOutboundDisconnectData : WSABUF* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSASendDisconnect "WSASendDisconnect" sptr, sptr
; res = WSASendDisconnect(s, varptr(lpOutboundDisconnectData))
; s : SOCKET -> "sptr"
; lpOutboundDisconnectData : WSABUF* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。