sendto 関数 (winsock2.h)
sendto 関数は、特定の宛先にデータを送信します。
構文
int WSAAPI sendto(
[in] SOCKET s,
[in] const char *buf,
[in] int len,
[in] int flags,
[in] const sockaddr *to,
[in] int tolen
);
パラメーター
[in] s
(接続されている可能性がある) ソケットを識別する記述子。
[in] buf
送信するデータを含むバッファーへのポインター。
[in] len
buf パラメーターが指すデータの長さ (バイト単位)。
[in] flags
呼び出しの方法を指定するフラグのセット。
[in] to
ターゲット ソケットのアドレスを含む sockaddr 構造体への省略可能なポインター。
[in] tolen
to パラメーターが指すアドレスのサイズ (バイト単位)。
戻り値
エラーが発生しない場合、 sendto は送信された合計バイト数を返します。これは len で示される数より小さくすることができます。 それ以外の場合は、SOCKET_ERRORの値が返され、 WSAGetLastError を呼び出すことによって特定のエラー コードを取得できます。
エラー コード | 意味 |
---|---|
この関数を使用する前に 、WSAStartup 呼び出しが正常に行われる必要があります。 | |
ネットワーク サブシステムが失敗しました。 | |
要求されたアドレスはブロードキャスト アドレスですが、適切なフラグが設定されていません。 ブロードキャスト アドレスの使用を許可するには、SO_BROADCAST パラメーターを指定して setsockopt を呼び出します。 | |
不明なフラグが指定されたか、SO_OOBINLINEが有効になっているソケットに対してMSG_OOBが指定されました。 | |
ブロックしている Windows ソケット 1.1 呼び出しが WSACancelBlockingCall によって取り消されました。 | |
ブロックしている Windows ソケット 1.1 呼び出しが進行中であるか、サービス プロバイダーがコールバック関数を処理しています。 | |
buf パラメーターまたは to パラメーターがユーザー アドレス空間に含まれていないか、tolen パラメーターが小さすぎます。 | |
操作の実行中にキープ アライブ動作によってエラーが検出されたため、接続が切断されました。 | |
バッファーに空き領域がありません。 | |
ソケットが接続されていません (接続指向ソケットのみ)。 | |
記述子はソケットではありません。 | |
MSG_OOBが指定されましたが、ソケットは、型 SOCK_STREAM、OOB データがこのソケットに関連付けられている通信ドメインでサポートされていない、またはソケットが一方向であり、受信操作のみをサポートするなど、ストリーム スタイルではありません。 | |
ソケットがシャットダウンされました。SD_SENDまたはSD_BOTHに設定された方法でシャットダウンが呼び出された後、ソケットで sendto することはできません。 | |
ソケットは非ブロッキングとしてマークされ、要求された操作はブロックされます。 | |
ソケットはメッセージ指向であり、メッセージは基になるトランスポートでサポートされている最大値を超えています。 | |
現時点では、このホストからリモート ホストにアクセスできません。 | |
仮想回線はタイムアウトまたはその他の障害のために切断されました。 ソケットが使用できないため、アプリケーションはソケットを閉じる必要があります。 | |
強制終了または中止になる閉じる操作を実行するリモート側によって仮想回線がリセットされました。 UPD ソケットの場合、リモート ホストは以前に送信された UDP データグラムを配信できず、"ポートに到達できない" ICMP パケットで応答しました。 ソケットが使用できないため、アプリケーションはソケットを閉じる必要があります。 | |
リモート アドレスが有効なアドレスではありません (たとえば、ADDR_ANY)。 | |
指定されたファミリーのアドレスをこのソケットと共に使用することはできません。 | |
宛先アドレスが必要です。 | |
現在このホストからネットワークには到達できません。 | |
到達できないホストに対してソケット操作を実行しようとしました。 | |
ネットワーク障害のため、または相手側のシステムが予告なしにダウンしたため、接続が切断されました。 |
解説
sendto 関数は、ソケットに送信データを書き込むのに使用されます。 メッセージ指向ソケットの場合は、基になるサブネットの最大パケット サイズを超えないように注意する必要があります。これは、 getsockopt を 使用してソケット オプション SO_MAX_MSG_SIZEの値を取得することで取得できます。 データが長すぎて基になるプロトコルをアトミックに通過できない場合は、 エラー WSAEMSGSIZE が返され、データは送信されません。
to パラメーターには、ブロードキャストやマルチキャスト アドレスなど、ソケットのアドレス ファミリ内の任意の有効なアドレスを指定できます。 ブロードキャスト アドレスに送信するには、アプリケーションで setsockopt を使用し、SO_BROADCAST有効にする必要があります。 それ以外の場合、 sendto はエラー コード WSAEACCES で失敗します。 TCP/IP の場合、アプリケーションは任意のマルチキャスト アドレスに送信できます (グループ メンバーになることはありません)。
ソケットが接続されていない場合、
getsockname 関数を使用すると、ソケットに関連付けられているローカル ポート番号を確認できますが、返される IP アドレスは、指定されたプロトコルのワイルドカード アドレスに設定されます (たとえば、IPv4 の場合は INADDR_ANY または "0.0.0.0"、IPv6 の場合は "::" をIN6ADDR_ANY_INIT)。
sendto の正常な完了は、データが正常に配信されたことを示すものではありません。
sendto 関数は、通常、 to パラメーターで識別される特定のピア ソケットにデータグラムを送信するために、コネクションレス ソケットで使用されます。 コネクションレス ソケットが以前に特定のアドレスに接続されていた場合でも、 to パラメーターは、その特定のデータグラムの宛先アドレスのみをオーバーライドします。 接続指向ソケットでは、to パラメーターと tolen パラメーターは無視され、sendto は send と同等になります。
コード例
次の例では、 sendto 関数の使用方法を示します。#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;
WSADATA wsaData;
SOCKET SendSocket = INVALID_SOCKET;
sockaddr_in RecvAddr;
unsigned short Port = 27015;
char SendBuf[1024];
int BufLen = 1024;
//----------------------
// 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 socket for sending data
SendSocket = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
if (SendSocket == INVALID_SOCKET) {
wprintf(L"socket failed with error: %ld\n", WSAGetLastError());
WSACleanup();
return 1;
}
//---------------------------------------------
// Set up the RecvAddr structure with the IP address of
// the receiver (in this example case "192.168.1.1")
// and the specified port number.
RecvAddr.sin_family = AF_INET;
RecvAddr.sin_port = htons(Port);
RecvAddr.sin_addr.s_addr = inet_addr("192.168.1.1");
//---------------------------------------------
// Send a datagram to the receiver
wprintf(L"Sending a datagram to the receiver...\n");
iResult = sendto(SendSocket,
SendBuf, BufLen, 0, (SOCKADDR *) & RecvAddr, sizeof (RecvAddr));
if (iResult == SOCKET_ERROR) {
wprintf(L"sendto failed with error: %d\n", WSAGetLastError());
closesocket(SendSocket);
WSACleanup();
return 1;
}
//---------------------------------------------
// When the application is finished sending, close the socket.
wprintf(L"Finished sending. Closing socket.\n");
iResult = closesocket(SendSocket);
if (iResult == SOCKET_ERROR) {
wprintf(L"closesocket failed with error: %d\n", WSAGetLastError());
WSACleanup();
return 1;
}
//---------------------------------------------
// Clean up and quit.
wprintf(L"Exiting.\n");
WSACleanup();
return 0;
}
IP を使用するソケットの場合 (バージョン 4)
ブロードキャストを (SOCK_DGRAMでのみ) 送信するには、 to パラメーターが指すアドレス を 作成して、特別な IPv4 アドレス INADDR_BROADCAST (Winsock2.h で定義) と目的のポート番号を含めることができます。 to パラメーターが指すアドレス に INADDR_BROADCAST アドレスと目的のポートが含まれている場合、ブロードキャストはそのポートにすべてのインターフェイスで送信されます。ブロードキャストを特定のインターフェイスでのみ送信する必要がある場合は、 to パラメーターが指すアドレスに、インターフェイスのサブネット ブロードキャスト アドレスと目的のポートが含まれている必要があります。 たとえば、サブネット マスクが 255.255.255.0 の 192.168.1.0 の IPv4 ネットワーク アドレスでは、サブネット ブロードキャスト アドレス 192.168.1.255 が使用されます。
通常、ブロードキャスト データグラムが断片化が発生する可能性があるサイズを超えることはできません。つまり、データグラムのデータ部分 (ヘッダーを除く) が 512 バイトを超えないようにする必要があります。
転送するデータを保持するためにトランスポート・システム内に使用可能なバッファー・スペースがない場合、 sendto は、ソケットが非ブロッキング・モードに入っていない限りブロックします。 非ブロッキングのストリーム指向ソケットの場合、書き込まれるバイト数は、クライアントとサーバーの両方のシステムでのバッファーの可用性に応じて、1 から要求された長さの間にすることができます。 select、WSAAsyncSelect、または WSAEventSelect 関数を使用して、より多くのデータを送信できるタイミングを判断できます。
len が 0 の sendto を呼び出すことは許容され、有効な値として 0 を返します。 メッセージ指向ソケットの場合は、長さ 0 のトランスポート・データグラムが送信されます。
flags パラメーターを使用すると、関連するソケットに指定されたオプションを超えて関数呼び出しの動作に影響を与えることができます。 この関数のセマンティクスは、ソケット オプションと flags パラメーターによって決まります。 後者は、次のいずれかの値を持つビットごとの OR 演算子を使用して構築されます。
値 | 説明 |
---|---|
MSG_DONTROUTE | データをルーティングの対象にしないことを指定します。 Windows ソケット サービス プロバイダーは、このフラグを無視することを選択できます。 |
MSG_OOB | OOB データを送信します (SOCK_STREAM などのストリーム スタイルのソケットのみ)。 |
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 (Winsock2.h を含む) |
Library | Ws2_32.lib |
[DLL] | Ws2_32.dll |