WSARecvFrom 함수(winsock2.h)
WSARecvFrom 함수는 데이터그램을 수신하고 원본 주소를 저장합니다.
구문
int WSAAPI WSARecvFrom(
[in] SOCKET s,
[in, out] LPWSABUF lpBuffers,
[in] DWORD dwBufferCount,
[out] LPDWORD lpNumberOfBytesRecvd,
[in, out] LPDWORD lpFlags,
[out] sockaddr *lpFrom,
[in, out] LPINT lpFromlen,
[in] LPWSAOVERLAPPED lpOverlapped,
[in] LPWSAOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine
);
매개 변수
[in] s
소켓을 식별하는 설명자입니다.
[in, out] lpBuffers
WSABUF 구조체 배열에 대한 포인터입니다. 각 WSABUF 구조체에는 버퍼에 대한 포인터와 버퍼 길이가 포함됩니다.
[in] dwBufferCount
lpBuffers 배열의 WSABUF 구조체 수입니다.
[out] lpNumberOfBytesRecvd
WSARecvFrom 작업이 즉시 완료되는 경우 이 호출에서 받은 바이트 수에 대한 포인터입니다.
잠재적으로 잘못된 결과를 방지하려면 lpOverlapped 매개 변수가 NULL이 아닌 경우 이 매개 변수에 NULL을 사용합니다. lpOverlapped 매개 변수가 NULL이 아닌 경우에만 이 매개 변수는 NULL일 수 있습니다.
[in, out] lpFlags
WSARecvFrom 함수 호출의 동작을 수정하는 데 사용되는 플래그에 대한 포인터입니다. 아래 설명 부분을 참조하세요.
[out] lpFrom
겹치는 작업이 완료될 때 원본 주소를 보유할 버퍼에 대한 선택적 포인터입니다.
[in, out] lpFromlen
lpFrom이 지정된 경우에만 필요한 "from" 버퍼의 크기(바이트)에 대한 포인터입니다.
[in] lpOverlapped
WSAOVERLAPPED 구조체에 대한 포인터입니다(오버랩되지 않은 소켓의 경우 무시됨).
[in] lpCompletionRoutine
형식: _In_opt_ LPWSAOVERLAPPED_COMPLETION_ROUTINE
WSARecvFrom 작업이 완료되었을 때 호출되는 완료 루틴에 대한 포인터입니다(오버랩되지 않은 소켓의 경우 무시됨).
반환 값
오류가 발생하지 않고 수신 작업이 즉시 완료되면 WSARecvFrom 은 0을 반환합니다. 이 경우 호출 스레드가 경고 가능한 상태이면 완료 루틴이 이미 호출되도록 예약됩니다. 그렇지 않으면 SOCKET_ERROR 값이 반환되고 WSAGetLastError를 호출하여 특정 오류 코드를 검색할 수 있습니다. 오류 코드 WSA_IO_PENDING 겹치는 작업이 성공적으로 시작되었으며 나중에 완료가 표시됨을 나타냅니다. 다른 오류 코드는 겹치는 작업이 성공적으로 시작되지 않았으며 완료 표시가 발생하지 않음을 나타냅니다.
| 오류 코드 | 의미 |
|---|---|
| 가상 회로가 하드 또는 중단한 닫기를 실행하는 원격 쪽에서 재설정되었습니다. 더 이상 소켓을 사용할 수 없으므로 응용 프로그램이 소켓을 닫아야 합니다. UPD 데이터그램 소켓의 경우 이 오류는 이전 보내기 작업으로 인해 ICMP "포트 연결할 수 없음" 메시지가 발생했음을 나타냅니다. | |
| lpBuffers, lpFlags, lpFrom, lpNumberOfBytesRecvd, lpFromlen, lpOverlapped 또는 lpCompletionRoutine 매개 변수는 사용자 주소 공간의 유효한 부분에 완전히 포함되지 않습니다. lpFrom 버퍼가 피어 주소를 수용하기에는 너무 작습니다. | |
| 차단 Windows Sockets 1.1 호출이 진행 중이거나 서비스 공급자가 여전히 콜백 함수를 처리하고 있습니다. | |
| 차단 Windows 소켓 1.1 호출이 WSACancelBlockingCall을 통해 취소되었습니다. | |
| 소켓이 바인딩되지 않았습니다(예: 바인딩 포함). | |
| 메시지가 지정된 버퍼에 비해 너무 커서(신뢰할 수 없는 프로토콜에만 해당) 버퍼에 맞지 않는 메시지의 후행 부분이 삭제되었습니다. | |
| 네트워크 하위 시스템이 실패했습니다. | |
| 데이터그램 소켓의 경우 이 오류는 TTL(Time to Live)이 만료되었음을 나타냅니다. | |
| 소켓이 연결되지 않았습니다(연결 지향 소켓만 해당). | |
|
Windows NT:
겹치는 소켓: 미해결 겹치는 I/O 요청이 너무 많습니다. 오버랩되지 않은 소켓: 소켓이 차단 해제로 표시되고 수신 작업을 즉시 완료할 수 없습니다. |
|
| 이 함수를 사용하기 전에 성공적인 WSAStartup 호출이 발생해야 합니다. | |
| 겹치는 작업이 성공적으로 시작되었으며 나중에 완료가 표시됩니다. | |
| 소켓의 닫기로 인해 겹치는 작업이 취소되었습니다. |
설명
WSARecvFrom 함수는 다음 세 가지 중요한 영역에서 표준 recvfrom 함수 이상의 기능을 제공합니다.
- 겹치는 소켓과 함께 사용하여 겹치는 수신 작업을 수행할 수 있습니다.
- 이를 통해 여러 수신 버퍼를 지정하여 I/O의 분산/수집 형식에 적용할 수 있습니다.
- lpFlags 매개 변수는 입력 매개 변수와 출력 매개 변수 모두이므로 애플리케이션이 MSG_PARTIAL 플래그 비트의 출력 상태를 감지할 수 있습니다. MSG_PARTIAL 플래그 비트는 모든 프로토콜에서 지원되지 않습니다.
겹치는 소켓의 경우 이 함수는 들어오는 데이터가 (연결될 수 있음) 소켓에서 사용할 수 있게 될 때 배치되는 하나 이상의 버퍼를 게시하는 데 사용되며, 그 후에는 애플리케이션에서 지정한 완료 표시(완료 루틴 또는 이벤트 개체의 설정 호출)가 발생합니다. 작업이 즉시 완료되지 않으면 완료 루틴 또는 WSAGetOverlappedResult를 통해 최종 완료 상태 검색됩니다. 또한 lpFrom 및 lpFromlen으로 표시된 값은 완료 자체가 표시될 때까지 업데이트되지 않습니다. 애플리케이션은 업데이트될 때까지 이러한 값을 사용하거나 방해해서는 안 됩니다. 따라서 애플리케이션은 이러한 매개 변수에 대해 자동(즉, 스택 기반) 변수를 사용하면 안 됩니다.
오버랩되지 않은 소켓의 경우 차단 의미 체계는 표준 WSARecv 함수와 동일하며 lpOverlapped 및 lpCompletionRoutine 매개 변수는 무시됩니다. 전송에 의해 이미 수신되고 버퍼링된 모든 데이터는 사용자 버퍼에 복사됩니다. 현재 전송에 의해 수신되고 버퍼링된 데이터가 없는 차단 소켓의 경우 데이터가 수신될 때까지 호출이 차단됩니다.
버퍼는 lpBuffers로 표시된 배열에 표시되는 순서대로 채워지고 버퍼는 구멍이 생성되지 않도록 압축됩니다.
이 함수가 겹치는 방식으로 완료되면 이 호출에서 반환하기 전에 WSABUF 구조를 캡처하는 것은 Winsock 서비스 공급자의 책임입니다. 이를 통해 애플리케이션은 lpBuffers 매개 변수가 가리키는 스택 기반 WSABUF 배열을 빌드할 수 있습니다.
연결 없는 소켓 유형의 경우 데이터가 시작된 주소가 lpFrom으로 표시된 버퍼에 복사됩니다. lpFromlen에서 가리키는 값은 이 버퍼의 크기로 초기화되고 완료 시 수정되어 저장된 주소의 실제 크기를 나타냅니다. 이전에 겹치는 소켓에 대해 설명한 대로 lpFrom 및 lpFromlen 매개 변수는 겹치는 I/O가 완료될 때까지 업데이트되지 않습니다. 따라서 이러한 매개 변수가 가리키는 메모리는 서비스 공급자가 계속 사용할 수 있어야 하며 애플리케이션 스택 프레임에 할당할 수 없습니다. lpFrom 및 lpFromlen 매개 변수는 연결 지향 소켓에 대해 무시됩니다.
바이트 스트림 스타일 소켓(예: SOCK_STREAM 형식)의 경우 들어오는 데이터는 다음까지 버퍼에 배치됩니다.
- 버퍼가 채워집니다.
- 연결이 닫힌 경우
- 내부적으로 버퍼링된 데이터가 모두 사용되었습니다.
lpFlags 매개 변수를 사용하여 연결된 소켓에 대해 지정된 옵션 외에 함수 호출의 동작에 영향을 줄 수 있습니다. 즉, 이 함수의 의미 체계는 소켓 옵션 및 lpFlags 매개 변수에 의해 결정됩니다. 후자는 다음 표에 나열된 값과 함께 비트 OR 연산자를 사용하여 생성됩니다.
| 값 | 의미 |
|---|---|
| MSG_PEEK | 들어오는 데이터를 미리 봅니다. 데이터는 버퍼에 복사되지만 입력 큐에서 제거되지 않습니다. 이 플래그는 오버랩되지 않은 소켓에만 유효합니다. |
| MSG_OOB | OOB 데이터를 처리합니다. |
| MSG_PARTIAL | 이 플래그는 메시지 지향 소켓 전용입니다. 출력에서 이 플래그는 데이터가 보낸 사람에서 전송하는 메시지의 일부임을 나타냅니다. 메시지의 나머지 부분은 후속 수신 작업에서 전송됩니다. MSG_PARTIAL 플래그가 지워진 후속 수신 작업은 보낸 사람의 메시지 끝을 나타냅니다.
입력 매개 변수인 이 플래그는 서비스 공급자가 메시지의 일부만 수신한 경우에도 수신 작업이 완료되어야 했음을 나타냅니다. |
메시지 지향 소켓의 경우 부분 메시지가 수신되면 MSG_PARTIAL 비트가 lpFlags 매개 변수에 설정됩니다. 전체 메시지가 수신되면 lpFlags에서 MSG_PARTIAL 지워집니다. 완료가 지연되는 경우 lpFlags 에서 가리키는 값은 업데이트되지 않습니다. 완료가 표시되면 애플리케이션이 WSAGetOverlappedResult 를 호출하고 lpdwFlags 매개 변수가 가리키는 플래그를 검사해야 합니다.
겹치는 소켓 I/O
겹치는 작업이 즉시 완료되면 WSARecvFrom 은 값을 0으로 반환하고 lpNumberOfBytesRecvd 매개 변수는 수신된 바이트 수로 업데이트되고 lpFlags 매개 변수가 가리키는 플래그 비트도 업데이트됩니다. 겹치는 작업이 성공적으로 시작되고 나중에 완료되면 WSARecvFrom 은 SOCKET_ERROR 반환하고 오류 코드 WSA_IO_PENDING 나타냅니다. 이 경우 lpNumberOfBytesRecvd 및 lpFlags 는 업데이트되지 않습니다. 겹치는 작업이 완료되면 전송되는 데이터의 양은 완료 루틴의 cbTransferred 매개 변수를 통해 또는 WSAGetOverlappedResult의 lpcbTransfer 매개 변수를 통해 표시됩니다. 플래그 값은 완료 루틴의 dwFlags 매개 변수를 통해 또는 WSAGetOverlappedResult의 lpdwFlags 매개 변수를 검사하여 가져옵니다.WSARecvFrom 함수는 이전 WSARecv, WSARecvFrom, WSASend 또는 WSASendTo 함수의 완료 루틴 내에서 호출할 수 있습니다. 지정된 소켓의 경우 I/O 완료 루틴은 중첩되지 않습니다. 이렇게 하면 시간에 민감한 데이터 전송이 선점 컨텍스트 내에서 완전히 발생할 수 있습니다.
lpOverlapped 매개 변수는 겹치는 작업 기간 동안 유효해야 합니다. 여러 I/O 작업이 동시에 실행되지 않는 경우 각각은 별도의 WSAOVERLAPPED 구조를 참조해야 합니다.
lpCompletionRoutine 매개 변수가 NULL이면 겹치는 작업이 완료될 때 lpOverlapped의 hEvent 매개 변수가 유효한 이벤트 개체 핸들을 포함하는 경우 신호를 보냅니다. 애플리케이션은 WSAWaitForMultipleEvents 또는 WSAGetOverlappedResult 를 사용하여 이벤트 개체를 기다리거나 폴링할 수 있습니다.
lpCompletionRoutine이 NULL이 아닌 경우 hEvent 매개 변수는 무시되며 애플리케이션에서 컨텍스트 정보를 완료 루틴에 전달하는 데 사용할 수 있습니다. NULL이 아닌 lpCompletionRoutine을 전달하고 나중에 동일한 겹치는 I/O 요청에 대해 WSAGetOverlappedResult를 호출하는 호출자는 WSAGetOverlappedResult 호출에 대한 fWait 매개 변수를 TRUE로 설정하지 않을 수 있습니다. 이 경우 hEvent 매개 변수의 사용이 정의되지 않았으며 hEvent 매개 변수를 대기하려고 하면 예측할 수 없는 결과가 생성됩니다.
완료 루틴은 Windows 파일 I/O 완료 루틴에 규정된 것과 동일한 규칙을 따릅니다. true로 설정된 fAlertable 매개 변수가 있는 함수 WSAWaitForMultipleEvents가 호출될 때와 같이 스레드가 경고 대기 상태에 있을 때까지 완료 루틴이 호출되지 않습니다.
IO 완료 포트가 사용되고 lpCompletionRoutine 매개 변수와 hEvent 매개 변수가 NULL인 경우 작업의 결과는 IO 완료 포트에서 일정이 지정됩니다. 이는 작업이 즉시 완료되는지 여부에 관계없이 모든 성공적인 작업에 대해 발생합니다.
전송 공급자를 사용하면 애플리케이션이 소켓 I/O 완료 루틴의 컨텍스트 내에서 송신 및 수신 작업을 호출할 수 있으며 지정된 소켓의 경우 I/O 완료 루틴이 중첩되지 않도록 보장합니다. 이렇게 하면 시간에 민감한 데이터 전송이 선점 컨텍스트 내에서 완전히 발생할 수 있습니다.
완료 루틴의 프로토타입은 다음과 같습니다.
void CALLBACK CompletionROUTINE(
IN DWORD dwError,
IN DWORD cbTransferred,
IN LPWSAOVERLAPPED lpOverlapped,
IN DWORD dwFlags
);
CompletionRoutine은 애플리케이션 정의 또는 라이브러리 정의 함수 이름의 자리 표시자입니다. dwError는 lpOverlapped로 표시된 대로 겹치는 작업에 대한 완료 상태 지정합니다. cbTransferred는 수신된 바이트 수를 지정합니다. dwFlags 매개 변수에는 수신 작업이 즉시 완료된 경우 lpFlags에 표시되었을 정보가 포함됩니다. 이 함수는 값을 반환하지 않습니다.
이 함수에서 반환하면 이 소켓에 대해 보류 중인 다른 완료 루틴을 호출할 수 있습니다. WSAWaitForMultipleEvents를 사용하는 경우 경고 가능한 스레드의 대기가 반환 코드 WSA_IO_COMPLETION 충족되기 전에 모든 대기 완료 루틴이 호출됩니다. 완료 루틴은 겹치는 작업이 완료되는 순서와 같은 순서로 호출될 수 있는 것은 아닙니다. 그러나 게시된 버퍼는 지정된 순서대로 채워지도록 보장됩니다.
예제 코드
다음 예제에서는 WSARecvFrom 함수를 사용하는 방법을 보여 줍니다.#ifndef UNICODE
#define UNICODE
#endif
#define WIN32_LEAN_AND_MEAN
#include <winsock2.h>
#include <Ws2tcpip.h>
#include <stdio.h>
int __cdecl main()
{
WSADATA wsaData;
WSABUF DataBuf;
WSAOVERLAPPED Overlapped;
SOCKET RecvSocket = INVALID_SOCKET;
struct sockaddr_in RecvAddr;
struct sockaddr_in SenderAddr;
int SenderAddrSize = sizeof (SenderAddr);
u_short Port = 27015;
char RecvBuf[1024];
int BufLen = 1024;
DWORD BytesRecv = 0;
DWORD Flags = 0;
int err = 0;
int rc;
int retval = 0;
//-----------------------------------------------
// Initialize Winsock
rc = WSAStartup(MAKEWORD(2, 2), &wsaData);
if (rc != 0) {
/* Could not find a usable Winsock DLL */
wprintf(L"WSAStartup failed with error: %ld\n", rc);
return 1;
}
// Make sure the Overlapped struct is zeroed out
SecureZeroMemory((PVOID) &Overlapped, sizeof(WSAOVERLAPPED) );
// Create an event handle and setup the overlapped structure.
Overlapped.hEvent = WSACreateEvent();
if (Overlapped.hEvent == NULL) {
wprintf(L"WSACreateEvent failed with error: %d\n", WSAGetLastError());
WSACleanup();
return 1;
}
//-----------------------------------------------
// Create a receiver socket to receive datagrams
RecvSocket = WSASocket(AF_INET,
SOCK_DGRAM,
IPPROTO_UDP, NULL, 0, WSA_FLAG_OVERLAPPED);
if (RecvSocket == INVALID_SOCKET) {
/* Could not open a socket */
wprintf(L"WSASocket failed with error: %ld\n", WSAGetLastError());
WSACloseEvent(Overlapped.hEvent);
WSACleanup();
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);
rc = bind(RecvSocket, (SOCKADDR *) & RecvAddr, sizeof (RecvAddr));
if (rc != 0) {
/* Bind to the socket failed */
wprintf(L"bind failed with error: %ld\n", WSAGetLastError());
WSACloseEvent(Overlapped.hEvent);
closesocket(RecvSocket);
WSACleanup();
return 1;
}
//-----------------------------------------------
// Call the recvfrom function to receive datagrams
// on the bound socket.
DataBuf.len = BufLen;
DataBuf.buf = RecvBuf;
wprintf(L"Listening for incoming datagrams on port=%d\n", Port);
rc = WSARecvFrom(RecvSocket,
&DataBuf,
1,
&BytesRecv,
&Flags,
(SOCKADDR *) & SenderAddr,
&SenderAddrSize, &Overlapped, NULL);
if (rc != 0) {
err = WSAGetLastError();
if (err != WSA_IO_PENDING) {
wprintf(L"WSARecvFrom failed with error: %ld\n", err);
WSACloseEvent(Overlapped.hEvent);
closesocket(RecvSocket);
WSACleanup();
return 1;
}
else {
rc = WSAWaitForMultipleEvents(1, &Overlapped.hEvent, TRUE, INFINITE, TRUE);
if (rc == WSA_WAIT_FAILED) {
wprintf(L"WSAWaitForMultipleEvents failed with error: %d\n", WSAGetLastError());
retval = 1;
}
rc = WSAGetOverlappedResult(RecvSocket, &Overlapped, &BytesRecv,
FALSE, &Flags);
if (rc == FALSE) {
wprintf(L"WSArecvFrom failed with error: %d\n", WSAGetLastError());
retval = 1;
}
else
wprintf(L"Number of received bytes = %d\n", BytesRecv);
wprintf(L"Finished receiving. Closing socket.\n");
}
}
//---------------------------------------------
// When the application is finished receiving, close the socket.
WSACloseEvent(Overlapped.hEvent);
closesocket(RecvSocket);
wprintf(L"Exiting.\n");
//---------------------------------------------
// Clean up and quit.
WSACleanup();
return (retval);
}
Windows Phone 8: 이 함수는 Windows Phone 8 이상에서 Windows Phone 스토어 앱에서 지원됩니다.
Windows 8.1 및 Windows Server 2012 R2: 이 함수는 Windows 8.1, Windows Server 2012 R2 이상의 Windows 스토어 앱에서 지원됩니다.
요구 사항
| 지원되는 최소 클라이언트 | Windows 8.1, Windows Vista [데스크톱 앱 | UWP 앱] |
| 지원되는 최소 서버 | Windows Server 2003 [데스크톱 앱 | UWP 앱] |
| 대상 플랫폼 | Windows |
| 헤더 | winsock2.h |
| 라이브러리 | Ws2_32.lib |
| DLL | Ws2_32.dll |