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

CSADDR_INFO

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

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

フィールド

フィールドサイズx64x86説明
LocalAddrSOCKET_ADDRESS16/8+0+0

Windows ソケットのローカルアドレスです。

クライアントアプリケーションでは、ネットワークサービスへのアクセスを得るために、このアドレスを bind 関数に渡します。

ネットワークサービスでは、サービスが適切なローカルアドレスにバインドされるように、このアドレスを bind 関数に渡します。

RemoteAddrSOCKET_ADDRESS16/8+16+8

Windows ソケットのリモートアドレスです。

このリモートアドレスには、次のようないくつかの用途があります。

  • このリモートアドレスを使用して、 connect 関数でサービスに接続できます。これは、コネクション指向プロトコルを伴う send/receive 操作をアプリケーションが行う場合に便利です。
  • コネクションレス (データグラム) プロトコルで通信する場合は、このリモートアドレスを sendto 関数で使用できます。UDP などのコネクションレスプロトコルを使用している場合、通常は sendto がリモートシステムにデータを渡す方法になります。
iSocketTypeINT4+32+16

Windows ソケットの種類です。ソケットの種類に指定できる値は、Winsock2.h ヘッダーファイルで定義されています。

次の表に、Windows Sockets 2 でサポートされる値を示します。

意味
SOCK_STREAM
ストリームソケットです。これは、メッセージ境界を持たないバイトストリームとしてデータを送信するプロトコルです。このソケットの種類は、順序付けされた、信頼性のある、双方向でコネクションベースのバイトストリームを提供し、OOB データ転送機構を備えています。このソケットの種類は、インターネットアドレスファミリ (AF_INET または AF_INET6) では伝送制御プロトコル (TCP) を使用します。
SOCK_DGRAM
データグラムソケットです。このソケットの種類は、コネクションレスで信頼性がなく、固定の (通常は小さい) 最大長を持つバッファーであるデータグラムをサポートします。このソケットの種類は、インターネットアドレスファミリ (AF_INET または AF_INET6) ではユーザーデータグラムプロトコル (UDP) を使用します。

サービスは recvfrom 関数を使用してデータグラムを取得します。 listen 関数と accept 関数は、データグラムでは機能しません。

SOCK_RDM
信頼性のあるメッセージデータグラムソケットです。このソケットの種類は、データ内のメッセージ境界を保持します。この種類の例としては、Windows における Pragmatic General Multicast (PGM) マルチキャストプロトコルの実装があり、しばしば 信頼性のあるマルチキャストプログラミング と呼ばれます。
SOCK_SEQPACKET
順序付けされたパケットストリームソケットです。このソケットの種類は、データグラムに基づく疑似ストリームパケットを提供します。
iProtocolINT4+36+20

使用するプロトコルです。protocol パラメーターに指定できる選択肢は、指定したアドレスファミリおよびソケットの種類に固有です。指定可能な値は Winsock2.h および Wsrm.h ヘッダーファイルで定義されています。

Windows Vista 以降向けにリリースされた Windows SDK では、ヘッダーファイルの構成が変更されており、このパラメーターには Ws2def.h ヘッダーファイルで定義されている IPPROTO 列挙型の値のいずれかを指定できます。なお、Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用しないでください。

次の表に protocol の代表的な値を示します。ただし、他にも多くの値を指定できます。

protocol 意味
IPPROTO_TCP
6
伝送制御プロトコル (TCP) です。これは、アドレスファミリが AF_INET または AF_INET6 で、iSocketType メンバーが SOCK_STREAM の場合に指定できる値です。
IPPROTO_UDP
17
ユーザーデータグラムプロトコル (UDP) です。これは、アドレスファミリが AF_INET または AF_INET6 で、iSocketType メンバーが SOCK_DGRAM の場合に指定できる値です。
IPPROTO_RM
113
信頼性のあるマルチキャストのための PGM プロトコルです。これは、アドレスファミリが AF_INET で、iSocketType メンバーが SOCK_RDM の場合に指定できる値です。Windows Vista 以降向けにリリースされた Windows SDK では、この値は IPPROTO_PGM とも呼ばれます。

公式ドキュメント

CSADDR_INFO 構造体は、ソケット、ネットワークサービス、または名前空間プロバイダーの Windows ソケットアドレス情報を格納します。

解説(Remarks)

GetAddressByName 関数は、 CSADDR_INFO 構造体を使用して Windows ソケットアドレス情報を取得します。

getsockopt 関数を SO_BSP_STATE ソケットオプションを指定して呼び出すと、指定したソケットの CSADDR_INFO 構造体が取得されます。

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

各言語での定義

#include <windows.h>

