getsockopt

getsockopt 関数 (winsock.h) は、ソケットオプションを取得します。

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

getsockopt 関数は、任意の種類・任意の状態のソケットに関連付けられたソケットオプションの現在の値を取得し、その結果を optval に格納します。オプションは複数のプロトコルレベルに存在し得ますが、常に最上位のソケットレベルには存在します。オプションは、パケットルーティングや OOB データ転送など、ソケットの動作に影響を与えます。

選択されたオプションに関連付けられた値は、バッファ optval に返されます。optlen が指す整数には、最初にこのバッファのサイズを格納しておく必要があります。戻り時には、返された値のサイズが設定されます。SO_LINGER の場合、これは LINGER 構造体のサイズになります。その他のほとんどのオプションでは、整数のサイズになります。

パラメータで指定したものが直接または間接的に指すメモリ領域の割り当ては、アプリケーションの責任で行います。

オプションが setsockopt で一度も設定されていない場合、 getsockopt はそのオプションの既定値を返します。

getsockopt では以下のオプションがサポートされています。Type 列は、optval が指すデータの型を示します。

ソケットオプションの詳細については、Socket Options を参照してください。

level パラメータが SOL_SOCKET に設定されている場合、optname パラメータに対して次の表の値が有効です。

level = IPPROTO_TCP

IPPROTO_TCP socket options の TCP_NODELAY を参照してください。level = IPPROTO_TCP のソケットオプションに関するより完全で詳細な情報についても、そのトピックを参照してください。

level パラメータが NSPROTO_IPX に設定されている場合、optname パラメータに対して次の表の値が有効です。

次の表は、getsockopt 関数でサポートされていない BSD ソケットオプションを表す optname の値を示しています。

サポートされていないオプションを指定して getsockopt を呼び出すと、 WSAGetLastError からエラーコード WSAENOPROTOOPT が返されます。

getsockopt 関数でサポートされる optname パラメータのソケットオプションの一部について、より詳細な情報を以下に示します。

SO_CONNECT_TIME

このオプションは、ソケットが接続されてからの秒数を返します。このオプションは、コネクション指向プロトコルでのみ有効です。

SO_CONNECT_TIME オプションは、getsockopt 関数とともに使用して、接続が確立されているかどうかを確認できます。このオプションは、ConnectEx 関数の呼び出しが進行中の間にも使用できます。 接続が確立されている場合、SO_CONNECT_TIME オプションでその接続が確立されてからどれくらい経過したかを判断できます。ソケットが接続されていない場合、getsockopt は SOCKET_ERROR を返します。このように接続を確認することは、データを送信せずにしばらく確立されたままになっている接続を調べるために必要です。アプリケーションはそのような接続を終了することが推奨されます。

SO_DEBUG

注意 Windows Sockets サービスプロバイダーは、アプリケーションによって SO_DEBUG オプションが設定された場合、デバッグ情報を出力することが推奨されます(ただし必須ではありません)。デバッグ情報を生成するメカニズムやその形式は、このドキュメントの範囲外です。

SO_ERROR

SO_ERROR オプションは、ソケットごとのエラーコードを返してリセットします。これは、 WSAGetLastError および WSASetLastError 関数の呼び出しで処理されるスレッドごとのエラーコードとは異なります。ソケットを使用した呼び出しが成功しても、SO_ERROR オプションが返すソケットベースのエラーコードはリセットされません。

SO_EXCLUSIVEADDRUSE

他のソケットが同じアドレスとポートにバインドされるのを防ぎます。このオプションは bind 関数を呼び出す前に設定する必要があります。詳細については SO_EXCLUSIVEADDRUSE のリファレンスを参照してください。

SO_GROUP_ID

注意 このオプションは予約済みです。また、このオプションは getsockopt 専用であり、値は NULL である必要があります。

SO_GROUP_PRIORITY

このオプションは予約済みです。グループ優先度は、ソケットグループ内の他のソケットに対する指定ソケットの優先度を示します。値は非負の整数で、ゼロが最高優先度に対応します。優先度の値は、不足しがちなリソースをどのように割り当てるべきかについて、下位のサービスプロバイダーへのヒントを表します。たとえば、2 つ以上のソケットがいずれもデータ送信可能な状態になっている場合、最高優先度のソケット(SO_GROUP_PRIORITY の値が最も小さいもの)が最初に処理され、残りはそれぞれの相対優先度に従って順に処理されます。

