ThreadPool.RegisterWaitForSingleObject Metoda

Definice

Obor názvů:: System.Threading

Sestavení:: netstandard.dll, System.Threading.ThreadPool.dll

Sestavení:: System.Threading.ThreadPool.dll

Sestavení:: mscorlib.dll

Sestavení:: netstandard.dll

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í

Name	Description
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, UInt32, Boolean)	Zaregistruje delegáta, který bude čekat na WaitHandle32bitové celé číslo bez znaménka pro časový limit v milisekundách.
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, TimeSpan, Boolean)	Zaregistruje delegáta, který bude čekat na WaitHandle TimeSpan hodnotu časového limitu.
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int32, Boolean)	Zaregistruje delegáta, který bude čekat na WaitHandle32bitové celé číslo se znaménkem pro vypršení časového limitu v milisekundách.
RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int64, Boolean)	Zaregistruje delegáta, který bude čekat na WaitHandle64bitové celé číslo se znaménkem pro vypršení časového limitu v milisekundách.

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, UInt32, Boolean)

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Důležité

Toto rozhraní API neodpovídá specifikaci CLS.

Zaregistruje delegáta, který bude čekat na WaitHandle32bitové 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

Registrace WaitHandle . Použijte jiné než WaitHandle Mutex.

callBack: WaitOrTimerCallback

Delegát WaitOrTimerCallback , který má volat, když waitObject je parametr signalován.

state: Object

Objekt předaný delegátu.

millisecondsTimeOutInterval: UInt32

Časový limit vyprší v milisekundách. millisecondsTimeOutInterval Pokud je parametr 0 (nula), funkce testuje stav objektu a vrátí okamžitě. Pokud millisecondsTimeOutInterval je hodnota -1, časový limit funkce nikdy neuplyne.

executeOnlyOnce: Boolean

true chcete-li označit, že vlákno již nebude čekat na waitObject parametr po zavolání delegáta; false aby indikoval, že časovač je resetován při každém dokončení operace čekání, dokud se čekání neregistruje.

Návraty

RegisteredWaitHandle

Tuto RegisteredWaitHandle operaci lze použít ke zrušení registrované operace čekání.

Atributy: CLSCompliantAttribute UnsupportedOSPlatformAttribute

Výjimky

ArgumentOutOfRangeException

Parametr millisecondsTimeOutInterval je menší než -1.

Příklady

Následující příklad ukazuje, jak pomocí RegisterWaitForSingleObject metody provést zadanou metodu zpětného volání, když je zadaná obslužná rutina čekání signalována. V tomto příkladu je WaitProcmetoda zpětného volání a obslužná rutina čekání je .AutoResetEvent

Příklad definuje TaskInfo třídu pro uložení informací, které se předávají zpětnému volání při jeho spuštění. Příklad vytvoří TaskInfo objekt a přiřadí mu nějaká řetězcová data. Vrácená RegisteredWaitHandle metodou RegisterWaitForSingleObject je přiřazena k Handle poli objektu TaskInfo tak, aby zpětné volání metoda má přístup k RegisteredWaitHandle.

Kromě určení TaskInfo jako objekt pro předání metody zpětného volání volání určuje RegisterWaitForSingleObject volání AutoResetEvent metody, na kterou bude úkol čekat, WaitOrTimerCallback delegát, který představuje metodu zpětného WaitProc volání, jeden druhý časový limit a více zpětných volání.

Když hlavní vlákno signalizuje AutoResetEvent voláním své Set metody, WaitOrTimerCallback delegát je vyvolán. Metoda WaitProc testuje RegisteredWaitHandle , zda došlo k vypršení časového limitu. Pokud bylo vyvoláno zpětné volání, protože obslužná rutina čekání byla signalována, WaitProc metoda zruší registraci RegisteredWaitHandle, zastavení dalších zpětných volání. V případě vypršení časového limitu úkol pokračuje v čekání. Metoda WaitProc končí tiskem zprávy do konzoly.

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

Jakmile budete hotovi pomocí metody RegisteredWaitHandle , která je vrácena touto metodou, zavolejte její RegisteredWaitHandle.Unregister metodu uvolnění odkazů na popisovač čekání. Doporučujeme vždy volat metodu RegisteredWaitHandle.Unregister , i když zadáte true pro executeOnlyOnce. Uvolňování paměti funguje efektivněji, pokud voláte metodu RegisteredWaitHandle.Unregister místo v závislosti na finalizátoru registrovaného obslužného rutiny čekání.

Metoda RegisterWaitForSingleObject zařadí zadaný delegát do fondu vláken. Pracovní vlákno spustí delegáta v případě, že dojde k některé z následujících situací:

Zadaný objekt je v signalovaném stavu.
Časový limit vyprší.

