ThreadPool.RegisterWaitForSingleObject Método

Definición

Registra un delegado que está esperando a una clase WaitHandle.Registers a delegate that is waiting for a WaitHandle.

Sobrecargas

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

Registra un delegado para que espere a la clase WaitHandle y especifica un entero de 32 bits sin signo como tiempo de espera, en milisegundos.Registers a delegate to wait for a WaitHandle, specifying a 32-bit unsigned integer for the time-out in milliseconds.

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

Registra un delegado para que espere a la clase WaitHandle y especifica un valor TimeSpan como tiempo de espera.Registers a delegate to wait for a WaitHandle, specifying a TimeSpan value for the time-out.

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

Registra un delegado para que espere a la clase WaitHandle y especifica un entero de 32 bits con signo como tiempo de espera, en milisegundos.Registers a delegate to wait for a WaitHandle, specifying a 32-bit signed integer for the time-out in milliseconds.

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

Registra un delegado para que espere a la clase WaitHandle y especifica un entero de 64 bits con signo como tiempo de espera, en milisegundos.Registers a delegate to wait for a WaitHandle, specifying a 64-bit signed integer for the time-out in milliseconds.

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

Importante

Esta API no es conforme a CLS.

Registra un delegado para que espere a la clase WaitHandle y especifica un entero de 32 bits sin signo como tiempo de espera, en milisegundos.Registers a delegate to wait for a WaitHandle, specifying a 32-bit unsigned integer for the time-out in milliseconds.

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

Parámetros

waitObject
WaitHandle

La clase WaitHandle que se va a registrar.The WaitHandle to register. Use un WaitHandle diferente de Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Delegado de WaitOrTimerCallback al que se llamará cuando el parámetro waitObject esté marcado.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Objeto que se ha pasado al delegado.The object passed to the delegate.

millisecondsTimeOutInterval
UInt32

Tiempo de espera en milisegundos.The time-out in milliseconds. Si el valor del parámetro millisecondsTimeOutInterval es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Si millisecondsTimeOutInterval es -1, el intervalo de tiempo de espera de la función nunca transcurre.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Es true para indicar que el subproceso no esperará en el parámetro waitObject después de haber llamado al delegado; es false para indicar que el temporizador se restablecerá cada vez que se complete la operación de espera, hasta que se anule el registro de la espera.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Devoluciones

RegisteredWaitHandle

RegisteredWaitHandle que puede usarse para cancelar la operación de espera registrada.The RegisteredWaitHandle that can be used to cancel the registered wait operation.

Atributos

Excepciones

El parámetro millisecondsTimeOutInterval es menor que -1.The millisecondsTimeOutInterval parameter is less than -1.

Ejemplos

En el ejemplo siguiente se muestra cómo utilizar el RegisterWaitForSingleObject método para ejecutar un método de devolución de llamada especificado cuando se señala un identificador de espera especificado.The following example shows how to use the RegisterWaitForSingleObject method to execute a specified callback method when a specified wait handle is signaled. En este ejemplo, el método de devolución de llamada es WaitProc y el identificador de espera es AutoResetEvent .In this example, the callback method is WaitProc, and the wait handle is an AutoResetEvent.

En el ejemplo se define una TaskInfo clase que contiene la información que se pasa a la devolución de llamada cuando se ejecuta.The example defines a TaskInfo class to hold the information that is passed to the callback when it executes. En el ejemplo se crea un TaskInfo objeto y se le asignan algunos datos de cadena.The example creates a TaskInfo object and assigns it some string data. El RegisteredWaitHandle devuelto por el RegisterWaitForSingleObject método se asigna al Handle campo del TaskInfo objeto para que el método de devolución de llamada tenga acceso a RegisteredWaitHandle .The RegisteredWaitHandle that is returned by the RegisterWaitForSingleObject method is assigned to the Handle field of the TaskInfo object so that the callback method has access to the RegisteredWaitHandle.

Además de especificar TaskInfo como el objeto que se va a pasar al método de devolución de llamada, la llamada al RegisterWaitForSingleObject método especifica el AutoResetEvent que la tarea esperará, un WaitOrTimerCallback delegado que representa el WaitProc método de devolución de llamada, un intervalo de tiempo de espera de un segundo y varias devoluciones de llamada.In addition to specifying TaskInfo as the object to pass to the callback method, the call to the RegisterWaitForSingleObject method specifies the AutoResetEvent that the task will wait for, a WaitOrTimerCallback delegate that represents the WaitProc callback method, a one second time-out interval, and multiple callbacks.

