TransmitFileOptions 列挙型

定義

TransmitFileOptions 列挙は、ファイル転送要求で使用される値を定義します。

この列挙体は、メンバー値のビットごとの組み合わせをサポートしています。

public enum class TransmitFileOptions
[System.Flags]
public enum TransmitFileOptions
[<System.Flags>]
type TransmitFileOptions = 
Public Enum TransmitFileOptions
継承
TransmitFileOptions
属性

フィールド

名前 説明
UseDefaultWorkerThread 0

既定のスレッドを使用して、長いファイル転送要求を処理します。

Disconnect 1

転送のためにすべてのファイル データがキューに登録された後、トランスポート レベルの切断を開始します。 ReuseSocketと共に使用すると、これらのフラグは、ファイルが送信された後に、接続されていない再利用可能な状態にソケットを返します。

ReuseSocket 2

要求が完了すると、ソケット ハンドルが再利用される場合があります。 このフラグは、 Disconnect も指定されている場合にのみ有効です。 Disconnectと共に使用すると、これらのフラグは、ファイルが送信された後に、接続されていない再利用可能な状態にソケットを返します。

WriteBehind 4

保留中の状態で、ファイル転送要求をすぐに完了します。 このフラグが指定され、ファイル転送が成功した場合、データはシステムによって受け入れられますが、必ずしもリモート側で確認されるとは限りません。 このフラグは、 Disconnect フラグと ReuseSocket フラグと共に使用しないでください。

UseSystemThread 16

システム スレッドを使用して、長いファイル転送要求を処理します。

UseKernelApc 32

長いファイル転送要求を処理するには、ワーカー スレッドの代わりにカーネル非同期プロシージャ 呼び出し (APC) を使用します。 長い要求は、ファイルまたはキャッシュからの 1 つ以上の読み取りを必要とする要求として定義されます。したがって、要求はファイルのサイズと送信パケットの指定された長さに依存します。

次の例では、TransmitFileOptionsの呼び出しでSocket.SendFileを使用する方法を示します。 ファイル "test.txt" は、ローカル コンピューターのルート ディレクトリにあります。 この例では、データのプリバッファーとポストバッファーが作成され、ファイルを使用してリモート ホストに送信されます。 システムの既定のスレッドを使用するには、 UseDefaultWorkerThread を指定します。

// Establish the local endpoint for the socket.
IPHostEntry ipHost = Dns.GetHostEntry(Dns.GetHostName());
IPAddress  ipAddr = ipHost.AddressList[0];
IPEndPoint ipEndPoint = new IPEndPoint(ipAddr, 11000);

// Create a TCP socket.
Socket client = new Socket(AddressFamily.InterNetwork,
        SocketType.Stream, ProtocolType.Tcp);

// Connect the socket to the remote endpoint.
client.Connect(ipEndPoint);

// Send file fileName to the remote host with preBuffer and postBuffer data.
// There is a text file test.txt located in the root directory.
string fileName = "C:\\test.txt";

// Create the preBuffer data.
string string1 = String.Format("This is text data that precedes the file.{0}", Environment.NewLine);
byte[] preBuf = Encoding.ASCII.GetBytes(string1);

// Create the postBuffer data.
string string2 = String.Format("This is text data that will follow the file.{0}", Environment.NewLine);
byte[] postBuf = Encoding.ASCII.GetBytes(string2);

//Send file fileName with buffers and default flags to the remote device.
Console.WriteLine("Sending {0} with buffers to the host.{1}", fileName, Environment.NewLine);
client.SendFile(fileName, preBuf, postBuf, TransmitFileOptions.UseDefaultWorkerThread);

// Release the socket.
client.Shutdown(SocketShutdown.Both);
client.Close();

注釈

Note

フラグは Disconnect し、 ReuseSocket ファイルが送信された後、切断された再利用可能な状態にソケットを返します。 サービス プロバイダーは、ファイル転送が完了する前にソケットに関連付けられているサービスの品質を直ちに削除する可能性があるため、サービス品質 (QOS) が要求されたソケットでは、これらのフラグを使用しないでください。 QOS 対応ソケットの最善の方法は、これらのフラグに依存するのではなく、ファイル転送が完了したときに Socket.Close を呼び出す方法です。

適用対象