setsockopt 関数 (winsock.h)

setsockopt 関数は、ソケット オプションを設定します。

構文

int setsockopt(
  [in] SOCKET     s,
  [in] int        level,
  [in] int        optname,
  [in] const char *optval,
  [in] int        optlen
);

パラメーター

[in] s

ソケットを識別する記述子。

[in] level

オプションが定義されているレベル (たとえば、SOL_SOCKET)。

[in] optname

値を設定するソケット オプション (たとえば、SO_BROADCAST)。 optname パラメーターは、指定されたレベル内で定義されているソケット オプションである必要があります。または動作が未定義です。

[in] optval

要求されたオプションの値が指定されているバッファーへのポインター。

[in] optlen

optval パラメーターが指すバッファーのサイズ (バイト単位)。

戻り値

エラーが発生しない場合、 setsockopt は 0 を返します。 それ以外の場合は、SOCKET_ERRORの値が返され、 WSAGetLastError を呼び出すことによって特定のエラー コードを取得できます。

注釈

setsockopt 関数は、任意の型のソケットに関連付けられているソケット オプションの現在の値を任意の状態で設定します。 オプションは複数のプロトコル レベルで存在できますが、常に最上位のソケット レベルに存在します。 オプションは、通常のデータ ストリームで優先データ (OOB データなど) を受信するかどうか、およびソケットでブロードキャスト メッセージを送信できるかどうかなど、ソケット操作に影響します。

次の表に 、setsockopt 関数でサポートされる一般的なオプションの一部を示します。 Type 列は、 optval パラメーターによってアドレス指定されるデータの型を識別します。 [説明] 列には、ソケット オプションに関するいくつかの基本情報が表示されます。 ソケット オプションの詳細な一覧と詳細な情報 (既定値など) については、「 ソケット オプション」の詳細なトピックを参照してください。

level = SOL_SOCKET

level = IPPROTO_TCP

ソケット オプションのTCP_NODELAY IPPROTO_TCP参照してください。 また、レベル = IPPROTO_TCPのソケット オプションの詳細と詳細については、このトピックを参照してください。

level = NSPROTO_IPX

レベル = NSPROTO_IPXのソケット オプションの詳細と詳細については、「NSPROTO_IPX ソケット オプション」を参照してください。

setsockopt でサポートされていない BSD オプションを次の表に示します。

コード例

#ifndef UNICODE
#define UNICODE
#endif

#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif

#include <winsock2.h>
#include <Ws2tcpip.h>
#include <stdio.h>

// Link with ws2_32.lib
#pragma comment(lib, "Ws2_32.lib")

int main()
{

    //---------------------------------------
    // Declare variables
    WSADATA wsaData;

    SOCKET ListenSocket;
    sockaddr_in service;

    int iResult = 0;

    BOOL bOptVal = FALSE;
    int bOptLen = sizeof (BOOL);

    int iOptVal = 0;
    int iOptLen = sizeof (int);

    //---------------------------------------
    // Initialize Winsock
    iResult = WSAStartup(MAKEWORD(2, 2), &wsaData);
    if (iResult != NO_ERROR) {
        wprintf(L"Error at WSAStartup()\n");
        return 1;
    }
    //---------------------------------------
    // Create a listening socket
    ListenSocket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
    if (ListenSocket == INVALID_SOCKET) {
        wprintf(L"socket function failed with error: %u\n", WSAGetLastError());
        WSACleanup();
        return 1;
    }
    //---------------------------------------
    // 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);

    iResult = bind(ListenSocket, (SOCKADDR *) & service, sizeof (service));
    if (iResult == SOCKET_ERROR) {
        wprintf(L"bind failed with error %u\n", WSAGetLastError());
        closesocket(ListenSocket);
        WSACleanup();
        return 1;
    }
    //---------------------------------------
    // Initialize variables and call setsockopt. 
    // The SO_KEEPALIVE parameter is a socket option 
    // that makes the socket send keepalive messages
    // on the session. The SO_KEEPALIVE socket option
    // requires a boolean value to be passed to the
    // setsockopt function. If TRUE, the socket is
    // configured to send keepalive messages, if FALSE
    // the socket configured to NOT send keepalive messages.
    // This section of code tests the setsockopt function
    // by checking the status of SO_KEEPALIVE on the socket
    // using the getsockopt function.

    bOptVal = TRUE;

    iResult = getsockopt(ListenSocket, SOL_SOCKET, SO_KEEPALIVE, (char *) &iOptVal, &iOptLen);
    if (iResult == SOCKET_ERROR) {
        wprintf(L"getsockopt for SO_KEEPALIVE failed with error: %u\n", WSAGetLastError());
    } else
        wprintf(L"SO_KEEPALIVE Value: %ld\n", iOptVal);

    iResult = setsockopt(ListenSocket, SOL_SOCKET, SO_KEEPALIVE, (char *) &bOptVal, bOptLen);
    if (iResult == SOCKET_ERROR) {
        wprintf(L"setsockopt for SO_KEEPALIVE failed with error: %u\n", WSAGetLastError());
    } else
        wprintf(L"Set SO_KEEPALIVE: ON\n");

    iResult = getsockopt(ListenSocket, SOL_SOCKET, SO_KEEPALIVE, (char *) &iOptVal, &iOptLen);
    if (iResult == SOCKET_ERROR) {
        wprintf(L"getsockopt for SO_KEEPALIVE failed with error: %u\n", WSAGetLastError());
    } else
        wprintf(L"SO_KEEPALIVE Value: %ld\n", iOptVal);

    closesocket(ListenSocket);
    WSACleanup();
    return 0;
}

