ThreadPool.RegisterWaitForSingleObject Método

Definición

Espacio de nombres:

System.Threading

Ensamblado:

System.Threading.ThreadPool.dll

Registra un delegado que está esperando a una clase 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.
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.
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.
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.

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

Source:

ThreadPoolWorkQueue.cs

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.

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)>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
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. Use un WaitHandle diferente de Mutex.

callBack

WaitOrTimerCallback

Delegado de WaitOrTimerCallback al que se llamará cuando el parámetro waitObject esté marcado.

state

Object

Objeto que se ha pasado al delegado.

millisecondsTimeOutInterval

UInt32

Tiempo de espera en milisegundos. Si el valor del parámetro millisecondsTimeOutInterval es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. Si millisecondsTimeOutInterval es -1, el intervalo de tiempo de espera de la función nunca transcurre.

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.

Devoluciones

RegisteredWaitHandle

RegisteredWaitHandle que puede usarse para cancelar la operación de espera registrada.

Atributos

CLSCompliantAttribute UnsupportedOSPlatformAttribute

Excepciones

ArgumentOutOfRangeException

El parámetro millisecondsTimeOutInterval es menor que -1.

Ejemplos

En el ejemplo siguiente se muestra cómo usar el RegisterWaitForSingleObject método para ejecutar un método de devolución de llamada especificado cuando se señala un identificador de espera especificado. En este ejemplo, el método de devolución de llamada es WaitProcy el identificador de espera es .AutoResetEvent

En el ejemplo se define una TaskInfo clase para contener la información que se pasa a la devolución de llamada cuando se ejecuta. En el ejemplo se crea un TaskInfo objeto y se le asignan algunos datos de cadena. El RegisteredWaitHandle que devuelve 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.

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 que AutoResetEvent 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.

Cuando el subproceso principal señala mediante AutoResetEvent una llamada a su Set método , se invoca al WaitOrTimerCallback delegado. El WaitProc método comprueba RegisteredWaitHandle si se ha producido un tiempo de espera. Si se invocó la devolución de llamada porque se señalizó el identificador de espera, el método anula el WaitProcRegisteredWaitHandleregistro de , deteniendo devoluciones de llamada adicionales. En el caso de un tiempo de espera, la tarea continúa esperando. El WaitProc método termina imprimiendo un mensaje en la consola.

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 que devuelve este método, llame a su RegisteredWaitHandle.Unregister método para liberar referencias al identificador de espera. Se recomienda llamar siempre al RegisteredWaitHandle.Unregister método , incluso si especifica true para executeOnlyOnce. La recolección de elementos no utilizados funciona de forma más eficaz si se llama al RegisteredWaitHandle.Unregister método en lugar del finalizador del controlador de espera registrado.

El RegisterWaitForSingleObject método pone en cola el delegado especificado en el grupo de subprocesos. Un subproceso de trabajo ejecutará el delegado cuando se produzca una de las siguientes acciones:

• El objeto especificado está en estado señalado.
• El intervalo de tiempo de espera transcurre.

El RegisterWaitForSingleObject método comprueba el estado actual del objeto WaitHandleespecificado. Si el estado del objeto no está firmado, el método registra una operación de espera. Un subproceso del grupo de subprocesos realiza la operación de espera. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto se señala o transcurre el intervalo de tiempo de espera. 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 transcurre el intervalo de tiempo de espera.

Importante

Mutex El uso de para waitObject no proporciona exclusión mutua para las devoluciones de llamada porque la API de Windows subyacente usa la marca predeterminadaWT_EXECUTEDEFAULT, por lo que cada devolución de llamada se envía en un subproceso de grupo de subprocesos independiente. En lugar de , Mutexuse un Semaphore con un recuento máximo de 1.

Para cancelar la operación de espera, llame al RegisteredWaitHandle.Unregister método .

El subproceso de espera usa la función Win32 WaitForMultipleObjects para supervisar las operaciones de espera registradas. Por lo tanto, si debe usar el mismo identificador de sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject, debe duplicar el identificador mediante la función Win32 DuplicateHandle . Tenga en cuenta que no debe pulsar un objeto de evento pasado a RegisterWaitForSingleObject, porque es posible que el subproceso de espera no detecte que el evento se señala antes de que se restablezca.

Antes de devolverla, la función modifica el estado de algunos tipos de objetos de sincronización. La modificación solo se produce para el objeto cuyo estado señalado ha provocado que se cumpla la condición de espera. Por ejemplo, el recuento de un semáforo se reduce en uno.

Consulte también

• Grupo de subprocesos administrados

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

Source:

ThreadPoolWorkQueue.cs

Registra un delegado para que espere a la clase WaitHandle y especifica un valor TimeSpan como tiempo de espera.

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);

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
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. Use un WaitHandle diferente de Mutex.

callBack

WaitOrTimerCallback

Delegado de WaitOrTimerCallback al que se llamará cuando el parámetro waitObject esté marcado.

