LPFN_ACCEPTEX

BOOL LPFN_ACCEPTEX(
    SOCKET sListenSocket,
    SOCKET sAcceptSocket,
    void* lpOutputBuffer,
    DWORD dwReceiveDataLength,
    DWORD dwLocalAddressLength,
    DWORD dwRemoteAddressLength,
    DWORD* lpdwBytesReceived,
    OVERLAPPED* lpOverlapped
);

AcceptEx 関数は、新しい接続を受け入れ、ローカルアドレスとリモートアドレスを返し、クライアントアプリケーションが送信した最初のデータブロックを受信します。

エラーが発生しなかった場合、 AcceptEx 関数は正常に完了し、TRUE が返されます。

関数が失敗した場合、 AcceptEx は FALSE を返します。その後 WSAGetLastError 関数を呼び出すと、拡張エラー情報を取得できます。 WSAGetLastError が ERROR_IO_PENDING を返した場合、操作は正常に開始され、まだ進行中です。エラーが WSAECONNRESET の場合は、着信接続が通知されたものの、呼び出しを受け入れる前にリモートピアによって接続が終了されたことを示します。

AcceptEx 関数は、複数のソケット関数を 1 回の API/カーネル遷移にまとめます。 AcceptEx 関数が成功すると、次の 3 つの処理が行われます。

• 新しい接続が受け入れられます。
• 接続のローカルアドレスとリモートアドレスの両方が返されます。
• リモート側が送信した最初のデータブロックが受信されます。

プログラムは、 accept 関数の代わりに AcceptEx を使用することで、ソケットへの接続をより短時間で確立できます。

1 つの出力バッファーで、データ、ローカルソケットアドレス (サーバー)、リモートソケットアドレス (クライアント) を受け取ります。

単一のバッファーを使用することでパフォーマンスが向上します。 AcceptEx を使用する場合は、 GetAcceptExSockaddrs 関数を呼び出して、バッファーを 3 つの部分 (データ、ローカルソケットアドレス、リモートソケットアドレス) に解析する必要があります。Windows XP 以降では、 AcceptEx 関数が完了し、受け入れたソケットに SO_UPDATE_ACCEPT_CONTEXT オプションが設定されると、受け入れたソケットに関連付けられたローカルアドレスを getsockname 関数で取得することもできます。同様に、受け入れたソケットに関連付けられたリモートアドレスは getpeername 関数で取得できます。

アドレスは内部形式で書き込まれるため、ローカルアドレスおよびリモートアドレス用のバッファーサイズは、使用するトランスポートプロトコルの sockaddr 構造体のサイズより 16 バイト大きくする必要があります。たとえば、sockaddr_in (TCP/IP のアドレス構造体) のサイズは 16 バイトです。したがって、ローカルアドレスとリモートアドレスには少なくとも 32 バイトのバッファーサイズを指定する必要があります。

AcceptEx 関数は、 accept 関数とは異なり、オーバーラップ I/O を使用します。アプリケーションで AcceptEx を使用すると、比較的少ないスレッド数で多数のクライアントを処理できます。オーバーラップ対応の Windows 関数と同様に、完了通知メカニズムとして Windows イベントまたは完了ポートを使用できます。

AcceptEx 関数と accept 関数のもう 1 つの大きな違いは、 AcceptEx では呼び出し元があらかじめ 2 つのソケットを用意しておく必要があることです。

• リッスンするソケットを指定するもの。
• 接続を受け入れるソケットを指定するもの。

sAcceptSocket パラメーターには、バインドも接続もされていない、開いているソケットを指定する必要があります。

GetQueuedCompletionStatus 関数または GetOverlappedResult 関数の lpNumberOfBytesTransferred パラメーターは、要求で受信したバイト数を示します。

この操作が正常に完了した場合、sAcceptSocket は次の関数にのみ渡すことができます。

ReadFile

WriteFile

send

WSASend

recv

WSARecv

TransmitFile

closesocket

setsockopt(SO_UPDATE_ACCEPT_CONTEXT の場合のみ)