グループ以外のソケット、またはグループソケットをサポートしないサービスプロバイダーに対しては、WSAENOPROTOOPT エラーコードが示されます。

SO_KEEPALIVE

アプリケーションは、SO_KEEPALIVE ソケットオプションを有効にすることで、TCP/IP サービスプロバイダーに対し、TCP 接続でのキープアライブパケットの使用を有効にするよう要求できます。このオプションは、ソケットのキープアライブオプションの現在の値を照会します。Windows Sockets プロバイダーはキープアライブの使用をサポートする必要はありません。サポートする場合、その正確なセマンティクスは実装固有ですが、IETF の Web サイトで入手できる RFC 1122 の Requirements for Internet Hosts—Communication Layers のセクション 4.2.3.6 に準拠する必要があります。キープアライブの結果として接続が切断された場合、エラーコード WSAENETRESET がそのソケットで進行中のすべての呼び出しに返され、以降の呼び出しはすべて WSAENOTCONN で失敗します。SO_KEEPALIVE は ATM ソケットではサポートされておらず、ATM ソケットでキープアライブパケットの使用を有効にしようとすると、そのソケットからエラーが返されます。

SO_LINGER

SO_LINGER は、ソケットに未送信のデータがキューに入っている状態で closesocket が実行されたときの動作を制御します。SO_LINGER の設定が closesocket のセマンティクスにどのように影響するかについては closesocket を参照してください。アプリケーションは、(optval パラメータが指す) LINGER 構造体を取得することで、現在の動作を得ます。

SO_MAX_MSG_SIZE

これは取得専用のソケットオプションで、特定のサービスプロバイダーが実装する、メッセージ指向のソケット種別(例: SOCK_DGRAM)におけるメッセージの最大送信(送出)サイズを示します。バイトストリーム指向のソケットでは意味を持ちません。最大受信メッセージサイズを取得する手段はありません。

SO_PROTOCOL_INFO

これは取得専用のオプションで、このソケットに関連付けられた WSAPROTOCOL_INFO 構造体を提供します。この構造体の詳細については WSAEnumProtocols を参照してください。

SO_SNDBUF

Windows Sockets の実装が SO_RCVBUF および SO_SNDBUF オプションをサポートしている場合、アプリケーションは異なるバッファサイズ(より大きいか小さいもの)を要求できます。 setsockopt の呼び出しは、実装が要求された量の全体を提供しなかった場合でも成功することがあります。アプリケーションは、実際に提供されたバッファサイズを確認するために、同じオプションを指定してこの関数を呼び出す必要があります。

SO_REUSEADDR

既定では、ソケットは既に使用中のローカルアドレスにバインド(bind を参照)できません。ただし、場合によってはこのようにアドレスを再利用する必要があることもあります。すべての接続はローカルアドレスとリモートアドレスの組み合わせによって一意に識別されるため、リモートアドレスが異なる限り、2 つのソケットが同じローカルアドレスにバインドされていても問題ありません。目的のアドレスが既に別のソケットによって使用されているという理由で bind が拒否されるべきではないことを Windows Sockets プロバイダーに伝えるには、アプリケーションは bind を発行する前に、そのソケットに SO_REUSEADDR ソケットオプションを設定する必要があります。このオプションは bind の時点でのみ解釈される点に注意してください。したがって、既存のアドレスにバインドする予定のないソケットにこのオプションを設定することは不要(ただし無害)であり、 bind の後にオプションを設定またはリセットしても、このソケットや他のソケットには影響しません。SO_REUSEADDR は ATM ソケットには適用されず、アドレスの再利用を要求してもエラーにはなりませんが、ATM ソケットの使用時には効果がありません。

PVD_CONFIG

このオプションは、ソケット s に関連付けられたサービスプロバイダーから不透明なデータ構造体オブジェクトを取得します。このオブジェクトはサービスプロバイダーの現在の構成情報を格納します。このデータ構造の正確な形式はサービスプロバイダー固有です。

TCP_NODELAY