Cuando el subproceso principal señala a AutoResetEvent llamando a su Set método, WaitOrTimerCallback se invoca al delegado.When the main thread signals the AutoResetEvent by calling its Set method, the WaitOrTimerCallback delegate is invoked. El WaitProc método prueba RegisteredWaitHandle para determinar si se ha producido un tiempo de espera.The WaitProc method tests RegisteredWaitHandle to determine whether a time-out occurred. Si se invocó la devolución de llamada porque se señaló el identificador de espera, el WaitProc método anula el registro de RegisteredWaitHandle y detiene las devoluciones de llamada adicionales.If the callback was invoked because the wait handle was signaled, the WaitProc method unregisters the RegisteredWaitHandle, stopping additional callbacks. En el caso de un tiempo de espera, la tarea continúa esperando.In the case of a time-out, the task continues to wait. El WaitProc método finaliza mediante la impresión de un mensaje en la consola.The WaitProc method ends by printing a message to the console.

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

Comentarios

Cuando haya terminado de usar el RegisteredWaitHandle devuelto por este método, llame a su RegisteredWaitHandle.Unregister método para liberar las referencias al identificador de espera.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Se recomienda llamar siempre al RegisteredWaitHandle.Unregister método, incluso si se especifica true para executeOnlyOnce .We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. La recolección de elementos no utilizados funciona más eficazmente si se llama al RegisteredWaitHandle.Unregister método en lugar de depender del finalizador del identificador de espera registrado.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

El RegisterWaitForSingleObject método pone en cola el delegado especificado en el grupo de subprocesos.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un subproceso de trabajo ejecutará el delegado cuando se produzca uno de los siguientes casos:A worker thread will execute the delegate when one of the following occurs:

  • El objeto especificado se encuentra en el estado señalado.The specified object is in the signaled state.

  • Transcurre el intervalo de tiempo de espera.The time-out interval elapses.

El RegisterWaitForSingleObject método comprueba el estado actual del objeto especificado WaitHandle .The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Si el estado del objeto es sin señalizar, el método registra una operación de espera.If the object's state is unsignaled, the method registers a wait operation. Un subproceso realiza la operación de espera desde el grupo de subprocesos.The wait operation is performed by a thread from the thread pool. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto pasa a ser señalado o hasta que transcurre el intervalo de tiempo de espera.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Si el timeOutInterval parámetro no es 0 (cero) y el executeOnlyOnce parámetro es false , el temporizador se restablece cada vez que se señala el evento o hasta que transcurre el intervalo de tiempo de espera.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Importante

El uso Mutex de para no waitObject proporciona exclusión mutua para las devoluciones de llamada porque la API de Windows subyacente utiliza la WT_EXECUTEDEFAULT marca predeterminada, por lo que cada devolución de llamada se envía en un subproceso de grupo de subprocesos independiente.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. En lugar de Mutex , utilice un Semaphore con un recuento máximo de 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Para cancelar la operación de espera, llame al RegisteredWaitHandle.Unregister método.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

El subproceso de espera utiliza la función de Win32 WaitForMultipleObjects para supervisar las operaciones de espera registradas.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Por lo tanto, si debe usar el mismo identificador del sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject , debe duplicar el identificador mediante la función de Win32 DuplicateHandle .Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Tenga en cuenta que no debe pulsar un objeto de evento pasado a RegisterWaitForSingleObject , porque el subproceso de espera podría no detectar que el evento está señalado antes de que se restablezca.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Antes de devolver, la función modifica el estado de algunos tipos de objetos de sincronización.Before returning, the function modifies the state of some types of synchronization objects. La modificación solo se produce para el objeto cuyo estado señalado provocó que se cumpliera la condición de espera.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Por ejemplo, el recuento de un semáforo se reduce en uno.For example, the count of a semaphore is decreased by one.

Información de versiónVersion Information

A partir de la versión 2,0 de .NET Framework, el valor de la Thread.CurrentPrincipal propiedad se propaga a los subprocesos de trabajo en cola mediante el RegisterWaitForSingleObject método.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. En versiones anteriores, la información de la entidad de seguridad no se propaga.In earlier versions, the principal information is not propagated.

Se aplica a

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

Registra un delegado para que espere a la clase WaitHandle y especifica un valor TimeSpan como tiempo de espera.Registers a delegate to wait for a WaitHandle, specifying a TimeSpan value for the time-out.

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

Parámetros

waitObject
WaitHandle