Metoda RegisterWaitForSingleObject zkontroluje aktuální stav zadaného objektu WaitHandle. Pokud je stav objektu nepodepsaný, metoda zaregistruje operaci čekání. Operace čekání provádí vlákno z fondu vláken. Delegát se spustí pracovním vláknem, když se stav objektu signalizuje nebo vyprší časový limit. timeOutInterval Pokud parametr není 0 (nula) a executeOnlyOnce parametr je false, časovač se resetuje při každém signálu události nebo vypršení časového limitu.

Important

Použití Mutex pro waitObject neposkytuje vzájemné vyloučení pro zpětná volání, protože základní rozhraní API Windows používá výchozí příznak WT_EXECUTEDEFAULT, takže každý zpětné volání je odeslán na samostatné vlákno fondu vláken. Místo , Mutexpoužijte s Semaphore 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í operační systém popisovač ve více voláních RegisterWaitForSingleObject, musíte duplikovat popisovač pomocí funkce Win32 DuplicateHandle . Všimněte si, že byste neměli pulzní objekt události předaný RegisterWaitForSingleObject, protože čekací vlákno nemusí zjistit, že událost je signalována 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 jeden.

Viz také

Fond spravovaných vláken

Platí pro

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, TimeSpan, Boolean)

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zaregistruje delegáta, který bude čekat na WaitHandle 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

Registrace WaitHandle . Použijte jiné než WaitHandle Mutex.

callBack: WaitOrTimerCallback

Delegát WaitOrTimerCallback , který má volat, když waitObject je parametr signalován.

state: Object

Objekt předaný delegátu.

timeout: TimeSpan

Časový limit reprezentovaný hodnotou TimeSpan. Pokud timeout je 0 (nula), funkce testuje stav objektu a vrátí okamžitě. Pokud timeout je hodnota -1, časový limit funkce nikdy neuplyne.

executeOnlyOnce: Boolean

Návraty

RegisteredWaitHandle

Ten RegisteredWaitHandle zapouzdřuje nativní popisovač.

Atributy: UnsupportedOSPlatformAttribute

Výjimky

ArgumentOutOfRangeException

Parametr timeout je menší než -1.

NotSupportedException

Parametr timeout je větší než Int32.MaxValue.

Poznámky

Metoda RegisterWaitForSingleObject zařadí zadaný delegát do fondu vláken. Pracovní vlákno spustí delegáta v případě, že dojde k některé z následujících situací:

Zadaný objekt je v signalovaném stavu.
Časový limit vyprší.

Important

Pokud chcete operaci čekání zrušit, zavolejte metodu RegisteredWaitHandle.Unregister .

Viz také

Fond spravovaných vláken

Platí pro

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int32, Boolean)

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zaregistruje delegáta, který bude čekat na WaitHandle32bitové celé číslo se znaménkem 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

Registrace WaitHandle . Použijte jiné než WaitHandle Mutex.

callBack: WaitOrTimerCallback

Delegát WaitOrTimerCallback , který má volat, když waitObject je parametr signalován.

state: Object

Objekt, který je předán delegátu.

millisecondsTimeOutInterval: Int32

executeOnlyOnce: Boolean

Návraty

RegisteredWaitHandle

Ten RegisteredWaitHandle zapouzdřuje nativní popisovač.

Atributy: UnsupportedOSPlatformAttribute

Výjimky

ArgumentOutOfRangeException

Parametr millisecondsTimeOutInterval je menší než -1.

Poznámky

Metoda RegisterWaitForSingleObject zařadí zadaný delegát do fondu vláken. Pracovní vlákno spustí delegáta v případě, že dojde k některé z následujících situací:

Zadaný objekt je v signalovaném stavu.
Časový limit vyprší.

Important

Pokud chcete operaci čekání zrušit, zavolejte metodu RegisteredWaitHandle.Unregister .

Viz také

Fond spravovaných vláken

Platí pro

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int64, Boolean)

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zdroj:: ThreadPoolWorkQueue.cs

Zaregistruje delegáta, který bude čekat na WaitHandle64bitové celé číslo se znaménkem 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

Registrace WaitHandle . Použijte jiné než WaitHandle Mutex.

callBack: WaitOrTimerCallback

Delegát WaitOrTimerCallback , který má volat, když waitObject je parametr signalován.

state: Object

Objekt předaný delegátu.

millisecondsTimeOutInterval: Int64

executeOnlyOnce: Boolean

Návraty

RegisteredWaitHandle

Ten RegisteredWaitHandle zapouzdřuje nativní popisovač.

Atributy: UnsupportedOSPlatformAttribute

Výjimky

ArgumentOutOfRangeException

Parametr millisecondsTimeOutInterval je menší než -1.

Poznámky

Metoda RegisterWaitForSingleObject zařadí zadaný delegát do fondu vláken. Pracovní vlákno spustí delegáta v případě, že dojde k některé z následujících situací:

Zadaný objekt je v signalovaném stavu.
Časový limit vyprší.

Important

Pokud chcete operaci čekání zrušit, zavolejte metodu RegisteredWaitHandle.Unregister .

Viz také

Fond spravovaných vláken

Platí pro

Váš názor

Byla tato stránka užitečná?