TCP_NODELAY オプションは TCP/IP サービスプロバイダーに固有です。TCP_NODELAY オプションが有効な場合、Nagle アルゴリズムは無効になります(逆も同様)。Nagle アルゴリズム(RFC 896 で説明)は、ホストが送信する小さなパケットの数を削減するのに非常に効果的です。この処理では、未確認のデータが既に送信中である場合に送信データをバッファリングするか、フルサイズのパケットを送信できるようになるまで送信データをバッファリングします。大多数のアプリケーションプロトコルでは Nagle アルゴリズムによって大幅なパフォーマンス向上が得られるため、Windows Sockets の実装では既定で Nagle アルゴリズムを有効にすることが強く推奨されます。ただし、一部のアプリケーションではこのアルゴリズムがパフォーマンスを妨げることがあり、同じオプションを指定した setsockopt を使用して無効にできます。これは、多数の小さなメッセージが送信され、メッセージ間の時間遅延が保たれるアプリケーションです。

サンプルコード

#include <stdio.h>
#include "winsock2.h"
#include <windows.h>

void main() {

  //---------------------------------------
  // Declare variables
  WSADATA wsaData;
  SOCKET ListenSocket;
  sockaddr_in service;

  //---------------------------------------
  // Initialize Winsock
  int iResult = WSAStartup( MAKEWORD(2,2), &wsaData );
  if( iResult != NO_ERROR )
    printf("Error at WSAStartup\n");

  //---------------------------------------
  // Create a listening socket
  ListenSocket = socket( AF_INET, SOCK_STREAM, IPPROTO_TCP );
  if (ListenSocket == INVALID_SOCKET) {
    printf("Error at socket()\n");
    WSACleanup();
    return;
  }

  //---------------------------------------
  // Bind the socket to the local IP address
  // and port 27015
  hostent* thisHost;
  char* ip;
  u_short port;
  port = 27015;
  thisHost = gethostbyname("");
  ip = inet_ntoa (*(struct in_addr *)*thisHost->h_addr_list);

  service.sin_family = AF_INET;
  service.sin_addr.s_addr = inet_addr(ip);
  service.sin_port = htons(port);
 
  if ( bind( ListenSocket,(SOCKADDR*) &service, sizeof(service) )  == SOCKET_ERROR ) {
    printf("bind failed\n");
    closesocket(ListenSocket);
    return;
  }

  //---------------------------------------
  // Initialize variables and call getsockopt. 
  // The SO_ACCEPTCONN parameter is a socket option 
  // that tells the function to check whether the 
  // socket has been put in listening mode or not. 
  // The various socket options return different
  // information about the socket. This call should
  // return 0 to the optVal parameter, since the socket
  // is not in listening mode.
  int optVal;
  int optLen = sizeof(int);

  if (getsockopt(ListenSocket, 
    SOL_SOCKET, 
    SO_ACCEPTCONN, 
    (char*)&optVal, 
    &optLen) != SOCKET_ERROR)
    printf("SockOpt Value: %ld\n", optVal);

  //---------------------------------------
  // Put the listening socket in listening mode.
  if (listen( ListenSocket, 100 ) == SOCKET_ERROR) {
    printf("error listening\n");
  } 

  //---------------------------------------
  // Call getsockopt again to verify that 
  // the socket is in listening mode.
  if (getsockopt(ListenSocket, 
    SOL_SOCKET, 
    SO_ACCEPTCONN, 
    (char*)&optVal, 
    &optLen) != SOCKET_ERROR)
    printf("SockOpt Value: %ld\n", optVal);

  WSACleanup();
  return;
}

IrDA ソケットに関する注意

• Af_irda.h ヘッダーファイルを明示的にインクルードする必要があります。
• 下位のトランシーバードライバーが IrDA プロトコルスタックの初期化に失敗したことを示すために、Windows は WSAENETDOWN を返します。
• IrDA はいくつかの特別なソケットオプションをサポートします:

  値	型	意味
  IRLMP_ENUMDEVICES	*DEVICELIST	範囲内のデバイスを記述します。
  IRLMP_IAS_QUERY	*IAS_QUERY	IAS 属性を取得します。

IrDA ソケット接続を開始する前に、 getsockopt(,,IRLMP_ENUMDEVICES,,) 関数呼び出しを実行してデバイスアドレスを取得する必要があります。この呼び出しは、利用可能なすべての IrDA デバイスのリストを返します。関数呼び出しから返されたデバイスアドレスは SOCKADDR_IRDA 構造体にコピーされ、それが続く connect 関数呼び出しで使用されます。

ディスカバリは 2 つの方法で実行できます:

1. 1 つ目は、IRLMP_ENUMDEVICES オプションを指定して getsockopt 関数を呼び出す方法で、これによりアイドル状態の各アダプターで 1 回のディスカバリが実行されます。検出されたデバイスと(アクティブなアダプター上の)キャッシュされたデバイスのリストが直ちに返されます。

   次のコードはこのアプローチを示しています。

   #include <winsock2.h>
   #include <ws2tcpip.h>
   #include <af_irda.h>
   #include <stdio.h>
   #include <windows.h>
   
   // link with Ws2_32.lib
   
   int __cdecl main()
   {
   
       //-----------------------------------------
       // Declare and initialize variables
       WSADATA wsaData;
   
       int iResult;
       int i;
       DWORD dwError;
   
       SOCKET Sock = INVALID_SOCKET;
   
   #define DEVICE_LIST_LEN    10
   
   
       SOCKADDR_IRDA DestSockAddr = { AF_IRDA, 0, 0, 0, 0, "SampleIrDAService" };
   
       unsigned char DevListBuff[sizeof (DEVICELIST) -
                                 sizeof (IRDA_DEVICE_INFO) +
                                 (sizeof (IRDA_DEVICE_INFO) * DEVICE_LIST_LEN)];
   
       int DevListLen = sizeof (DevListBuff);
       PDEVICELIST pDevList;
   
       pDevList = (PDEVICELIST) & DevListBuff;
   
       // Initialize Winsock
       iResult = WSAStartup(MAKEWORD(2, 2), &wsaData);
       if (iResult != 0) {
           printf("WSAStartup failed: %d\n", iResult);
           return 1;
       }
   
       Sock = socket(AF_IRDA, SOCK_STREAM, 0);
       if (Sock == INVALID_SOCKET) {
           dwError = WSAGetLastError();
           printf
               ("socket failed trying to create an AF_IRDA socket with error %d\n",
                dwError);
   
           if (dwError == WSAEAFNOSUPPORT) {
               printf("Check that the local computer has an infrared device\n");
               printf
                   ("and a device driver is installed for the infrared device\n");
           }
           WSACleanup();
           return 1;
       }
       // Sock is not in connected state
       iResult = getsockopt(Sock, SOL_IRLMP, IRLMP_ENUMDEVICES,
                            (char *) pDevList, &DevListLen);
       if (iResult == SOCKET_ERROR) {
           printf("getsockopt failed with error %d\n", WSAGetLastError());
           WSACleanup();
           return 1;
       }
   
       if (pDevList->numDevice == 0) {
           // no devices discovered or cached
           // not a bad idea to run a couple of times
           printf("No IRDA devices were discovered or cached\n");
       } else {
           // one per discovered device
           for (i = 0; i < (int) pDevList->numDevice; i++) {
               // typedef struct _IRDA_DEVICE_INFO
               // {
               //     u_char    irdaDeviceID[4];
               //     char      irdaDeviceName[22];
               //     u_char    irdaDeviceHints1;
               //     u_char    irdaDeviceHints2;
               //     u_char    irdaCharSet;
               // } _IRDA_DEVICE_INFO;
   
               // pDevList->Device[i]. see _IRDA_DEVICE_INFO for fields
               // display the device names and let the user select one
           }
       }
   
       // assume the user selected the first device [0]
       memcpy(&DestSockAddr.irdaDeviceID[0], &pDevList->Device[0].irdaDeviceID[0],
              4);
   
       iResult = connect(Sock, (const struct sockaddr *) &DestSockAddr,
                         sizeof (SOCKADDR_IRDA));
       if (iResult == SOCKET_ERROR) {
           printf("connect failed with error %d\n", WSAGetLastError());
       } else
           printf("connect to first IRDA device was successful\n");
   
       WSACleanup();
       return 0;
   }
   

2. IrDA デバイスアドレスのディスカバリを実行する 2 つ目のアプローチは、レイジーディスカバリを実行する方法です。このアプローチでは、検出されたデバイスのリストがスタックによる前回のディスカバリ実行から変化するまで、アプリケーションには通知されません。

前の表の Type 列に示されている IAS_QUERY 構造体は、ピアデバイスの IAS データベースから単一クラスの単一属性を取得するために使用されます。アプリケーションは、照会するデバイスとクラス、および属性と属性の型を指定します。デバイスは事前に getsockopt(IRLMP_ENUMDEVICES) の呼び出しによって取得されている必要があります。アプリケーションは、返されるパラメータ用に必要なサイズのバッファを割り当てることが期待されます。

多くのレベルのソケットオプションは IrDA にとって意味を持ちません。SO_LINGER と SO_DONTLINGER のみが明示的にサポートされています。

Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストアアプリでサポートされています。

Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。