La clase WaitHandle que se va a registrar.The WaitHandle to register. Use un WaitHandle diferente de Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Delegado de WaitOrTimerCallback al que se llamará cuando el parámetro waitObject esté marcado.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Objeto que se ha pasado al delegado.The object passed to the delegate.

timeout
TimeSpan

Tiempo de espera representado por TimeSpan.The time-out represented by a TimeSpan. Si timeout es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. If timeout is 0 (zero), the function tests the object's state and returns immediately. Si timeout es -1, el intervalo de tiempo de espera de la función nunca transcurre.If timeout is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Es true para indicar que el subproceso no esperará en el parámetro waitObject después de haber llamado al delegado; es false para indicar que el temporizador se restablecerá cada vez que se complete la operación de espera, hasta que se anule el registro de la espera.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Devoluciones

RegisteredWaitHandle

RegisteredWaitHandle que encapsula el identificador nativo.The RegisteredWaitHandle that encapsulates the native handle.

Atributos

Excepciones

El parámetro timeout es menor que -1.The timeout parameter is less than -1.

El valor del parámetro timeout es mayor que el valor de la propiedad MaxValue.The timeout parameter is greater than MaxValue.

Comentarios

Cuando haya terminado de usar el RegisteredWaitHandle devuelto por este método, llame a su RegisteredWaitHandle.Unregister método para liberar las referencias al identificador de espera.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Se recomienda llamar siempre al RegisteredWaitHandle.Unregister método, incluso si se especifica true para executeOnlyOnce .We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. La recolección de elementos no utilizados funciona más eficazmente si se llama al RegisteredWaitHandle.Unregister método en lugar de depender del finalizador del identificador de espera registrado.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

El RegisterWaitForSingleObject método pone en cola el delegado especificado en el grupo de subprocesos.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un subproceso de trabajo ejecutará el delegado cuando se produzca uno de los siguientes casos:A worker thread will execute the delegate when one of the following occurs:

  • El objeto especificado se encuentra en el estado señalado.The specified object is in the signaled state.

  • Transcurre el intervalo de tiempo de espera.The time-out interval elapses.

El RegisterWaitForSingleObject método comprueba el estado actual del objeto especificado WaitHandle .The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Si el estado del objeto es sin señalizar, el método registra una operación de espera.If the object's state is unsignaled, the method registers a wait operation. Un subproceso realiza la operación de espera desde el grupo de subprocesos.The wait operation is performed by a thread from the thread pool. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto pasa a ser señalado o hasta que transcurre el intervalo de tiempo de espera.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Si el timeOutInterval parámetro no es 0 (cero) y el executeOnlyOnce parámetro es false , el temporizador se restablece cada vez que se señala el evento o hasta que transcurre el intervalo de tiempo de espera.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Importante

El uso Mutex de para no waitObject proporciona exclusión mutua para las devoluciones de llamada porque la API de Windows subyacente utiliza la WT_EXECUTEDEFAULT marca predeterminada, por lo que cada devolución de llamada se envía en un subproceso de grupo de subprocesos independiente.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. En lugar de Mutex , utilice un Semaphore con un recuento máximo de 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Para cancelar la operación de espera, llame al RegisteredWaitHandle.Unregister método.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

El subproceso de espera utiliza la función de Win32 WaitForMultipleObjects para supervisar las operaciones de espera registradas.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Por lo tanto, si debe usar el mismo identificador del sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject , debe duplicar el identificador mediante la función de Win32 DuplicateHandle .Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Tenga en cuenta que no debe pulsar un objeto de evento pasado a RegisterWaitForSingleObject , porque el subproceso de espera podría no detectar que el evento está señalado antes de que se restablezca.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Antes de devolver, la función modifica el estado de algunos tipos de objetos de sincronización.Before returning, the function modifies the state of some types of synchronization objects. La modificación solo se produce para el objeto cuyo estado señalado provocó que se cumpliera la condición de espera.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Por ejemplo, el recuento de un semáforo se reduce en uno.For example, the count of a semaphore is decreased by one.

Información de versiónVersion Information

A partir de la versión 2,0 de .NET Framework, el valor de la Thread.CurrentPrincipal propiedad se propaga a los subprocesos de trabajo en cola mediante el RegisterWaitForSingleObject método.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. En versiones anteriores, la información de la entidad de seguridad no se propaga.In earlier versions, the principal information is not propagated.

Se aplica a

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

Registra un delegado para que espere a la clase WaitHandle y especifica un entero de 32 bits con signo como tiempo de espera, en milisegundos.Registers a delegate to wait for a WaitHandle, specifying a 32-bit signed integer for the time-out in milliseconds.

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