IrDA ソケットに関する注意事項

IrDA 用 Windows ソケットを使用してアプリケーションを開発する場合は、次の点に注意してください。

• Af_irda.h ヘッダー ファイルは明示的に含まれている必要があります。
• IrDA には、次のソケット オプションがあります。

  価値	タイプ	Meaning
  IRLMP_IAS_SET	*IAS_SET	IAS 属性を設定します

   

IRLMP_IAS_SET ソケット オプションを使用すると、アプリケーションはローカル IAS で 1 つのクラスの 1 つの属性を設定できます。 アプリケーションは、設定するクラス、属性、および属性の型を指定します。 アプリケーションは、渡されたパラメーターに必要なサイズのバッファーを割り当てる必要があります。

IrDA は、IrDA ベースの情報を格納する IAS データベースを提供します。 IAS データベースへの制限付きアクセスは Windows Sockets 2 インターフェイスを通じて利用できますが、このようなアクセスは通常アプリケーションでは使用されず、主に Windows ソケット 2 IrDA 規則に準拠していない Windows 以外のデバイスへの接続をサポートするために存在します。

次の構造体 IAS_SETは、ローカル IAS データベースを管理するために、IRLMP_IAS_SET setsockopt オプションと共に使用されます。

// #include <Af_irda.h> for this struct

typedef struct _IAS_SET {
    u_char      irdaClassName[IAS_MAX_CLASSNAME];
    char      irdaAttribName[IAS_MAX_ATTRIBNAME];
    u_long    irdaAttribType;
    union
    {
              LONG irdaAttribInt;
              struct
              {
                   u_long   Len;
                   u_char    OctetSeq[IAS_MAX_OCTET_STRING];
              } irdaAttribOctetSeq;
              struct
              {
                   u_long    Len;
                   u_long    CharSet;
                   u_char    UsrStr[IAS_MAX_USER_STRING];
              } irdaAttribUsrStr;
    } irdaAttribute;
} IAS_SET, *PIAS_SET, FAR *LPIASSET;

次の構造体 IAS_QUERYは、ピアの IAS データベースに対してクエリを実行するために、IRLMP_IAS_QUERY setsockopt オプションと共に使用されます。

// #include <Af_irda.h> for this struct

typedef struct _WINDOWS_IAS_QUERY {
        u_char   irdaDeviceID[4];
        char     irdaClassName[IAS_MAX_CLASSNAME];
        char     irdaAttribName[IAS_MAX_ATTRIBNAME];
        u_long   irdaAttribType;
        union
        {
                  LONG    irdaAttribInt;
                  struct
                  {
                          u_long  Len;
                          u_char  OctetSeq[IAS_MAX_OCTET_STRING];
                  } irdaAttribOctetSeq;
                  struct
                  {
                          u_long  Len;
                          u_long  CharSet;
                          u_char  UsrStr[IAS_MAX_USER_STRING];
                  } irdaAttribUsrStr;
        } irdaAttribute;
} IAS_QUERY, *PIAS_QUERY, FAR *LPIASQUERY;

多くのSO_ レベルのソケット オプションは、IrDA にとって意味がありません。 SO_LINGERのみが特にサポートされています。

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

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

Requirements

こちらも参照ください

IPPROTO_IP ソケット オプション

IPPROTO_IPV6 ソケット オプション

IPPROTO_RM ソケット オプション

IPPROTO_TCP ソケット オプション

IPPROTO_UDP ソケット オプション

NSPROTO_IPX ソケット オプション

SOL_APPLETALK ソケット オプション

SOL_IRLMP ソケット オプション

SOL_SOCKET ソケット オプション

ソケット オプション

WSAAsyncSelect

WSAEventSelect

WSAIoctl

Winsock 関数

縛る

getsockopt

ioctlsocket

ソケット