send
関数シグネチャ
// WS2_32.dll
#include <windows.h>
INT send(
SOCKET s,
LPCSTR buf,
INT len,
SEND_RECV_FLAGS flags
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| s | SOCKET | in | 接続済みソケットを識別するデスクリプタです。 | ||||||
| buf | LPCSTR | in | 送信するデータを格納したバッファへのポインタです。 | ||||||
| len | INT | in | buf パラメータが指すバッファ内のデータの長さ(バイト単位)です。 | ||||||
| flags | SEND_RECV_FLAGS | in | 呼び出しの方法を指定するフラグのセットです。このパラメータは、次の値のいずれかをビットごとの OR 演算子で組み合わせて構成します。
|
戻り値の型: INT
公式ドキュメント
接続済みのソケットでデータを送信します。(send)
戻り値
エラーが発生しなかった場合、 send は送信されたバイトの総数を返します。これは len パラメータで送信を要求したバイト数より少ない場合があります。それ以外の場合は SOCKET_ERROR が返され、 WSAGetLastError を呼び出すことで特定のエラーコードを取得できます。
| エラーコード | 意味 |
|---|---|
| この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。 | |
| ネットワークサブシステムが失敗しました。 | |
| 要求されたアドレスがブロードキャストアドレスですが、適切なフラグが設定されていませんでした。ブロードキャストアドレスの使用を有効にするには、SO_BROADCAST ソケットオプションを指定して setsockopt を呼び出してください。 | |
| ブロッキングする Windows Sockets 1.1 の呼び出しが WSACancelBlockingCall によってキャンセルされました。 | |
| ブロッキングする Windows Sockets 1.1 の呼び出しが進行中であるか、サービスプロバイダがまだコールバック関数を処理しています。 | |
| buf パラメータが、ユーザーアドレス空間の有効な部分に完全には含まれていません。 | |
| 操作の進行中に keep-alive 動作が障害を検出したため、接続が切断されました。 | |
| 利用可能なバッファ領域がありません。 | |
| ソケットが接続されていません。 | |
| デスクリプタがソケットではありません。 | |
| MSG_OOB が指定されましたが、ソケットが SOCK_STREAM 型などのストリーム型ではない、このソケットに関連付けられた通信ドメインで OOB データがサポートされていない、またはソケットが単方向で受信操作のみをサポートしています。 | |
| ソケットがシャットダウンされています。how を SD_SEND または SD_BOTH に設定して shutdown を呼び出した後は、ソケットで送信を行うことはできません。 | |
| ソケットが非ブロッキングとしてマークされており、要求された操作がブロックされます。 | |
| ソケットがメッセージ指向であり、メッセージが基盤となるトランスポートでサポートされる最大値を超えています。 | |
| 現時点で、このホストからリモートホストに到達できません。 | |
| ソケットが bind でバインドされていない、不明なフラグが指定された、または SO_OOBINLINE が有効なソケットに対して MSG_OOB が指定されました。 | |
| タイムアウトまたはその他の障害により、仮想回線が終了しました。ソケットは使用できなくなったため、アプリケーションはソケットをクローズする必要があります。 | |
| リモート側がハードクローズまたは強制クローズを実行したため、仮想回線がリセットされました。UDP ソケットの場合、リモートホストが以前に送信された UDP データグラムを配信できず、「Port Unreachable」ICMP パケットで応答しました。ソケットは使用できなくなったため、アプリケーションはソケットをクローズする必要があります。 | |
| ネットワーク障害、または通知なしに相手側のシステムがダウンしたため、接続が切断されました。 |
解説(Remarks)
send 関数は、接続済みソケットで送信データを書き込むために使用します。
メッセージ指向ソケット(例えば、アドレスファミリが AF_INET または AF_INET6、型が SOCK_DGRAM、プロトコルが IPPROTO_UDP のもの)の場合、基盤となるプロバイダの最大パケットサイズを超えないように注意する必要があります。プロバイダの最大メッセージパケットサイズは、optname パラメータを SO_MAX_MSG_SIZE に設定して getsockopt を呼び出し、ソケットオプションの値を取得することで得られます。データが長すぎて基盤となるプロトコルを通じてアトミックに渡せない場合、エラー WSAEMSGSIZE が返され、データは送信されません。
send 関数が正常に完了しても、データが受信側に正常に配信および受信されたことを示すものではありません。この関数はデータが正常に送信されたことのみを示します。
送信するデータを保持するためのバッファ領域がトランスポートシステム内に利用できない場合、ソケットが非ブロッキングモードに設定されていない限り、send はブロックします。非ブロッキングのストリーム指向ソケットでは、書き込まれるバイト数は、クライアントとサーバー双方のコンピュータでのバッファの利用可能性に応じて、1 から要求された長さまでの間になります。さらにデータを送信できるようになるタイミングを判断するには、 select、 WSAAsyncSelect、または WSAEventSelect 関数を使用できます。
len パラメータを 0 にして send を呼び出すことは許可されており、実装によって成功として扱われます。この場合、send は有効な値として 0 を返します。メッセージ指向ソケットの場合、長さ 0 のトランスポートデータグラムが送信されます。
flags パラメータは、関連付けられたソケットに指定されたオプションを超えて、関数の動作に影響を与えるために使用できます。send 関数のセマンティクスは、s パラメータで指定されたソケットに以前に設定されたオプションと、send 関数に渡された flags パラメータによって決まります。
send への呼び出しの順序は、バッファがトランスポート層に送信される順序でもあります。一部の Winsock プロバイダは大きな送信リクエストを複数の送信に分割する場合があり、同一のストリーム指向ソケットに対する複数の同時送信リクエストから意図しないデータのインターリーブが発生する可能性があるため、同一のストリーム指向ソケットに対して異なるスレッドから同時に send を呼び出してはなりません。
サンプルコード
次の例は、send 関数の使用方法を示しています。#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")
#define DEFAULT_BUFLEN 512
#define DEFAULT_PORT 27015
int main() {
//----------------------
// Declare and initialize variables.
int iResult;
WSADATA wsaData;
SOCKET ConnectSocket = INVALID_SOCKET;
struct sockaddr_in clientService;
int recvbuflen = DEFAULT_BUFLEN;
char *sendbuf = "Client: sending data test";
char recvbuf[DEFAULT_BUFLEN] = "";
//----------------------
// 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 connecting to server
ConnectSocket = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
if (ConnectSocket == INVALID_SOCKET) {
wprintf(L"socket failed with error: %ld\n", WSAGetLastError());
WSACleanup();
return 1;
}
//----------------------
// The sockaddr_in structure specifies the address family,
// IP address, and port of the server to be connected to.
clientService.sin_family = AF_INET;
clientService.sin_addr.s_addr = inet_addr( "127.0.0.1" );
clientService.sin_port = htons( DEFAULT_PORT );
//----------------------
// Connect to server.
iResult = connect( ConnectSocket, (SOCKADDR*) &clientService, sizeof(clientService) );
if (iResult == SOCKET_ERROR) {
wprintf(L"connect failed with error: %d\n", WSAGetLastError() );
closesocket(ConnectSocket);
WSACleanup();
return 1;
}
//----------------------
// Send an initial buffer
iResult = send( ConnectSocket, sendbuf, (int)strlen(sendbuf), 0 );
if (iResult == SOCKET_ERROR) {
wprintf(L"send failed with error: %d\n", WSAGetLastError());
closesocket(ConnectSocket);
WSACleanup();
return 1;
}
printf("Bytes Sent: %d\n", iResult);
// shutdown the connection since no more data will be sent
iResult = shutdown(ConnectSocket, SD_SEND);
if (iResult == SOCKET_ERROR) {
wprintf(L"shutdown failed with error: %d\n", WSAGetLastError());
closesocket(ConnectSocket);
WSACleanup();
return 1;
}
// Receive until the peer closes the connection
do {
iResult = recv(ConnectSocket, recvbuf, recvbuflen, 0);
if ( iResult > 0 )
wprintf(L"Bytes received: %d\n", iResult);
else if ( iResult == 0 )
wprintf(L"Connection closed\n");
else
wprintf(L"recv failed with error: %d\n", WSAGetLastError());
} while( iResult > 0 );
// close the socket
iResult = closesocket(ConnectSocket);
if (iResult == SOCKET_ERROR) {
wprintf(L"close failed with error: %d\n", WSAGetLastError());
WSACleanup();
return 1;
}
WSACleanup();
return 0;
}
サンプルコード
send 関数を使用する別の例については、Getting Started With Winsock を参照してください。IrDA ソケットに関する注意
- Af_irda.h ヘッダーファイルを明示的にインクルードする必要があります。
Windows 8.1 および Windows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストアアプリでサポートされています。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// WS2_32.dll
#include <windows.h>
INT send(
SOCKET s,
LPCSTR buf,
INT len,
SEND_RECV_FLAGS flags
);[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern int send(
UIntPtr s, // SOCKET
[MarshalAs(UnmanagedType.LPStr)] string buf, // LPCSTR
int len, // INT
int flags // SEND_RECV_FLAGS
);<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function send(
s As UIntPtr, ' SOCKET
<MarshalAs(UnmanagedType.LPStr)> buf As String, ' LPCSTR
len As Integer, ' INT
flags As Integer ' SEND_RECV_FLAGS
) As Integer
End Function' s : SOCKET
' buf : LPCSTR
' len : INT
' flags : SEND_RECV_FLAGS
Declare PtrSafe Function send Lib "ws2_32" ( _
ByVal s As LongPtr, _
ByVal buf As String, _
ByVal len As Long, _
ByVal flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
send = ctypes.windll.ws2_32.send
send.restype = ctypes.c_int
send.argtypes = [
ctypes.c_size_t, # s : SOCKET
wintypes.LPCSTR, # buf : LPCSTR
ctypes.c_int, # len : INT
ctypes.c_int, # flags : SEND_RECV_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('WS2_32.dll')
send = Fiddle::Function.new(
lib['send'],
[
Fiddle::TYPE_UINTPTR_T, # s : SOCKET
Fiddle::TYPE_VOIDP, # buf : LPCSTR
Fiddle::TYPE_INT, # len : INT
Fiddle::TYPE_INT, # flags : SEND_RECV_FLAGS
],
Fiddle::TYPE_INT)#[link(name = "ws2_32")]
extern "system" {
fn send(
s: usize, // SOCKET
buf: *const u8, // LPCSTR
len: i32, // INT
flags: i32 // SEND_RECV_FLAGS
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern int send(UIntPtr s, [MarshalAs(UnmanagedType.LPStr)] string buf, int len, int flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_send' -Namespace Win32 -PassThru
# $api::send(s, buf, len, flags)#uselib "WS2_32.dll"
#func global send "send" sptr, sptr, sptr, sptr
; send s, buf, len, flags ; 戻り値は stat
; s : SOCKET -> "sptr"
; buf : LPCSTR -> "sptr"
; len : INT -> "sptr"
; flags : SEND_RECV_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "WS2_32.dll"
#cfunc global send "send" sptr, str, int, int
; res = send(s, buf, len, flags)
; s : SOCKET -> "sptr"
; buf : LPCSTR -> "str"
; len : INT -> "int"
; flags : SEND_RECV_FLAGS -> "int"; INT send(SOCKET s, LPCSTR buf, INT len, SEND_RECV_FLAGS flags)
#uselib "WS2_32.dll"
#cfunc global send "send" intptr, str, int, int
; res = send(s, buf, len, flags)
; s : SOCKET -> "intptr"
; buf : LPCSTR -> "str"
; len : INT -> "int"
; flags : SEND_RECV_FLAGS -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
ws2_32 = windows.NewLazySystemDLL("WS2_32.dll")
procsend = ws2_32.NewProc("send")
)
// s (SOCKET), buf (LPCSTR), len (INT), flags (SEND_RECV_FLAGS)
r1, _, err := procsend.Call(
uintptr(s),
uintptr(unsafe.Pointer(windows.BytePtrFromString(buf))),
uintptr(len),
uintptr(flags),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction send(
s: NativeUInt; // SOCKET
buf: PAnsiChar; // LPCSTR
len: Integer; // INT
flags: Integer // SEND_RECV_FLAGS
): Integer; stdcall;
external 'WS2_32.dll' name 'send';result := DllCall("WS2_32\send"
, "UPtr", s ; SOCKET
, "AStr", buf ; LPCSTR
, "Int", len ; INT
, "Int", flags ; SEND_RECV_FLAGS
, "Int") ; return: INT●send(s, buf, len, flags) = DLL("WS2_32.dll", "int send(int, char*, int, int)")
# 呼び出し: send(s, buf, len, flags)
# s : SOCKET -> "int"
# buf : LPCSTR -> "char*"
# len : INT -> "int"
# flags : SEND_RECV_FLAGS -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "ws2_32" fn send(
s: usize, // SOCKET
buf: [*c]const u8, // LPCSTR
len: i32, // INT
flags: i32 // SEND_RECV_FLAGS
) callconv(std.os.windows.WINAPI) i32;proc send(
s: uint, # SOCKET
buf: cstring, # LPCSTR
len: int32, # INT
flags: int32 # SEND_RECV_FLAGS
): int32 {.importc: "send", stdcall, dynlib: "WS2_32.dll".}pragma(lib, "ws2_32");
extern(Windows)
int send(
size_t s, // SOCKET
const(char)* buf, // LPCSTR
int len, // INT
int flags // SEND_RECV_FLAGS
);ccall((:send, "WS2_32.dll"), stdcall, Int32,
(Csize_t, Cstring, Int32, Int32),
s, buf, len, flags)
# s : SOCKET -> Csize_t
# buf : LPCSTR -> Cstring
# len : INT -> Int32
# flags : SEND_RECV_FLAGS -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t send(
uintptr_t s,
const char* buf,
int32_t len,
int32_t flags);
]]
local ws2_32 = ffi.load("ws2_32")
-- ws2_32.send(s, buf, len, flags)
-- s : SOCKET
-- buf : LPCSTR
-- len : INT
-- flags : SEND_RECV_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('WS2_32.dll');
const send = lib.func('__stdcall', 'send', 'int32_t', ['uintptr_t', 'str', 'int32_t', 'int32_t']);
// send(s, buf, len, flags)
// s : SOCKET -> 'uintptr_t'
// buf : LPCSTR -> 'str'
// len : INT -> 'int32_t'
// flags : SEND_RECV_FLAGS -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("WS2_32.dll", {
send: { parameters: ["usize", "buffer", "i32", "i32"], result: "i32" },
});
// lib.symbols.send(s, buf, len, flags)
// s : SOCKET -> "usize"
// buf : LPCSTR -> "buffer"
// len : INT -> "i32"
// flags : SEND_RECV_FLAGS -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t send(
size_t s,
const char* buf,
int32_t len,
int32_t flags);
C, "WS2_32.dll");
// $ffi->send(s, buf, len, flags);
// s : SOCKET
// buf : LPCSTR
// len : INT
// flags : SEND_RECV_FLAGS
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Ws2_32 extends StdCallLibrary {
Ws2_32 INSTANCE = Native.load("ws2_32", Ws2_32.class);
int send(
long s, // SOCKET
String buf, // LPCSTR
int len, // INT
int flags // SEND_RECV_FLAGS
);
}@[Link("ws2_32")]
lib LibWS2_32
fun send = send(
s : LibC::SizeT, # SOCKET
buf : UInt8*, # LPCSTR
len : Int32, # INT
flags : Int32 # SEND_RECV_FLAGS
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef sendNative = Int32 Function(UintPtr, Pointer<Utf8>, Int32, Int32);
typedef sendDart = int Function(int, Pointer<Utf8>, int, int);
final send = DynamicLibrary.open('WS2_32.dll')
.lookupFunction<sendNative, sendDart>('send');
// s : SOCKET -> UintPtr
// buf : LPCSTR -> Pointer<Utf8>
// len : INT -> Int32
// flags : SEND_RECV_FLAGS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function send(
s: NativeUInt; // SOCKET
buf: PAnsiChar; // LPCSTR
len: Integer; // INT
flags: Integer // SEND_RECV_FLAGS
): Integer; stdcall;
external 'WS2_32.dll' name 'send';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "send"
c_send :: CUIntPtr -> CString -> Int32 -> Int32 -> IO Int32
-- s : SOCKET -> CUIntPtr
-- buf : LPCSTR -> CString
-- len : INT -> Int32
-- flags : SEND_RECV_FLAGS -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let send =
foreign "send"
(size_t @-> string @-> int32_t @-> int32_t @-> returning int32_t)
(* s : SOCKET -> size_t *)
(* buf : LPCSTR -> string *)
(* len : INT -> int32_t *)
(* flags : SEND_RECV_FLAGS -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library ws2_32 (t "WS2_32.dll"))
(cffi:use-foreign-library ws2_32)
(cffi:defcfun ("send" send :convention :stdcall) :int32
(s :uint64) ; SOCKET
(buf :string) ; LPCSTR
(len :int32) ; INT
(flags :int32)) ; SEND_RECV_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $send = Win32::API::More->new('WS2_32',
'int send(WPARAM s, LPCSTR buf, int len, int flags)');
# my $ret = $send->Call($s, $buf, $len, $flags);
# s : SOCKET -> WPARAM
# buf : LPCSTR -> LPCSTR
# len : INT -> int
# flags : SEND_RECV_FLAGS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f WSAAsyncSelect — ソケットのネットワークイベント通知をウィンドウメッセージで要求する。
- f WSAEventSelect — ソケットのネットワークイベントをイベントオブジェクトに関連付ける。
- f recv — 接続ソケットからデータを受信する。
- f recvfrom — ソケットからデータを受信し送信元アドレスを取得する。
- f select — 複数ソケットの入出力可否を監視する。
- f sendto — 指定アドレス宛にソケットでデータを送信する。
- f socket — 指定したアドレスファミリ・型・プロトコルのソケットを作成する。