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

LINGER

構造体
サイズx64: 4 バイト / x86: 4 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
l_onoffWORD2+0+0

キューに入れられたデータを送信できるようにするため、 closesocket 関数の呼び出し後もソケットを指定した時間だけ開いたままにするかどうかを指定します。このメンバーには次のいずれかの値を指定できます。

意味
0
ソケットは開いたままになりません。この値は、setsockopt 関数が optname パラメーターに SO_DONTLINGER を指定し、optval パラメーターが 0 の状態で呼び出された場合に設定されます。

また、setsockopt 関数が optname パラメーターに SO_LINGER を指定して呼び出され、optval パラメーターで渡された linger 構造体の l_onoff メンバーが 0 に設定されている場合にも、この値が設定されます。

0 以外
ソケットは指定した時間だけ開いたままになります。この値は、setsockopt 関数が optname パラメーターに SO_DONTLINGER を指定し、optval パラメーターが 0 以外の状態で呼び出された場合に設定されます。

また、setsockopt 関数が optname パラメーターに SO_LINGER を指定して呼び出され、optval パラメーターで渡された linger 構造体の l_onoff メンバーが 0 以外の値に設定されている場合にも、この値が設定されます。

l_lingerWORD2+2+2

リンガー時間 (秒単位) です。このメンバーは、キューに入れられたデータを送信できるようにするため、 closesocket 関数の呼び出し後にどれだけの時間ソケットを開いたままにするかを指定します。このメンバーは、linger 構造体の l_onoff メンバーが 0 以外の値に設定されている場合にのみ適用されます。

この値は、setsockopt 関数が optname パラメーターに SO_LINGER を指定して呼び出された場合に設定されます。setsockopt 関数に渡す optval パラメーターには linger 構造体を格納する必要があり、その内容がソケットに対して保持される内部の linger 構造体にコピーされます。

公式ドキュメント

linger 構造体は、送信するデータがキューに入れられた状態でそのソケットに対して closesocket 関数が呼び出されたときに、そのソケットがどのように動作するかを指定する情報を保持します。

解説(Remarks)

linger 構造体の l_onoff メンバーは、キューに入れられたデータを送信できるようにするため、 closesocket 関数の呼び出し後もソケットを指定した時間だけ開いたままにするかどうかを決定します。やや分かりにくい点として、このメンバーは次の 2 とおりの方法で変更できます。

linger 構造体の l_linger メンバーは、ソケットを開いたままにする時間を秒単位で決定します。このメンバーは、linger 構造体の l_onoff メンバーが 0 以外の場合にのみ適用されます。

ソケットを開いたままにするには、アプリケーションは l_onoff メンバーに 0 以外の値を設定し、l_linger メンバーに希望するタイムアウト値を秒単位で設定します。ソケットを開いたままにしないようにするには、アプリケーションは linger 構造体の l_onoff メンバーを 0 に設定するだけで済みます。

アプリケーションが setsockopt 関数を optname パラメーターに SO_DONTLINGER を指定して呼び出し、l_onoff メンバーに 0 以外の値を設定した場合、l_linger メンバーの値は指定されません。この場合、使用されるタイムアウト値は実装依存です。そのソケットに対して以前にタイムアウト値が (SO_LINGER を有効にすることで) 設定されていた場合、サービスプロバイダーはそのタイムアウト値を復元することになっています。

ノンブロッキングソケットで 0 以外のタイムアウトを有効にすることは推奨されないことに注意してください。

getsockopt 関数を optname パラメーターに SO_LINGER を指定して呼び出すと、ソケットに関連付けられた linger 構造体の現在の値を取得できます。

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

各言語での定義

#include <windows.h>

// LINGER  (x64 4 / x86 4 バイト)
typedef struct LINGER {
    WORD l_onoff;
    WORD l_linger;
} LINGER;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct LINGER
{
    public ushort l_onoff;
    public ushort l_linger;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure LINGER
    Public l_onoff As UShort
    Public l_linger As UShort
End Structure
import ctypes
from ctypes import wintypes

class LINGER(ctypes.Structure):
    _fields_ = [
        ("l_onoff", ctypes.c_ushort),
        ("l_linger", ctypes.c_ushort),
    ]
#[repr(C)]
pub struct LINGER {
    pub l_onoff: u16,
    pub l_linger: u16,
}
import "golang.org/x/sys/windows"

type LINGER struct {
	l_onoff uint16
	l_linger uint16
}
type
  LINGER = record
    l_onoff: Word;
    l_linger: Word;
  end;
const LINGER = extern struct {
    l_onoff: u16,
    l_linger: u16,
};
type
  LINGER {.bycopy.} = object
    l_onoff: uint16
    l_linger: uint16
struct LINGER
{
    ushort l_onoff;
    ushort l_linger;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; LINGER サイズ: 4 バイト(x64)
dim st, 1    ; 4byte整数×1(構造体サイズ 4 / 4 切り上げ)
; l_onoff : WORD (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; l_linger : WORD (+2, 2byte)  wpoke st,2,値  /  値 = wpeek(st,2)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global LINGER
    #field short l_onoff
    #field short l_linger
#endstruct

stdim st, LINGER        ; NSTRUCT 変数を確保
st->l_onoff = 100
mes "l_onoff=" + st->l_onoff