Parámetros

waitObject
WaitHandle

La clase WaitHandle que se va a registrar.The WaitHandle to register. Use un WaitHandle diferente de Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Delegado de WaitOrTimerCallback al que se llamará cuando el parámetro waitObject esté marcado.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Objeto que se pasa al delegado.The object that is passed to the delegate.

millisecondsTimeOutInterval
Int32

Tiempo de espera en milisegundos.The time-out in milliseconds. Si el valor del parámetro millisecondsTimeOutInterval es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Si millisecondsTimeOutInterval es -1, el intervalo de tiempo de espera de la función nunca transcurre.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Es true para indicar que el subproceso no esperará en el parámetro waitObject después de haber llamado al delegado; es false para indicar que el temporizador se restablecerá cada vez que se complete la operación de espera, hasta que se anule el registro de la espera.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Devoluciones

RegisteredWaitHandle

RegisteredWaitHandle que encapsula el identificador nativo.The RegisteredWaitHandle that encapsulates the native handle.

Atributos

Excepciones

El parámetro millisecondsTimeOutInterval es menor que -1.The millisecondsTimeOutInterval parameter is less than -1.

Comentarios

Cuando haya terminado de usar el RegisteredWaitHandle devuelto por este método, llame a su RegisteredWaitHandle.Unregister método para liberar las referencias al identificador de espera.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Se recomienda llamar siempre al RegisteredWaitHandle.Unregister método, incluso si se especifica true para executeOnlyOnce .We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. La recolección de elementos no utilizados funciona más eficazmente si se llama al RegisteredWaitHandle.Unregister método en lugar de depender del finalizador del identificador de espera registrado.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

El RegisterWaitForSingleObject método pone en cola el delegado especificado en el grupo de subprocesos.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un subproceso de trabajo ejecutará el delegado cuando se produzca uno de los siguientes casos:A worker thread will execute the delegate when one of the following occurs:

  • El objeto especificado se encuentra en el estado señalado.The specified object is in the signaled state.

  • Transcurre el intervalo de tiempo de espera.The time-out interval elapses.

El RegisterWaitForSingleObject método comprueba el estado actual del objeto especificado WaitHandle .The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Si el estado del objeto es sin señalizar, el método registra una operación de espera.If the object's state is unsignaled, the method registers a wait operation. Un subproceso realiza la operación de espera desde el grupo de subprocesos.The wait operation is performed by a thread from the thread pool. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto pasa a ser señalado o hasta que transcurre el intervalo de tiempo de espera.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Si el timeOutInterval parámetro no es 0 (cero) y el executeOnlyOnce parámetro es false , el temporizador se restablece cada vez que se señala el evento o hasta que transcurre el intervalo de tiempo de espera.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Importante

El uso Mutex de para no waitObject proporciona exclusión mutua para las devoluciones de llamada porque la API de Windows subyacente utiliza la WT_EXECUTEDEFAULT marca predeterminada, por lo que cada devolución de llamada se envía en un subproceso de grupo de subprocesos independiente.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. En lugar de Mutex , utilice un Semaphore con un recuento máximo de 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Para cancelar la operación de espera, llame al RegisteredWaitHandle.Unregister método.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

El subproceso de espera utiliza la función de Win32 WaitForMultipleObjects para supervisar las operaciones de espera registradas.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Por lo tanto, si debe usar el mismo identificador del sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject , debe duplicar el identificador mediante la función de Win32 DuplicateHandle .Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Tenga en cuenta que no debe pulsar un objeto de evento pasado a RegisterWaitForSingleObject , porque el subproceso de espera podría no detectar que el evento está señalado antes de que se restablezca.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Antes de devolver, la función modifica el estado de algunos tipos de objetos de sincronización.Before returning, the function modifies the state of some types of synchronization objects. La modificación solo se produce para el objeto cuyo estado señalado provocó que se cumpliera la condición de espera.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Por ejemplo, el recuento de un semáforo se reduce en uno.For example, the count of a semaphore is decreased by one.

Información de versiónVersion Information

A partir de la versión 2,0 de .NET Framework, el valor de la Thread.CurrentPrincipal propiedad se propaga a los subprocesos de trabajo en cola mediante el RegisterWaitForSingleObject método.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. En versiones anteriores, la información de la entidad de seguridad no se propaga.In earlier versions, the principal information is not propagated.

Se aplica a

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

