Socket.BeginSendFile Metoda

Definice

Obor názvů:

System.Net.Sockets

Sestavení:

System.Net.Sockets.dll

Odešle soubor asynchronně do připojeného Socket objektu.

Přetížení

BeginSendFile(String, AsyncCallback, Object)	Odešle soubor fileName do připojeného Socket objektu pomocí příznaku UseDefaultWorkerThread .
BeginSendFile(String, Byte[], Byte[], TransmitFileOptions, AsyncCallback, Object)	Odešle soubor a vyrovnávací paměť dat asynchronně do připojeného Socket objektu.

BeginSendFile(String, AsyncCallback, Object)

Zdroj:

Socket.cs

Odešle soubor fileName do připojeného Socket objektu pomocí příznaku UseDefaultWorkerThread .

public:
 IAsyncResult ^ BeginSendFile(System::String ^ fileName, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginSendFile (string? fileName, AsyncCallback? callback, object? state);

member this.BeginSendFile : string * AsyncCallback * obj -> IAsyncResult

Public Function BeginSendFile (fileName As String, callback As AsyncCallback, state As Object) As IAsyncResult

Parametry

fileName

String

Řetězec, který obsahuje cestu a název souboru k odeslání. Tento parametr může být null.

callback

AsyncCallback

Delegát.AsyncCallback

state

Object

Objekt, který obsahuje informace o stavu tohoto požadavku.

Návraty

IAsyncResult

Objekt IAsyncResult , který představuje asynchronní odesílání.

Výjimky

ObjectDisposedException

Objekt Socket byl uzavřen.

NotSupportedException

Soket není připojený ke vzdálenému hostiteli.

FileNotFoundException

Soubor fileName nebyl nalezen.

SocketException

Pouze rozhraní .NET Framework a .NET 5 a starší: Při pokusu o přístup k soketu došlo k chybě. Viz část s poznámkami níže.

Poznámky

Důležité

Toto je rozhraní API pro kompatibilitu. Pro nový vývoj nedoporučujeme používat metody APM (Begin* a End*). Místo toho použijte ekvivalenty založené na Task.

Toto přetížení odešle soubor fileName přes soket. Pokud fileName je v místním adresáři, může být označen pouze názvem souboru, jinak musí být zadána úplná cesta a název souboru. Zástupné é (".. \\myfile.txt") a názvy sdílených složek UNC ("\\\shared directory\\myfile.txt") jsou podporovány. Pokud soubor není nalezen, vyvolá se výjimka FileNotFoundException .

Zpětné volání, které se implementuje AsyncCallback do BeginSendFile , můžete předat, abyste dostali oznámení o dokončení operace. Všimněte si, že pokud podkladový síťový zásobník dokončí operaci synchronně, provede se zpětné volání přímo během volání nástroje BeginSendFile. V tomto případě CompletedSynchronously bude vlastnost vrácena IAsyncResult na hodnotu, která true označuje, že metoda byla dokončena synchronně. AsyncState K získání objektu IAsyncResult stavu předaného metodě použijte vlastnost objektuBeginSendFile.

Operace BeginSendFile musí být dokončena voláním EndSendFile metody. Obvykle je metoda vyvolána delegátem AsyncCallback . EndSendFile zablokuje volající vlákno, dokud se operace nedokonči.

I když jsou určeny pro protokoly orientované na připojení, BeginSendFile funguje také pro protokoly bez připojení, za předpokladu, že nejprve zavoláte metodu Connect nebo BeginConnect pro vytvoření výchozího vzdáleného hostitele. U protokolů bez připojení musíte mít jistotu, že velikost souboru nepřekračuje maximální velikost paketů příslušného poskytovatele služeb. Pokud ano, datagram se neodesílají a BeginSendFile vyvolá SocketException výjimku.

Poznámka

Pokud se SocketException zobrazí výjimka, použijte SocketException.ErrorCode vlastnost k získání konkrétního kódu chyby.

Poznámka

Tento člen poskytuje trasovací informace, když je ve vaší aplikaci povoleno trasování sítě. Další informace najdete v tématu Trasování sítě v rozhraní .NET Framework.

Poznámka

Kontext spuštění (kontext zabezpečení, zosobněný uživatel a kontext volání) se ukládá do mezipaměti pro asynchronní Socket metody. Po prvním použití konkrétního kontextu (konkrétní asynchronní Socket metody, konkrétní Socket instance a konkrétního zpětného volání) se při následných použitích tohoto kontextu projeví zlepšení výkonu.

BeginSendFile(String, Byte[], Byte[], TransmitFileOptions, AsyncCallback, Object)

Zdroj:

Socket.cs

Odešle soubor a vyrovnávací paměť dat asynchronně do připojeného Socket objektu.

public:
 IAsyncResult ^ BeginSendFile(System::String ^ fileName, cli::array <System::Byte> ^ preBuffer, cli::array <System::Byte> ^ postBuffer, System::Net::Sockets::TransmitFileOptions flags, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginSendFile (string? fileName, byte[]? preBuffer, byte[]? postBuffer, System.Net.Sockets.TransmitFileOptions flags, AsyncCallback? callback, object? state);

member this.BeginSendFile : string * byte[] * byte[] * System.Net.Sockets.TransmitFileOptions * AsyncCallback * obj -> IAsyncResult

Public Function BeginSendFile (fileName As String, preBuffer As Byte(), postBuffer As Byte(), flags As TransmitFileOptions, callback As AsyncCallback, state As Object) As IAsyncResult

Parametry

fileName

String

Řetězec, který obsahuje cestu a název souboru, který se má odeslat. Tento parametr může být null.

preBuffer

Byte[]

Data, která se mají odeslat před odesláním souboru. Tento parametr může být null.

postBuffer

Byte[]

Data, která se mají odeslat po odeslání souboru. Tento parametr může být null.

flags

TransmitFileOptions

Bitová kombinace hodnot výčtu.

callback

AsyncCallback

Delegát AsyncCallback , který má být vyvolán po dokončení této operace. Tento parametr může být null.

state

Object

Uživatelem definovaný objekt, který obsahuje informace o stavu pro tento požadavek. Tento parametr může být null.

Návraty

IAsyncResult

Objekt IAsyncResult , který představuje asynchronní operaci.

Výjimky

ObjectDisposedException

Objekt Socket byl uzavřen.

SocketException

Pouze rozhraní .NET Framework a .NET 5 a starší: Při pokusu o přístup k soketu došlo k chybě. Viz část s poznámkami níže.

NotSupportedException

Operační systém není systém Windows NT nebo novější.

-nebo-

Soket není připojený ke vzdálenému hostiteli.

FileNotFoundException

Soubor fileName nebyl nalezen.

Poznámky

Důležité

Toto je rozhraní API pro kompatibilitu. Pro nový vývoj nedoporučujeme používat metody APM (Begin* a End*). Místo toho použijte ekvivalenty založené na Task.

Toto přetížení vyžaduje název souboru, který chcete odeslat, a bitovou kombinaci TransmitFileOptions hodnot. Parametr preBuffer obsahuje všechna data, která chcete před souborem předcházet. postBuffer obsahuje data, která chcete sledovat v souboru. Pokud fileName je v místním adresáři, může být označen pouze názvem souboru, jinak musí být zadána úplná cesta a název souboru. Zástupné é (".. \\myfile.txt") a názvy sdílených složek UNC ("\\\shared directory\\myfile.txt") jsou podporovány. Pokud soubor není nalezen, vyvolá se výjimka FileNotFoundException .

Parametr flags poskytuje další informace o přenosu souborů. Další informace o použití tohoto parametru najdete v tématu TransmitFileOptions.

Zpětné volání, které se implementuje AsyncCallback do BeginSendFile , můžete předat, abyste dostali oznámení o dokončení operace. Všimněte si, že pokud podkladový síťový zásobník dokončí operaci synchronně, provede se zpětné volání přímo během volání nástroje BeginSendFile. V tomto případě CompletedSynchronously bude vlastnost vrácena IAsyncResult na hodnotu, která true označuje, že metoda byla dokončena synchronně. AsyncState K získání objektu IAsyncResult stavu předaného metodě použijte vlastnost objektuBeginSendFile.

Operace BeginSendFile musí být dokončena voláním EndSendFile metody. Obvykle je metoda vyvolána poskytnutým AsyncCallback delegátem. EndSendFile zablokuje volající vlákno, dokud se operace nedokonči.

I když jsou určeny pro protokoly orientované na připojení, BeginSendFile funguje také pro protokoly bez připojení, za předpokladu, že nejprve zavoláte metodu Connect nebo BeginConnect pro vytvoření výchozího vzdáleného hostitele. U protokolů bez připojení musíte mít jistotu, že velikost souboru nepřekračuje maximální velikost paketů příslušného poskytovatele služeb. Pokud ano, datagram se neodesílají a BeginSendFile vyvolá SocketException výjimku.

Poznámka

Pokud se SocketException zobrazí výjimka, použijte SocketException.ErrorCode vlastnost k získání konkrétního kódu chyby.

Poznámka

Tento člen poskytuje trasovací informace, když je ve vaší aplikaci povoleno trasování sítě. Další informace najdete v tématu Trasování sítě v rozhraní .NET Framework.

Poznámka

Kontext spuštění (kontext zabezpečení, zosobněný uživatel a kontext volání) se ukládá do mezipaměti pro asynchronní Socket metody. Po prvním použití konkrétního kontextu (konkrétní asynchronní Socket metody, konkrétní Socket instance a konkrétního zpětného volání) se při následných použitích tohoto kontextu projeví zlepšení výkonu.