recvfrom 関数 (winsock2.h)

recvfrom 関数はデータグラムを受け取り、ソース アドレスを格納します。

構文

int WSAAPI recvfrom(
  [in]                SOCKET   s,
  [out]               char     *buf,
  [in]                int      len,
  [in]                int      flags,
  [out]               sockaddr *from,
  [in, out, optional] int      *fromlen
);

パラメーター

[in] s

バインドされたソケットを識別する記述子。

[out] buf

受信データのバッファー。

[in] len

buf パラメーターが指すバッファーの長さ (バイト単位)。

[in] flags

関連付けられたソケットに指定されたオプションを超えて関数呼び出しの動作を変更する一連のオプション。 詳細については、以下の「備考」を参照してください。

[out] from

戻り時にソース アドレスを保持する sockaddr 構造体内のバッファーへの省略可能なポインター。

[in, out, optional] fromlen

from パラメーターが指すバッファーのサイズ (バイト単位) への省略可能なポインター。

戻り値

エラーが発生しない場合、 recvfrom は受信したバイト数を返します。 接続が正常に閉じている場合、戻り値は 0 です。 それ以外の場合は、SOCKET_ERRORの値が返され、 WSAGetLastError を呼び出すことによって特定のエラー コードを取得できます。

注釈

recvfrom 関数は、接続されているソケットと接続されていないソケットの両方で受信データを読み取り、データの送信元のアドレスをキャプチャします。 この関数は通常、コネクションレス ソケットで使用されます。 ソケットのローカル アドレスがわかっている必要があります。 サーバー アプリケーションの場合、これは通常、 バインドによって明示的に行われます。 クライアント アプリケーションでは、明示的なバインドは推奨されません。 この関数を使用するクライアント アプリケーションの場合、ソケットは sendto、 WSASendTo、または WSAJoinLeaf を介してローカル アドレスに暗黙的にバインドされます。

SOCK_STREAM型のソケットなどのストリーム指向ソケットの場合、 recvfrom の呼び出しは、指定されたバッファーのサイズまで、現在使用可能な限り多くの情報を返します。 ソケットが OOB データのインライン受信用に構成されていて (ソケット オプション SO_OOBINLINE)、OOB データがまだ未読の場合は、OOB データのみが返されます。 アプリケーションでは、 ioctlsocket または WSAIoctlSIOCATMARK コマンドを使用して、それ以上の OOB データを読み取り続けるかどうかを判断できます。 from パラメーターとfromlen パラメーターは、接続指向ソケットでは無視されます。

メッセージ指向ソケットの場合、指定されたバッファーのサイズまで、最初のエンキューされたメッセージからデータが抽出されます。 データグラムまたはメッセージが指定されたバッファーより大きい場合、バッファーにはデータグラムの最初の部分が入力され、 recvfrom はエラー WSAEMSGSIZE を生成します。 信頼性の低いプロトコル (UDP など) の場合、過剰なデータは失われます。 受信したパケットにデータ (空) が含まれない場合、UDP の場合、 recvfrom 関数からの 戻り値は 0 です。

from パラメーターが 0 以外で、ソケットが接続指向でない場合 (たとえば、「SOCK_DGRAM」と入力します)、データを送信したピアのネットワーク アドレスは、対応する sockaddr 構造体にコピーされます。 fromlen が指す値は、この構造体のサイズに初期化され、戻り値として sockaddr 構造体に格納されているアドレスの実際のサイズを示すように変更されます。

ソケットで受信データが使用できない場合、 recvfrom 関数は、ソケットが非ブロッキングでない限り、MSG_PARTIAL フラグが設定されていない WSARecv に対して定義されているブロック規則に従ってデータが到着するのをブロックし、待機します。 この場合、エラー コードが WSAEWOULDBLOCK に設定された状態で、SOCKET_ERRORの値が返されます。 select、WSAAsyncSelect、または WSAEventSelect を使用して、より多くのデータが到着するタイミングを判断できます。

ソケットが接続指向で、リモート側が接続を正常にシャットダウンしている場合、 recvfrom への呼び出しは、受信したバイト数がゼロで直ちに完了します。 接続がリセットされた場合、 recvfrom はエラー WSAECONNRESET で失敗します。

flags パラメーターを使用すると、関連するソケットに指定されたオプションを超えて関数呼び出しの動作に影響を与えることができます。 この関数のセマンティクスは、ソケット オプションと flags パラメーターによって決まります。 後者は、次のいずれかの値を持つビットごとの OR 演算子を使用して構築されます。

コード例

#ifndef UNICODE
#define UNICODE
#endif

#define WIN32_LEAN_AND_MEAN

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

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

int main()
{

    int iResult = 0;

    WSADATA wsaData;

    SOCKET RecvSocket;
    sockaddr_in RecvAddr;

    unsigned short Port = 27015;

    char RecvBuf[1024];
    int BufLen = 1024;

    sockaddr_in SenderAddr;
    int SenderAddrSize = sizeof (SenderAddr);

    //-----------------------------------------------
    // Initialize Winsock
    iResult = WSAStartup(MAKEWORD(2, 2), &wsaData);
    if (iResult != NO_ERROR) {
        wprintf(L"WSAStartup failed with error %d\n", iResult);
        return 1;
    }
    //-----------------------------------------------
    // Create a receiver socket to receive datagrams
    RecvSocket = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
    if (RecvSocket == INVALID_SOCKET) {
        wprintf(L"socket failed with error %d\n", WSAGetLastError());
        return 1;
    }
    //-----------------------------------------------
    // Bind the socket to any address and the specified port.
    RecvAddr.sin_family = AF_INET;
    RecvAddr.sin_port = htons(Port);
    RecvAddr.sin_addr.s_addr = htonl(INADDR_ANY);

    iResult = bind(RecvSocket, (SOCKADDR *) & RecvAddr, sizeof (RecvAddr));
    if (iResult != 0) {
        wprintf(L"bind failed with error %d\n", WSAGetLastError());
        return 1;
    }
    //-----------------------------------------------
    // Call the recvfrom function to receive datagrams
    // on the bound socket.
    wprintf(L"Receiving datagrams...\n");
    iResult = recvfrom(RecvSocket,
                       RecvBuf, BufLen, 0, (SOCKADDR *) & SenderAddr, &SenderAddrSize);
    if (iResult == SOCKET_ERROR) {
        wprintf(L"recvfrom failed with error %d\n", WSAGetLastError());
    }
 
    //-----------------------------------------------
    // Close the socket when finished receiving datagrams
    wprintf(L"Finished receiving. Closing socket.\n");
    iResult = closesocket(RecvSocket);
    if (iResult == SOCKET_ERROR) {
        wprintf(L"closesocket failed with error %d\n", WSAGetLastError());
        return 1;
    }

    //-----------------------------------------------
    // Clean up and exit.
    wprintf(L"Exiting.\n");
    WSACleanup();
    return 0;
}

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

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

要件

こちらもご覧ください

WSAAsyncSelect

WSAEventSelect

Winsock 関数

Winsock リファレンス

Recv

送信

Sockaddr

socket