// SOCKET_ADDRESS  (x64 16 / x86 8 バイト)
typedef struct SOCKET_ADDRESS {
    SOCKADDR* lpSockaddr;
    INT iSockaddrLength;
} SOCKET_ADDRESS;

// CSADDR_INFO  (x64 40 / x86 24 バイト)
typedef struct CSADDR_INFO {
    SOCKET_ADDRESS LocalAddr;
    SOCKET_ADDRESS RemoteAddr;
    INT iSocketType;
    INT iProtocol;
} CSADDR_INFO;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct SOCKET_ADDRESS
{
    public IntPtr lpSockaddr;
    public int iSockaddrLength;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CSADDR_INFO
{
    public SOCKET_ADDRESS LocalAddr;
    public SOCKET_ADDRESS RemoteAddr;
    public int iSocketType;
    public int iProtocol;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure SOCKET_ADDRESS
    Public lpSockaddr As IntPtr
    Public iSockaddrLength As Integer
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CSADDR_INFO
    Public LocalAddr As SOCKET_ADDRESS
    Public RemoteAddr As SOCKET_ADDRESS
    Public iSocketType As Integer
    Public iProtocol As Integer
End Structure
import ctypes
from ctypes import wintypes

class SOCKET_ADDRESS(ctypes.Structure):
    _fields_ = [
        ("lpSockaddr", ctypes.c_void_p),
        ("iSockaddrLength", ctypes.c_int),
    ]

class CSADDR_INFO(ctypes.Structure):
    _fields_ = [
        ("LocalAddr", SOCKET_ADDRESS),
        ("RemoteAddr", SOCKET_ADDRESS),
        ("iSocketType", ctypes.c_int),
        ("iProtocol", ctypes.c_int),
    ]
#[repr(C)]
pub struct SOCKET_ADDRESS {
    pub lpSockaddr: *mut core::ffi::c_void,
    pub iSockaddrLength: i32,
}

#[repr(C)]
pub struct CSADDR_INFO {
    pub LocalAddr: SOCKET_ADDRESS,
    pub RemoteAddr: SOCKET_ADDRESS,
    pub iSocketType: i32,
    pub iProtocol: i32,
}
import "golang.org/x/sys/windows"

type SOCKET_ADDRESS struct {
	lpSockaddr uintptr
	iSockaddrLength int32
}

type CSADDR_INFO struct {
	LocalAddr SOCKET_ADDRESS
	RemoteAddr SOCKET_ADDRESS
	iSocketType int32
	iProtocol int32
}
type
  SOCKET_ADDRESS = record
    lpSockaddr: Pointer;
    iSockaddrLength: Integer;
  end;

  CSADDR_INFO = record
    LocalAddr: SOCKET_ADDRESS;
    RemoteAddr: SOCKET_ADDRESS;
    iSocketType: Integer;
    iProtocol: Integer;
  end;
const SOCKET_ADDRESS = extern struct {
    lpSockaddr: ?*anyopaque,
    iSockaddrLength: i32,
};

const CSADDR_INFO = extern struct {
    LocalAddr: SOCKET_ADDRESS,
    RemoteAddr: SOCKET_ADDRESS,
    iSocketType: i32,
    iProtocol: i32,
};
type
  SOCKET_ADDRESS {.bycopy.} = object
    lpSockaddr: pointer
    iSockaddrLength: int32

  CSADDR_INFO {.bycopy.} = object
    LocalAddr: SOCKET_ADDRESS
    RemoteAddr: SOCKET_ADDRESS
    iSocketType: int32
    iProtocol: int32
struct SOCKET_ADDRESS
{
    void* lpSockaddr;
    int iSockaddrLength;
}

struct CSADDR_INFO
{
    SOCKET_ADDRESS LocalAddr;
    SOCKET_ADDRESS RemoteAddr;
    int iSocketType;
    int iProtocol;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; CSADDR_INFO サイズ: 24 バイト(x86)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; LocalAddr : SOCKET_ADDRESS (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; RemoteAddr : SOCKET_ADDRESS (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; iSocketType : INT (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; iProtocol : INT (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CSADDR_INFO サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; LocalAddr : SOCKET_ADDRESS (+0, 16byte)  varptr(st)+0 を基点に操作(16byte:入れ子/配列)
; RemoteAddr : SOCKET_ADDRESS (+16, 16byte)  varptr(st)+16 を基点に操作(16byte:入れ子/配列)
; iSocketType : INT (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; iProtocol : INT (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global SOCKET_ADDRESS
    #field intptr lpSockaddr
    #field int iSockaddrLength
#endstruct

#defstruct global CSADDR_INFO
    #field SOCKET_ADDRESS LocalAddr
    #field SOCKET_ADDRESS RemoteAddr
    #field int iSocketType
    #field int iProtocol
#endstruct

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