AcceptEx 関数から制御が戻ると、ソケット sAcceptSocket は接続済みソケットの既定の状態になります。ソケット sAcceptSocket は、そのソケットに SO_UPDATE_ACCEPT_CONTEXT が設定されるまで、sListenSocket パラメーターに関連付けられたソケットのプロパティを継承しません。SO_UPDATE_ACCEPT_CONTEXT オプションを設定するには、 setsockopt 関数を使用し、ソケットハンドルとして sAcceptSocket を、オプション値として sListenSocket を指定します。

次に例を示します。

//Need to #include <mswsock.h> for SO_UPDATE_ACCEPT_CONTEXT

int iResult = 0;

iResult =  setsockopt( sAcceptSocket, SOL_SOCKET, SO_UPDATE_ACCEPT_CONTEXT, 
    (char *)&sListenSocket, sizeof(sListenSocket) );
   

受信バッファーを指定した場合、オーバーラップ操作は、接続が受け入れられてデータが読み取られるまで完了しません。接続が受け入れられたかどうかを確認するには、SO_CONNECT_TIME オプションを指定して getsockopt 関数を使用します。受け入れられている場合は、接続が確立してからの経過時間を判定できます。戻り値は、ソケットが接続されている秒数です。ソケットが接続されていない場合、 getsockopt は 0xFFFFFFFF を返します。オーバーラップ操作が完了したかどうかの確認と SO_CONNECT_TIME オプションを組み合わせることで、アプリケーションは、接続は受け入れられたもののデータをまったく受信していない状態を判定できます。このように接続を確認することで、確立されてからしばらく経過してもデータを受信していない接続をアプリケーションが検出できます。そのような接続は、受け入れたソケットを閉じて終了させることをお勧めします。これにより、 AcceptEx 関数の呼び出しはエラーで完了します。

次に例を示します。

INT seconds;
INT bytes = sizeof(seconds);
int iResult = 0;

iResult = getsockopt( sAcceptSocket, SOL_SOCKET, SO_CONNECT_TIME,
                      (char *)&seconds, (PINT)&bytes );

if ( iResult != NO_ERROR ) {
    printf( "getsockopt(SO_CONNECT_TIME) failed: %u\n", WSAGetLastError( ) );
    exit(1);
}

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

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

サンプル コード

次の例では、オーバーラップ I/O と完了ポートを使用して AcceptEx 関数を呼び出します。

#ifndef UNICODE
#define UNICODE
#endif

#define WIN32_LEAN_AND_MEAN

#include <winsock2.h>
#include <ws2tcpip.h>
#include <mswsock.h>
#include <stdio.h>

// Need to link with Ws2_32.lib
#pragma comment(lib, "Ws2_32.lib")