state

Object

Objeto que se ha pasado al delegado.

timeout

TimeSpan

Tiempo de espera representado por TimeSpan. Si timeout es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. Si timeout es -1, el intervalo de tiempo de espera de la función nunca transcurre.

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.

Devoluciones

RegisteredWaitHandle

RegisteredWaitHandle que encapsula el identificador nativo.

Atributos

UnsupportedOSPlatformAttribute

Excepciones

ArgumentOutOfRangeException

El parámetro timeout es menor que -1.

NotSupportedException

El timeout parámetro es mayor que Int32.MaxValue.

Comentarios

Cuando haya terminado de usar el RegisteredWaitHandle que devuelve este método, llame a su RegisteredWaitHandle.Unregister método para liberar referencias al identificador de espera. Se recomienda llamar siempre al RegisteredWaitHandle.Unregister método , incluso si especifica true para executeOnlyOnce. La recolección de elementos no utilizados funciona de forma más eficaz si se llama al RegisteredWaitHandle.Unregister método en lugar del finalizador del controlador de espera registrado.

El RegisterWaitForSingleObject método pone en cola el delegado especificado en el grupo de subprocesos. Un subproceso de trabajo ejecutará el delegado cuando se produzca una de las siguientes acciones:

• El objeto especificado está en estado señalado.
• El intervalo de tiempo de espera transcurre.

El RegisterWaitForSingleObject método comprueba el estado actual del objeto WaitHandleespecificado. Si el estado del objeto no está firmado, el método registra una operación de espera. Un subproceso del grupo de subprocesos realiza la operación de espera. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto se señala o transcurre el intervalo de tiempo de espera. 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 transcurre el intervalo de tiempo de espera.

Importante

Mutex El uso de para waitObject no proporciona exclusión mutua para las devoluciones de llamada porque la API de Windows subyacente usa la marca predeterminadaWT_EXECUTEDEFAULT, por lo que cada devolución de llamada se envía en un subproceso de grupo de subprocesos independiente. En lugar de , Mutexuse un Semaphore con un recuento máximo de 1.

Para cancelar la operación de espera, llame al RegisteredWaitHandle.Unregister método .

El subproceso de espera usa la función Win32 WaitForMultipleObjects para supervisar las operaciones de espera registradas. Por lo tanto, si debe usar el mismo identificador de sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject, debe duplicar el identificador mediante la función Win32 DuplicateHandle . Tenga en cuenta que no debe pulsar un objeto de evento pasado a RegisterWaitForSingleObject, porque es posible que el subproceso de espera no detecte que el evento se señala antes de que se restablezca.

Antes de devolverla, la función modifica el estado de algunos tipos de objetos de sincronización. La modificación solo se produce para el objeto cuyo estado señalado ha provocado que se cumpla la condición de espera. Por ejemplo, el recuento de un semáforo se reduce en uno.

Consulte también

• Grupo de subprocesos administrados

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

Source:

ThreadPoolWorkQueue.cs

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.

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);

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
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. Use un WaitHandle diferente de Mutex.

callBack

WaitOrTimerCallback

Delegado de WaitOrTimerCallback al que se llamará cuando el parámetro waitObject esté marcado.

state

Object

Objeto que se pasa al delegado.

millisecondsTimeOutInterval

Int32

Tiempo de espera en milisegundos. Si el valor del parámetro millisecondsTimeOutInterval es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. Si millisecondsTimeOutInterval es -1, el intervalo de tiempo de espera de la función nunca transcurre.

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.

Devoluciones

RegisteredWaitHandle

RegisteredWaitHandle que encapsula el identificador nativo.

Atributos

UnsupportedOSPlatformAttribute

Excepciones

ArgumentOutOfRangeException

El parámetro millisecondsTimeOutInterval es menor que -1.

Comentarios

Cuando haya terminado de usar el RegisteredWaitHandle que devuelve este método, llame a su RegisteredWaitHandle.Unregister método para liberar referencias al identificador de espera. Se recomienda llamar siempre al RegisteredWaitHandle.Unregister método , incluso si especifica true para executeOnlyOnce. La recolección de elementos no utilizados funciona de forma más eficaz si llama al RegisteredWaitHandle.Unregister método en lugar de según el finalizador del identificador de espera registrado.

El RegisterWaitForSingleObject método pone en cola el delegado especificado en el grupo de subprocesos. Un subproceso de trabajo ejecutará el delegado cuando se produzca una de las siguientes acciones:

• El objeto especificado está en estado señalado.
• El intervalo de tiempo de espera transcurre.

El RegisterWaitForSingleObject método comprueba el estado actual del objeto WaitHandleespecificado. Si el estado del objeto no tiene signo, el método registra una operación de espera. Un subproceso del grupo de subprocesos realiza la operación de espera. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto se señala o transcurre el intervalo de tiempo de espera. Si el timeOutInterval parámetro no es 0 (cero) y el parámetro es false, el executeOnlyOnce temporizador se restablece cada vez que se señala el evento o transcurre el intervalo de tiempo de espera.