Registra un delegado para que espere a la clase WaitHandle y especifica un entero de 64 bits con signo como tiempo de espera, en milisegundos.Registers a delegate to wait for a WaitHandle, specifying a 64-bit signed integer for the time-out in milliseconds.

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

Parámetros

waitObject
WaitHandle

La clase WaitHandle que se va a registrar.The WaitHandle to register. Use un WaitHandle diferente de Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Delegado de WaitOrTimerCallback al que se llamará cuando el parámetro waitObject esté marcado.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Objeto que se ha pasado al delegado.The object passed to the delegate.

millisecondsTimeOutInterval
Int64

Tiempo de espera en milisegundos.The time-out in milliseconds. Si el valor del parámetro millisecondsTimeOutInterval es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Si millisecondsTimeOutInterval es -1, el intervalo de tiempo de espera de la función nunca transcurre.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Es true para indicar que el subproceso no esperará en el parámetro waitObject después de haber llamado al delegado; es false para indicar que el temporizador se restablecerá cada vez que se complete la operación de espera, hasta que se anule el registro de la espera.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Devoluciones

RegisteredWaitHandle

RegisteredWaitHandle que encapsula el identificador nativo.The RegisteredWaitHandle that encapsulates the native handle.

Atributos

Excepciones

El parámetro millisecondsTimeOutInterval es menor que -1.The millisecondsTimeOutInterval parameter is less than -1.

Comentarios

Cuando haya terminado de usar el RegisteredWaitHandle devuelto por este método, llame a su RegisteredWaitHandle.Unregister método para liberar las referencias al identificador de espera.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Se recomienda llamar siempre al RegisteredWaitHandle.Unregister método, incluso si se especifica true para executeOnlyOnce .We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. La recolección de elementos no utilizados funciona más eficazmente si se llama al RegisteredWaitHandle.Unregister método en lugar de depender del finalizador del identificador de espera registrado.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

El RegisterWaitForSingleObject método pone en cola el delegado especificado en el grupo de subprocesos.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un subproceso de trabajo ejecutará el delegado cuando se produzca uno de los siguientes casos:A worker thread will execute the delegate when one of the following occurs:

  • El objeto especificado se encuentra en el estado señalado.The specified object is in the signaled state.

  • Transcurre el intervalo de tiempo de espera.The time-out interval elapses.

El RegisterWaitForSingleObject método comprueba el estado actual del objeto especificado WaitHandle .The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Si el estado del objeto es sin señalizar, el método registra una operación de espera.If the object's state is unsignaled, the method registers a wait operation. Un subproceso realiza la operación de espera desde el grupo de subprocesos.The wait operation is performed by a thread from the thread pool. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto pasa a ser señalado o hasta que transcurre el intervalo de tiempo de espera.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Si el timeOutInterval parámetro no es 0 (cero) y el executeOnlyOnce parámetro es false , el temporizador se restablece cada vez que se señala el evento o hasta que transcurre el intervalo de tiempo de espera.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Importante

El uso Mutex de para no waitObject proporciona exclusión mutua para las devoluciones de llamada porque la API de Windows subyacente utiliza la WT_EXECUTEDEFAULT marca predeterminada, por lo que cada devolución de llamada se envía en un subproceso de grupo de subprocesos independiente.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. En lugar de Mutex , utilice un Semaphore con un recuento máximo de 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Para cancelar la operación de espera, llame al RegisteredWaitHandle.Unregister método.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

El subproceso de espera utiliza la función de Win32 WaitForMultipleObjects para supervisar las operaciones de espera registradas.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Por lo tanto, si debe usar el mismo identificador del sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject , debe duplicar el identificador mediante la función de Win32 DuplicateHandle .Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Tenga en cuenta que no debe pulsar un objeto de evento pasado a RegisterWaitForSingleObject , porque el subproceso de espera podría no detectar que el evento está señalado antes de que se restablezca.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Antes de devolver, la función modifica el estado de algunos tipos de objetos de sincronización.Before returning, the function modifies the state of some types of synchronization objects. La modificación solo se produce para el objeto cuyo estado señalado provocó que se cumpliera la condición de espera.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Por ejemplo, el recuento de un semáforo se reduce en uno.For example, the count of a semaphore is decreased by one.

Información de versiónVersion Information

A partir de la versión 2,0 de .NET Framework, el valor de la Thread.CurrentPrincipal propiedad se propaga a los subprocesos de trabajo en cola mediante el RegisterWaitForSingleObject método.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. En versiones anteriores, la información de la entidad de seguridad no se propaga.In earlier versions, the principal information is not propagated.

Se aplica a