ThreadPool.RegisterWaitForSingleObject Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Zaregistruje delegáta, který čeká na WaitHandle.
Přetížení
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, UInt32, Boolean) |
Zaregistruje delegáta pro čekání na WaitHandle, a určí 32bitové celé číslo bez znaménka pro časový limit v milisekundách. |
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, TimeSpan, Boolean) |
Zaregistruje delegáta, který bude čekat na WaitHandlea zadá TimeSpan hodnotu časového limitu. |
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int32, Boolean) |
Zaregistruje delegáta, který bude čekat WaitHandlena , a určí 32bitové celé číslo se znaménkem pro časový limit v milisekundách. |
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int64, Boolean) |
Zaregistruje delegáta pro čekání WaitHandlena , a určí 64bitové celé číslo se znaménkem pro časový limit v milisekundách. |
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, UInt32, Boolean)
- Zdroj:
- ThreadPoolWorkQueue.cs
- Zdroj:
- ThreadPoolWorkQueue.cs
- Zdroj:
- ThreadPoolWorkQueue.cs
Důležité
Toto rozhraní API neodpovídá specifikaci CLS.
Zaregistruje delegáta pro čekání na WaitHandle, a určí 32bitové celé číslo bez znaménka pro časový limit v milisekundách.
public:
static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, System::UInt32 millisecondsTimeOutInterval, bool executeOnlyOnce);
[System.CLSCompliant(false)]
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, uint millisecondsTimeOutInterval, bool executeOnlyOnce);
[System.CLSCompliant(false)]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, uint millisecondsTimeOutInterval, bool executeOnlyOnce);
[System.CLSCompliant(false)]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, uint millisecondsTimeOutInterval, bool executeOnlyOnce);
[<System.CLSCompliant(false)>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * uint32 * bool -> System.Threading.RegisteredWaitHandle
[<System.CLSCompliant(false)>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * uint32 * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As UInteger, executeOnlyOnce As Boolean) As RegisteredWaitHandle
Parametry
- waitObject
- WaitHandle
K WaitHandle registraci. Použijte jiný než WaitHandleMutex.
- callBack
- WaitOrTimerCallback
Delegát, WaitOrTimerCallback který se má volat při signálu parametru waitObject
.
- state
- Object
Objekt předaný delegátu.
- millisecondsTimeOutInterval
- UInt32
Časový limit v milisekundách.
millisecondsTimeOutInterval
Pokud je parametr 0 (nula), funkce otestuje stav objektu a okamžitě vrátí hodnotu . Pokud millisecondsTimeOutInterval
je hodnota -1, časový limit funkce nikdy neuplyne.
- executeOnlyOnce
- Boolean
true
k označení, že vlákno již nebude čekat na waitObject
parametr po zavolání delegáta; false
k označení, že časovač se resetuje při každém dokončení operace čekání, dokud se neregistruje čekání.
Návraty
Slouží RegisteredWaitHandle ke zrušení registrované operace čekání.
- Atributy
Výjimky
Parametr millisecondsTimeOutInterval
je menší než -1.
Příklady
Následující příklad ukazuje, jak použít metodu RegisterWaitForSingleObject ke spuštění zadané metody zpětného volání při signálu zadaného obslužného rutiny čekání. V tomto příkladu je WaitProc
metoda zpětného volání a obslužným rutinou AutoResetEventčekání je .
Příklad definuje TaskInfo
třídu pro uložení informací, které se předávají zpětnému volání při spuštění. Příklad vytvoří TaskInfo
objekt a přiřadí mu nějaká řetězcová data. Objekt RegisteredWaitHandle vrácený metodou RegisterWaitForSingleObject je přiřazen k Handle
poli objektu TaskInfo
tak, aby metoda zpětného volání získala přístup k objektu RegisteredWaitHandle.
Kromě určení TaskInfo
jako objektu předat zpětné volání metody volání volání volání metoda RegisterWaitForSingleObject určuje AutoResetEvent , na které bude úloha čekat, delegáta, WaitOrTimerCallback který představuje metodu WaitProc
zpětného volání, interval časového limitu jedné sekundy a více zpětných volání.
Když hlavní vlákno signalizuje AutoResetEvent voláním jeho Set metody, WaitOrTimerCallback delegát je vyvolána. Metoda WaitProc
testuje RegisteredWaitHandle , zda došlo k vypršení časového limitu. Pokud bylo zpětné volání vyvoláno, protože byl signalován popisovač čekání, WaitProc
metoda zruší registraci RegisteredWaitHandle, zastavuje další zpětná volání. V případě vypršení časového limitu úkol dál čeká. Metoda WaitProc
končí tiskem zprávy do konzoly.
using namespace System;
using namespace System::Threading;
// TaskInfo contains data that will be passed to the callback
// method.
public ref class TaskInfo
{
public:
TaskInfo()
{
Handle = nullptr;
OtherInfo = "default";
}
RegisteredWaitHandle^ Handle;
String^ OtherInfo;
};
ref class Example
{
public:
// The callback method executes when the registered wait times out,
// or when the WaitHandle (in this case AutoResetEvent) is signaled.
// WaitProc unregisters the WaitHandle the first time the event is
// signaled.
static void WaitProc( Object^ state, bool timedOut )
{
// The state Object must be cast to the correct type, because the
// signature of the WaitOrTimerCallback delegate specifies type
// Object.
TaskInfo^ ti = static_cast<TaskInfo^>(state);
String^ cause = "TIMED OUT";
if ( !timedOut )
{
cause = "SIGNALED";
// If the callback method executes because the WaitHandle is
// signaled, stop future execution of the callback method
// by unregistering the WaitHandle.
if ( ti->Handle != nullptr )
ti->Handle->Unregister( nullptr );
}
Console::WriteLine( "WaitProc( {0}) executes on thread {1}; cause = {2}.", ti->OtherInfo, Thread::CurrentThread->GetHashCode(), cause );
}
};
int main()
{
// The main thread uses AutoResetEvent to signal the
// registered wait handle, which executes the callback
// method.
AutoResetEvent^ ev = gcnew AutoResetEvent( false );
TaskInfo^ ti = gcnew TaskInfo;
ti->OtherInfo = "First task";
// The TaskInfo for the task includes the registered wait
// handle returned by RegisterWaitForSingleObject. This
// allows the wait to be terminated when the object has
// been signaled once (see WaitProc).
ti->Handle = ThreadPool::RegisterWaitForSingleObject( ev, gcnew WaitOrTimerCallback( Example::WaitProc ), ti, 1000, false );
// The main thread waits three seconds, to demonstrate the
// time-outs on the queued thread, and then signals.
Thread::Sleep( 3100 );
Console::WriteLine( "Main thread signals." );
ev->Set();
// The main thread sleeps, which should give the callback
// method time to execute. If you comment out this line, the
// program usually ends before the ThreadPool thread can execute.
Thread::Sleep( 1000 );
// If you start a thread yourself, you can wait for it to end
// by calling Thread::Join. This option is not available with
// thread pool threads.
return 0;
}
using System;
using System.Threading;
// TaskInfo contains data that will be passed to the callback
// method.
public class TaskInfo {
public RegisteredWaitHandle Handle = null;
public string OtherInfo = "default";
}
public class Example {
public static void Main(string[] args) {
// The main thread uses AutoResetEvent to signal the
// registered wait handle, which executes the callback
// method.
AutoResetEvent ev = new AutoResetEvent(false);
TaskInfo ti = new TaskInfo();
ti.OtherInfo = "First task";
// The TaskInfo for the task includes the registered wait
// handle returned by RegisterWaitForSingleObject. This
// allows the wait to be terminated when the object has
// been signaled once (see WaitProc).
ti.Handle = ThreadPool.RegisterWaitForSingleObject(
ev,
new WaitOrTimerCallback(WaitProc),
ti,
1000,
false
);
// The main thread waits three seconds, to demonstrate the
// time-outs on the queued thread, and then signals.
Thread.Sleep(3100);
Console.WriteLine("Main thread signals.");
ev.Set();
// The main thread sleeps, which should give the callback
// method time to execute. If you comment out this line, the
// program usually ends before the ThreadPool thread can execute.
Thread.Sleep(1000);
// If you start a thread yourself, you can wait for it to end
// by calling Thread.Join. This option is not available with
// thread pool threads.
}
// The callback method executes when the registered wait times out,
// or when the WaitHandle (in this case AutoResetEvent) is signaled.
// WaitProc unregisters the WaitHandle the first time the event is
// signaled.
public static void WaitProc(object state, bool timedOut) {
// The state object must be cast to the correct type, because the
// signature of the WaitOrTimerCallback delegate specifies type
// Object.
TaskInfo ti = (TaskInfo) state;
string cause = "TIMED OUT";
if (!timedOut) {
cause = "SIGNALED";
// If the callback method executes because the WaitHandle is
// signaled, stop future execution of the callback method
// by unregistering the WaitHandle.
if (ti.Handle != null)
ti.Handle.Unregister(null);
}
Console.WriteLine("WaitProc( {0} ) executes on thread {1}; cause = {2}.",
ti.OtherInfo,
Thread.CurrentThread.GetHashCode().ToString(),
cause
);
}
}
Imports System.Threading
' TaskInfo contains data that will be passed to the callback
' method.
Public Class TaskInfo
public Handle As RegisteredWaitHandle = Nothing
public OtherInfo As String = "default"
End Class
Public Class Example
<MTAThread> _
Public Shared Sub Main()
' The main thread uses AutoResetEvent to signal the
' registered wait handle, which executes the callback
' method.
Dim ev As New AutoResetEvent(false)
Dim ti As New TaskInfo()
ti.OtherInfo = "First task"
' The TaskInfo for the task includes the registered wait
' handle returned by RegisterWaitForSingleObject. This
' allows the wait to be terminated when the object has
' been signaled once (see WaitProc).
ti.Handle = ThreadPool.RegisterWaitForSingleObject( _
ev, _
New WaitOrTimerCallback(AddressOf WaitProc), _
ti, _
1000, _
false _
)
' The main thread waits about three seconds, to demonstrate
' the time-outs on the queued task, and then signals.
Thread.Sleep(3100)
Console.WriteLine("Main thread signals.")
ev.Set()
' The main thread sleeps, which should give the callback
' method time to execute. If you comment out this line, the
' program usually ends before the ThreadPool thread can execute.
Thread.Sleep(1000)
' If you start a thread yourself, you can wait for it to end
' by calling Thread.Join. This option is not available with
' thread pool threads.
End Sub
' The callback method executes when the registered wait times out,
' or when the WaitHandle (in this case AutoResetEvent) is signaled.
' WaitProc unregisters the WaitHandle the first time the event is
' signaled.
Public Shared Sub WaitProc(state As Object, timedOut As Boolean)
' The state object must be cast to the correct type, because the
' signature of the WaitOrTimerCallback delegate specifies type
' Object.
Dim ti As TaskInfo = CType(state, TaskInfo)
Dim cause As String = "TIMED OUT"
If Not timedOut Then
cause = "SIGNALED"
' If the callback method executes because the WaitHandle is
' signaled, stop future execution of the callback method
' by unregistering the WaitHandle.
If Not ti.Handle Is Nothing Then
ti.Handle.Unregister(Nothing)
End If
End If
Console.WriteLine("WaitProc( {0} ) executes on thread {1}; cause = {2}.", _
ti.OtherInfo, _
Thread.CurrentThread.GetHashCode().ToString(), _
cause _
)
End Sub
End Class
Poznámky
Po dokončení použití , RegisteredWaitHandle který je vrácena touto metodou, voláním jeho RegisteredWaitHandle.Unregister metody uvolněte odkazy na popisovač čekání. Doporučujeme vždy volat metodu RegisteredWaitHandle.Unregister , a to i v případě, že zadáte true
pro executeOnlyOnce
. Uvolňování paměti funguje efektivněji, pokud voláte metodu RegisteredWaitHandle.Unregister místo závislosti na finalizační metodě registrovaného popisovače čekání.
Metoda RegisterWaitForSingleObject za frontu určeného delegáta do fondu vláken. Pracovní vlákno spustí delegáta, pokud dojde k jedné z následujících:
- Zadaný objekt je v signalovaném stavu.
- Interval časového limitu uplyne.
Metoda RegisterWaitForSingleObject zkontroluje aktuální stav zadaného objektu WaitHandle. Pokud je stav objektu bez znaménka, metoda zaregistruje operaci čekání. Operaci čekání provádí vlákno z fondu vláken. Delegát je spuštěn pracovním vláknem, když se signalizuje stav objektu nebo uplyne interval časového limitu.
timeOutInterval
Pokud parametr není 0 (nula) a executeOnlyOnce
parametr je false
, časovač se resetuje při každém signálu události nebo uplynutí intervalu časového limitu.
Důležité
Mutex Použití pro waitObject
neposkytuje vzájemné vyloučení pro zpětná volání, protože základní rozhraní API systému Windows používá výchozí WT_EXECUTEDEFAULT
příznak, takže každé zpětné volání se odešle na samostatné vlákno fondu vláken. Místo použijte MutexSemaphore hodnotu s maximálním počtem 1.
Pokud chcete operaci čekání zrušit, zavolejte metodu RegisteredWaitHandle.Unregister .
Vlákno čekání používá funkci Win32 WaitForMultipleObjects
k monitorování registrovaných operací čekání. Proto pokud musíte použít stejný nativní popisovač operačního systému ve více voláních , RegisterWaitForSingleObjectmusíte duplikovat popisovač pomocí funkce Win32 DuplicateHandle
. Mějte na paměti, že byste neměli pulovat objekt události předaný do RegisterWaitForSingleObjectobjektu , protože vlákno čekání nemusí rozpoznat, že událost je signalizovala před jejím resetováním.
Před vrácením funkce upraví stav některých typů synchronizačních objektů. Ke změně dojde pouze u objektu, jehož stav signálu způsobil splnění podmínky čekání. Například počet semaforu se sníží o jednu.
Viz také
Platí pro
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, TimeSpan, Boolean)
- Zdroj:
- ThreadPoolWorkQueue.cs
- Zdroj:
- ThreadPoolWorkQueue.cs
- Zdroj:
- ThreadPoolWorkQueue.cs
Zaregistruje delegáta, který bude čekat na WaitHandlea zadá TimeSpan hodnotu časového limitu.
public:
static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, TimeSpan timeout, bool executeOnlyOnce);
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, TimeSpan timeout, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, TimeSpan timeout, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, TimeSpan timeout, bool executeOnlyOnce);
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * TimeSpan * bool -> System.Threading.RegisteredWaitHandle
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * TimeSpan * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, timeout As TimeSpan, executeOnlyOnce As Boolean) As RegisteredWaitHandle
Parametry
- waitObject
- WaitHandle
K WaitHandle registraci. Použijte jiný než WaitHandleMutex.
- callBack
- WaitOrTimerCallback
Delegát, WaitOrTimerCallback který se má volat při signálu parametru waitObject
.
- state
- Object
Objekt předaný delegátu.
- timeout
- TimeSpan
Časový limit reprezentovaný TimeSpanhodnotou . Pokud timeout
je 0 (nula), funkce otestuje stav objektu a okamžitě vrátí hodnotu. Pokud timeout
je hodnota -1, časový limit funkce nikdy neuplyne.
- executeOnlyOnce
- Boolean
true
k označení, že vlákno již nebude čekat na waitObject
parametr po zavolání delegáta; false
k označení, že časovač se resetuje při každém dokončení operace čekání, dokud se neregistruje čekání.
Návraty
, RegisteredWaitHandle který zapouzdřuje nativní popisovač.
- Atributy
Výjimky
Parametr timeout
je menší než -1.
Parametr timeout
je větší než Int32.MaxValue.
Poznámky
Po dokončení použití , RegisteredWaitHandle který je vrácena touto metodou, voláním jeho RegisteredWaitHandle.Unregister metody uvolněte odkazy na popisovač čekání. Doporučujeme vždy volat metodu RegisteredWaitHandle.Unregister , a to i v případě, že zadáte true
pro executeOnlyOnce
. Uvolňování paměti funguje efektivněji, pokud voláte metodu RegisteredWaitHandle.Unregister místo závislosti na finalizační metodě registrovaného popisovače čekání.
Metoda RegisterWaitForSingleObject za frontu určeného delegáta do fondu vláken. Pracovní vlákno spustí delegáta, pokud dojde k jedné z následujících:
- Zadaný objekt je v signalovaném stavu.
- Interval časového limitu uplyne.
Metoda RegisterWaitForSingleObject zkontroluje aktuální stav zadaného objektu WaitHandle. Pokud je stav objektu bez znaménka, metoda zaregistruje operaci čekání. Operaci čekání provádí vlákno z fondu vláken. Delegát je spuštěn pracovním vláknem, když se signalizuje stav objektu nebo uplyne interval časového limitu.
timeOutInterval
Pokud parametr není 0 (nula) a executeOnlyOnce
parametr je false
, časovač se resetuje při každém signálu události nebo uplynutí intervalu časového limitu.
Důležité
Mutex Použití pro waitObject
neposkytuje vzájemné vyloučení pro zpětná volání, protože základní rozhraní API systému Windows používá výchozí WT_EXECUTEDEFAULT
příznak, takže každé zpětné volání se odešle na samostatné vlákno fondu vláken. Místo použijte MutexSemaphore hodnotu s maximálním počtem 1.
Pokud chcete operaci čekání zrušit, zavolejte metodu RegisteredWaitHandle.Unregister .
Vlákno čekání používá funkci Win32 WaitForMultipleObjects
k monitorování registrovaných operací čekání. Proto pokud musíte použít stejný nativní popisovač operačního systému ve více voláních , RegisterWaitForSingleObjectmusíte duplikovat popisovač pomocí funkce Win32 DuplicateHandle
. Mějte na paměti, že byste neměli pulovat objekt události předaný do RegisterWaitForSingleObjectobjektu , protože vlákno čekání nemusí rozpoznat, že událost je signalizovala před jejím resetováním.
Před vrácením funkce upraví stav některých typů synchronizačních objektů. Ke změně dojde pouze u objektu, jehož stav signálu způsobil splnění podmínky čekání. Například počet semaforu se sníží o jednu.
Viz také
Platí pro
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int32, Boolean)
- Zdroj:
- ThreadPoolWorkQueue.cs
- Zdroj:
- ThreadPoolWorkQueue.cs
- Zdroj:
- ThreadPoolWorkQueue.cs
Zaregistruje delegáta, který bude čekat WaitHandlena , a zadá celé číslo se 32bitovým signedm pro vypršení časového limitu v milisekundách.
public:
static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int * bool -> System.Threading.RegisteredWaitHandle
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As Integer, executeOnlyOnce As Boolean) As RegisteredWaitHandle
Parametry
- waitObject
- WaitHandle
K WaitHandle registraci. Použijte jiný než WaitHandleMutex.
- callBack
- WaitOrTimerCallback
Delegát, WaitOrTimerCallback který se má volat při signálu parametru waitObject
.
- state
- Object
Objekt, který je předán delegátu.
- millisecondsTimeOutInterval
- Int32
Časový limit v milisekundách
millisecondsTimeOutInterval
Pokud je parametr 0 (nula), funkce otestuje stav objektu a vrátí okamžitě. Pokud millisecondsTimeOutInterval
je hodnota -1, interval časového limitu funkce nikdy neuplyne.
- executeOnlyOnce
- Boolean
true
to znamená, že vlákno už nebude čekat na waitObject
parametr po zavolání delegáta. false
Označuje, že se časovač resetuje při každém dokončení operace čekání, dokud se neregistruje čekání.
Návraty
Ten RegisteredWaitHandle zapouzdřuje nativní popisovač.
- Atributy
Výjimky
Parametr millisecondsTimeOutInterval
je menší než -1.
Poznámky
Po dokončení použití RegisteredWaitHandle , která je vrácena touto metodou, voláním jeho RegisteredWaitHandle.Unregister metody uvolněte odkazy na popisovač čekání. Doporučujeme vždy volat metodu RegisteredWaitHandle.Unregister , a to i v případě, že zadáte true
pro executeOnlyOnce
. Uvolňování paměti funguje efektivněji, pokud voláte metodu RegisteredWaitHandle.Unregister místo závislosti na finalizátoru registrovaného popisovače čekání.
Metoda RegisterWaitForSingleObject zasadí zadaného delegáta do fondu vláken. Pracovní vlákno spustí delegáta, pokud nastane jedna z následujících:
- Zadaný objekt je v signalizačním stavu.
- Interval časového limitu uplynul.
Metoda RegisterWaitForSingleObject kontroluje aktuální stav zadaného objektu WaitHandle. Pokud je stav objektu nepodepsaný, metoda zaregistruje operaci čekání. Operaci čekání provádí vlákno z fondu vláken. Delegát je spuštěn pracovním vláknem, když se signalizuje stav objektu nebo vyprší interval časového limitu.
timeOutInterval
Pokud parametr není 0 (nula) a executeOnlyOnce
parametr je false
, časovač se resetuje při každém signálu události nebo uplynutí intervalu časového limitu.
Důležité
Mutex Použití for waitObject
neposkytuje vzájemné vyloučení pro zpětná volání, protože základní rozhraní API systému Windows používá výchozí WT_EXECUTEDEFAULT
příznak, takže každé zpětné volání je odesláno na samostatné vlákno fondu vláken. Místo použijte MutexSemaphore hodnotu s maximálním počtem 1.
Pokud chcete operaci čekání zrušit, zavolejte metodu RegisteredWaitHandle.Unregister .
Vlákno čekání používá funkci Win32 WaitForMultipleObjects
k monitorování registrovaných operací čekání. Proto pokud musíte použít stejný nativní popisovač operačního systému ve více voláních RegisterWaitForSingleObject, musíte duplikovat popisovač pomocí funkce Win32 DuplicateHandle
. Všimněte si, že byste neměli pulovat objekt události předaný do RegisterWaitForSingleObject, protože vlákno čekání nemusí zjistit, že událost je signalizovala před resetováním.
Před vrácením funkce upraví stav některých typů synchronizačních objektů. K úpravě dochází pouze u objektu, jehož stav signálu způsobil splnění podmínky čekání. Například počet semaforu se sníží o jednu.
Viz také
Platí pro
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int64, Boolean)
- Zdroj:
- ThreadPoolWorkQueue.cs
- Zdroj:
- ThreadPoolWorkQueue.cs
- Zdroj:
- ThreadPoolWorkQueue.cs
Zaregistruje delegáta, který bude čekat WaitHandlena a zadá celé číslo se 64bitovým signedm pro vypršení časového limitu v milisekundách.
public:
static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object? state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int64 * bool -> System.Threading.RegisteredWaitHandle
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int64 * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As Long, executeOnlyOnce As Boolean) As RegisteredWaitHandle
Parametry
- waitObject
- WaitHandle
Chcete-li WaitHandle se zaregistrovat. Použijte jiný než WaitHandleMutex.
- callBack
- WaitOrTimerCallback
Delegát, WaitOrTimerCallback který se má volat při signálu parametru waitObject
.
- state
- Object
Objekt předaný delegátu.
- millisecondsTimeOutInterval
- Int64
Časový limit v milisekundách
millisecondsTimeOutInterval
Pokud je parametr 0 (nula), funkce otestuje stav objektu a vrátí okamžitě. Pokud millisecondsTimeOutInterval
je hodnota -1, interval časového limitu funkce nikdy neuplyne.
- executeOnlyOnce
- Boolean
true
to znamená, že vlákno už nebude čekat na waitObject
parametr po zavolání delegáta. false
Označuje, že se časovač resetuje při každém dokončení operace čekání, dokud se neregistruje čekání.
Návraty
Ten RegisteredWaitHandle zapouzdřuje nativní popisovač.
- Atributy
Výjimky
Parametr millisecondsTimeOutInterval
je menší než -1.
Poznámky
Po dokončení použití RegisteredWaitHandle , která je vrácena touto metodou, voláním jeho RegisteredWaitHandle.Unregister metody uvolněte odkazy na popisovač čekání. Doporučujeme vždy volat metodu RegisteredWaitHandle.Unregister , a to i v případě, že zadáte true
pro executeOnlyOnce
. Uvolňování paměti funguje efektivněji, pokud voláte metodu RegisteredWaitHandle.Unregister místo závislosti na finalizátoru registrovaného popisovače čekání.
Metoda RegisterWaitForSingleObject zasadí zadaného delegáta do fondu vláken. Pracovní vlákno spustí delegáta, pokud nastane jedna z následujících:
- Zadaný objekt je v signalizačním stavu.
- Interval časového limitu uplynul.
Metoda RegisterWaitForSingleObject kontroluje aktuální stav zadaného objektu WaitHandle. Pokud je stav objektu nepodepsaný, metoda zaregistruje operaci čekání. Operaci čekání provádí vlákno z fondu vláken. Delegát je spuštěn pracovním vláknem, když se signalizuje stav objektu nebo vyprší interval časového limitu.
timeOutInterval
Pokud parametr není 0 (nula) a executeOnlyOnce
parametr je false
, časovač se resetuje při každém signálu události nebo uplynutí intervalu časového limitu.
Důležité
Mutex Použití for waitObject
neposkytuje vzájemné vyloučení pro zpětná volání, protože základní rozhraní API systému Windows používá výchozí WT_EXECUTEDEFAULT
příznak, takže každé zpětné volání je odesláno na samostatné vlákno fondu vláken. Místo použijte MutexSemaphore hodnotu s maximálním počtem 1.
Pokud chcete operaci čekání zrušit, zavolejte metodu RegisteredWaitHandle.Unregister .
Vlákno čekání používá funkci Win32 WaitForMultipleObjects
k monitorování registrovaných operací čekání. Proto pokud musíte použít stejný nativní popisovač operačního systému ve více voláních RegisterWaitForSingleObject, musíte duplikovat popisovač pomocí funkce Win32 DuplicateHandle
. Všimněte si, že byste neměli pulovat objekt události předaný do RegisterWaitForSingleObject, protože vlákno čekání nemusí zjistit, že událost je signalizovala před resetováním.
Před vrácením funkce upraví stav některých typů synchronizačních objektů. K úpravě dochází pouze u objektu, jehož stav signálu způsobil splnění podmínky čekání. Například počet semaforu se sníží o jednu.