Importante

Mutex El uso de para waitObject no proporciona exclusión mutua para las devoluciones de llamada porque la API de Windows subyacente usa la marca predeterminadaWT_EXECUTEDEFAULT, por lo que cada devolución de llamada se envía en un subproceso de grupo de subprocesos independiente. En lugar de , Mutexuse un Semaphore con un recuento máximo de 1.

Para cancelar la operación de espera, llame al RegisteredWaitHandle.Unregister método .

El subproceso de espera usa la función Win32 WaitForMultipleObjects para supervisar las operaciones de espera registradas. Por lo tanto, si debes usar el mismo identificador de sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject, debes duplicar el identificador mediante la función Win32 DuplicateHandle . Tenga en cuenta que no debe pulsar un objeto de evento pasado a RegisterWaitForSingleObject, porque es posible que el subproceso de espera no detecte que el evento se señale antes de restablecerlo.

Antes de devolver, la función modifica el estado de algunos tipos de objetos de sincronización. La modificación solo se produce para el objeto cuyo estado señalado ha provocado que se cumpla la condición de espera. Por ejemplo, el recuento de un semáforo se reduce en uno.

Consulte también

• Grupo de subprocesos administrados

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

Source:

ThreadPoolWorkQueue.cs

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.

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);

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
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. Use un WaitHandle diferente de Mutex.

callBack

WaitOrTimerCallback

Delegado de WaitOrTimerCallback al que se llamará cuando el parámetro waitObject esté marcado.

state

Object

Objeto que se ha pasado al delegado.

millisecondsTimeOutInterval

Int64

Tiempo de espera en milisegundos. Si el valor del parámetro millisecondsTimeOutInterval es 0 (cero), la función comprueba el estado del objeto y regresa inmediatamente. Si millisecondsTimeOutInterval es -1, el intervalo de tiempo de espera de la función nunca transcurre.

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.

Devoluciones

RegisteredWaitHandle

RegisteredWaitHandle que encapsula el identificador nativo.

Atributos

UnsupportedOSPlatformAttribute

Excepciones

ArgumentOutOfRangeException

El parámetro millisecondsTimeOutInterval es menor que -1.

Comentarios

Cuando haya terminado de usar el RegisteredWaitHandle que devuelve este método, llame a su RegisteredWaitHandle.Unregister método para liberar referencias al identificador de espera. Se recomienda llamar siempre al RegisteredWaitHandle.Unregister método , incluso si especifica true para executeOnlyOnce. La recolección de elementos no utilizados funciona de forma más eficaz si llama al RegisteredWaitHandle.Unregister método en lugar de según el finalizador del identificador de espera registrado.

El RegisterWaitForSingleObject método pone en cola el delegado especificado en el grupo de subprocesos. Un subproceso de trabajo ejecutará el delegado cuando se produzca una de las siguientes acciones:

• El objeto especificado está en estado señalado.
• El intervalo de tiempo de espera transcurre.

El RegisterWaitForSingleObject método comprueba el estado actual del objeto WaitHandleespecificado. Si el estado del objeto no tiene signo, el método registra una operación de espera. Un subproceso del grupo de subprocesos realiza la operación de espera. Un subproceso de trabajo ejecuta el delegado cuando el estado del objeto se señala o transcurre el intervalo de tiempo de espera. Si el timeOutInterval parámetro no es 0 (cero) y el parámetro es false, el executeOnlyOnce temporizador se restablece cada vez que se señala el evento o transcurre el intervalo de tiempo de espera.

Importante

Mutex El uso de para waitObject no proporciona exclusión mutua para las devoluciones de llamada porque la API de Windows subyacente usa la marca predeterminadaWT_EXECUTEDEFAULT, por lo que cada devolución de llamada se envía en un subproceso de grupo de subprocesos independiente. En lugar de , Mutexuse un Semaphore con un recuento máximo de 1.

Para cancelar la operación de espera, llame al RegisteredWaitHandle.Unregister método .

El subproceso de espera usa la función Win32 WaitForMultipleObjects para supervisar las operaciones de espera registradas. Por lo tanto, si debes usar el mismo identificador de sistema operativo nativo en varias llamadas a RegisterWaitForSingleObject, debes duplicar el identificador mediante la función Win32 DuplicateHandle . Tenga en cuenta que no debe pulsar un objeto de evento pasado a RegisterWaitForSingleObject, porque es posible que el subproceso de espera no detecte que el evento se señale antes de restablecerlo.

Antes de devolver, la función modifica el estado de algunos tipos de objetos de sincronización. La modificación solo se produce para el objeto cuyo estado señalado ha provocado que se cumpla la condición de espera. Por ejemplo, el recuento de un semáforo se reduce en uno.

Consulte también

• Grupo de subprocesos administrados