int main()
{
    //----------------------------------------
    // Declare and initialize variables
    WSADATA wsaData;
    int iResult = 0;
    BOOL bRetVal = FALSE;

    HANDLE hCompPort;
    HANDLE hCompPort2;
    
    LPFN_ACCEPTEX lpfnAcceptEx = NULL;
    GUID GuidAcceptEx = WSAID_ACCEPTEX;
    WSAOVERLAPPED olOverlap;

    SOCKET ListenSocket = INVALID_SOCKET;
    SOCKET AcceptSocket = INVALID_SOCKET;
    sockaddr_in service;
    char lpOutputBuf[1024];
    int outBufLen = 1024;
    DWORD dwBytes;

    hostent *thisHost;
    char *ip;
    u_short port;

    // Initialize Winsock
    iResult = WSAStartup(MAKEWORD(2, 2), &wsaData);
    if (iResult != NO_ERROR) {
        wprintf(L"Error at WSAStartup\n");
        return 1;
    }    

    // Create a handle for the completion port
    hCompPort = CreateIoCompletionPort(INVALID_HANDLE_VALUE, NULL, (u_long) 0, 0);
    if (hCompPort == NULL) {
        wprintf(L"CreateIoCompletionPort failed with error: %u\n",
            GetLastError() );
        WSACleanup();
        return 1;
    }
            
    // Create a listening socket
    ListenSocket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
    if (ListenSocket == INVALID_SOCKET) {
        wprintf(L"Create of ListenSocket socket failed with error: %u\n",
            WSAGetLastError() );
        WSACleanup();
        return 1;
    }

    // Associate the listening socket with the completion port
    CreateIoCompletionPort((HANDLE) ListenSocket, hCompPort, (u_long) 0, 0);

    //----------------------------------------
    // Bind the listening socket to the local IP address
    // and port 27015
    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) {
        wprintf(L"bind failed with error: %u\n", WSAGetLastError());
        closesocket(ListenSocket);
        WSACleanup();
        return 1;
    }

    //----------------------------------------
    // Start listening on the listening socket
    iResult = listen(ListenSocket, 100);
    if (iResult == SOCKET_ERROR) {
        wprintf(L"listen failed with error: %u\n", WSAGetLastError());
        closesocket(ListenSocket);
        WSACleanup();
        return 1;
    }

    wprintf(L"Listening on address: %s:%d\n", ip, port);

    // Load the AcceptEx function into memory using WSAIoctl.
    // The WSAIoctl function is an extension of the ioctlsocket()
    // function that can use overlapped I/O. The function's 3rd
    // through 6th parameters are input and output buffers where
    // we pass the pointer to our AcceptEx function. This is used
    // so that we can call the AcceptEx function directly, rather
    // than refer to the Mswsock.lib library.
    iResult = WSAIoctl(ListenSocket, SIO_GET_EXTENSION_FUNCTION_POINTER,
             &GuidAcceptEx, sizeof (GuidAcceptEx), 
             &lpfnAcceptEx, sizeof (lpfnAcceptEx), 
             &dwBytes, NULL, NULL);
    if (iResult == SOCKET_ERROR) {
        wprintf(L"WSAIoctl failed with error: %u\n", WSAGetLastError());
        closesocket(ListenSocket);
        WSACleanup();
        return 1;
    }

    // Create an accepting socket
    AcceptSocket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
    if (AcceptSocket == INVALID_SOCKET) {
        wprintf(L"Create accept socket failed with error: %u\n", WSAGetLastError());
        closesocket(ListenSocket);
        WSACleanup();
        return 1;
    }

    // Empty our overlapped structure and accept connections.
    memset(&olOverlap, 0, sizeof (olOverlap));

    bRetVal = lpfnAcceptEx(ListenSocket, AcceptSocket, lpOutputBuf,
                 outBufLen - ((sizeof (sockaddr_in) + 16) * 2),
                 sizeof (sockaddr_in) + 16, sizeof (sockaddr_in) + 16, 
                 &dwBytes, &olOverlap);
    if (bRetVal == FALSE) {
        wprintf(L"AcceptEx failed with error: %u\n", WSAGetLastError());
        closesocket(AcceptSocket);
        closesocket(ListenSocket);
        WSACleanup();
        return 1;
    }

    // Associate the accept socket with the completion port
    hCompPort2 = CreateIoCompletionPort((HANDLE) AcceptSocket, hCompPort, (u_long) 0, 0); 
    // hCompPort2 should be hCompPort if this succeeds
    if (hCompPort2 == NULL) {
        wprintf(L"CreateIoCompletionPort associate failed with error: %u\n",
            GetLastError() );
        closesocket(AcceptSocket);
        closesocket(ListenSocket);
        WSACleanup();
        return 1;
    }
    
    // Continue on to use send, recv, TransmitFile(), etc.,.
    //...

    return 0;
}

QoS に関する注意事項

TransmitFile 関数では、ファイルの送信後にソケットを「切断済みで再利用可能」な状態に戻す TF_DISCONNECT と TF_REUSE_SOCKET の 2 つのフラグを設定できます。サービスプロバイダーが、ファイル転送の完了前にソケットに関連付けられたサービス品質を直ちに削除する可能性があるため、これらのフラグはサービス品質が要求されているソケットでは使用しないでください。QoS を有効にしたソケットでは、これらのフラグに頼るのではなく、ファイル転送が完了した時点で closesocket 関数を呼び出すのが最適な方法です。

ATM に関する注意事項

Windows Sockets 2 で非同期転送モード (ATM) を使用する場合、接続のセットアップに関して重要な考慮事項があります。ATM の接続セットアップに関する重要な情報については、 accept 関数のドキュメントの「解説」セクションを参照してください。