WaitHandle.WaitOne Método

Definição

Bloqueia o thread atual até que o WaitHandle atual receba um sinal.Blocks the current thread until the current WaitHandle receives a signal.

Sobrecargas

WaitOne()

Bloqueia o thread atual até que o WaitHandle atual receba um sinal.Blocks the current thread until the current WaitHandle receives a signal.

WaitOne(Int32)

Bloqueia o thread atual até que o WaitHandle atual receba um sinal, usando um inteiro com sinal de 32 bits para especificar o intervalo de tempo em milissegundos.Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval in milliseconds.

WaitOne(TimeSpan)

Bloqueia o thread atual até que a instância atual receba um sinal, usando um TimeSpan para especificar o intervalo de tempo.Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

WaitOne(Int32, Boolean)

Bloqueia o thread atual até que o WaitHandle atual receba um sinal, usando um inteiro com sinal de 32 bits para especificar o intervalo de tempo e especificar se sairá do domínio de sincronização antes da espera.Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval and specifying whether to exit the synchronization domain before the wait.

WaitOne(TimeSpan, Boolean)

Bloqueia o thread atual até que a instância atual receba um sinal, usando um TimeSpan para especificar o intervalo de tempo e especificar se sairá do domínio de sincronização antes da espera.Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

WaitOne()

Bloqueia o thread atual até que o WaitHandle atual receba um sinal.Blocks the current thread until the current WaitHandle receives a signal.

public:
 virtual bool WaitOne();
public virtual bool WaitOne ();
abstract member WaitOne : unit -> bool
override this.WaitOne : unit -> bool
Public Overridable Function WaitOne () As Boolean

Retornos

Boolean

true se a instância atual receber um sinal.true if the current instance receives a signal. Se a instância atual nunca for sinalizada, WaitOne() nunca será retornado.If the current instance is never signaled, WaitOne() never returns.

Exceções

A instância atual já foi descartada.The current instance has already been disposed.

A espera foi concluída porque um thread foi encerrado sem liberar um mutex.The wait completed because a thread exited without releasing a mutex. Essa exceção não é lançada no Windows 98 nem no Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

A instância atual é um proxy transparente para um WaitHandle em outro domínio de aplicativo.The current instance is a transparent proxy for a WaitHandle in another application domain.

Exemplos

O exemplo de código a seguir mostra como usar um identificador de espera para impedir que um processo seja encerrado enquanto aguarda um thread em segundo plano concluir a execução.The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   autoEvent->WaitOne(  );
   Console::WriteLine( "Work method signaled.\nMain ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        autoEvent.WaitOne();
        Console.WriteLine("Work method signaled.\nMain ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
Imports System.Threading

Public Class WaitOne

    Shared autoEvent As New AutoResetEvent(False)

    <MTAThread> _
    Shared Sub Main()
        Console.WriteLine("Main starting.")

        ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent)

        ' Wait for work method to signal.
        autoEvent.WaitOne()
        Console.WriteLine("Work method signaled.")
        Console.WriteLine("Main ending.")
    End Sub

    Shared Sub WorkMethod(stateInfo As Object) 
        Console.WriteLine("Work starting.")

        ' Simulate time spent working.
        Thread.Sleep(New Random().Next(100, 2000))

        ' Signal that work is finished.
        Console.WriteLine("Work ending.")
        CType(stateInfo, AutoResetEvent).Set()
    End Sub

End Class

Comentários

AbandonedMutexException é novo no .NET Framework versão 2,0.AbandonedMutexException is new in the .NET Framework version 2.0. Em versões anteriores, o WaitOne método retorna true quando um mutex é abandonado.In previous versions, the WaitOne method returns true when a mutex is abandoned. Um mutex abandonado geralmente indica um erro de codificação sério.An abandoned mutex often indicates a serious coding error. No caso de um mutex de todo o sistema, isso pode indicar que um aplicativo foi encerrado abruptamente (por exemplo, usando o Gerenciador de tarefas do Windows).In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). A exceção contém informações úteis para depuração.The exception contains information useful for debugging.

O chamador desse método bloqueia indefinidamente até que a instância atual receba um sinal.The caller of this method blocks indefinitely until the current instance receives a signal. Use esse método para bloquear até que um WaitHandle receba um sinal de outro thread, como é gerado quando uma operação assíncrona é concluída.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Para obter mais informações, consulte a IAsyncResult interface.For more information, see the IAsyncResult interface.

Chamar essa sobrecarga de método é equivalente a chamar a WaitOne(Int32, Boolean) sobrecarga do método e especificar-1 ou Timeout.Infinite para o primeiro parâmetro e false para o segundo parâmetro.Calling this method overload is equivalent to calling the WaitOne(Int32, Boolean) method overload and specifying -1 or Timeout.Infinite for the first parameter and false for the second parameter.

Substitua esse método para personalizar o comportamento de classes derivadas.Override this method to customize the behavior of derived classes.

Aplica-se a

WaitOne(Int32)

Bloqueia o thread atual até que o WaitHandle atual receba um sinal, usando um inteiro com sinal de 32 bits para especificar o intervalo de tempo em milissegundos.Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval in milliseconds.

public:
 virtual bool WaitOne(int millisecondsTimeout);
public virtual bool WaitOne (int millisecondsTimeout);
abstract member WaitOne : int -> bool
override this.WaitOne : int -> bool
Public Overridable Function WaitOne (millisecondsTimeout As Integer) As Boolean

Parâmetros

millisecondsTimeout
Int32

O número de milissegundos para aguardar ou Infinite (- 1) para aguardar indefinidamente.The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

Retornos

Boolean

true se a instância atual receber um sinal, caso contrário, false.true if the current instance receives a signal; otherwise, false.

Exceções

A instância atual já foi descartada.The current instance has already been disposed.

millisecondsTimeout é um número negativo diferente de -1, que representa um tempo limite infinito.millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

A espera foi concluída porque um thread foi encerrado sem liberar um mutex.The wait completed because a thread exited without releasing a mutex. Essa exceção não é lançada no Windows 98 nem no Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

A instância atual é um proxy transparente para um WaitHandle em outro domínio de aplicativo.The current instance is a transparent proxy for a WaitHandle in another application domain.

Exemplos

O exemplo de código a seguir mostra como usar um identificador de espera para impedir que um processo seja encerrado enquanto aguarda um thread em segundo plano concluir a execução.The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   if ( autoEvent->WaitOne( 1000 ) )
   {
      Console::WriteLine( "Work method signaled." );
   }
   else
   {
      Console::WriteLine( "Timed out waiting for work "
      "method to signal." );
   }

   Console::WriteLine( "Main ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        if(autoEvent.WaitOne(1000))
        {
            Console.WriteLine("Work method signaled.");
        }
        else
        {
            Console.WriteLine("Timed out waiting for work " +
                "method to signal.");
        }
        Console.WriteLine("Main ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
Imports System.Threading

Public Class WaitOne

    Shared autoEvent As New AutoResetEvent(False)

    <MTAThread> _
    Shared Sub Main()
        Console.WriteLine("Main starting.")

        ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent)

        ' Wait for work method to signal.
        If autoEvent.WaitOne(1000) Then
            Console.WriteLine("Work method signaled.")
        Else
            Console.WriteLine("Timed out waiting for work " & _
                "method to signal.")
        End If

        Console.WriteLine("Main ending.")
    End Sub

    Shared Sub WorkMethod(stateInfo As Object) 
        Console.WriteLine("Work starting.")

        ' Simulate time spent working.
        Thread.Sleep(New Random().Next(100, 2000))

        ' Signal that work is finished.
        Console.WriteLine("Work ending.")
        CType(stateInfo, AutoResetEvent).Set()
    End Sub

End Class

Comentários

Se millisecondsTimeout for zero, o método não será bloqueado.If millisecondsTimeout is zero, the method does not block. Ele testa o estado do identificador de espera e retorna imediatamente.It tests the state of the wait handle and returns immediately.

O chamador desse método é bloqueado até que a instância atual receba um sinal ou um tempo limite ocorra.The caller of this method blocks until the current instance receives a signal or a time-out occurs. Use esse método para bloquear até que um WaitHandle receba um sinal de outro thread, como é gerado quando uma operação assíncrona é concluída.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Para obter mais informações, consulte a IAsyncResult interface.For more information, see the IAsyncResult interface.

Substitua esse método para personalizar o comportamento de classes derivadas.Override this method to customize the behavior of derived classes.

Chamar essa sobrecarga de método é o mesmo que chamar a WaitOne(Int32, Boolean) sobrecarga e especificar false for exitContext .Calling this method overload is the same as calling the WaitOne(Int32, Boolean) overload and specifying false for exitContext.

Aplica-se a

WaitOne(TimeSpan)

Bloqueia o thread atual até que a instância atual receba um sinal, usando um TimeSpan para especificar o intervalo de tempo.Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

public:
 virtual bool WaitOne(TimeSpan timeout);
public virtual bool WaitOne (TimeSpan timeout);
abstract member WaitOne : TimeSpan -> bool
override this.WaitOne : TimeSpan -> bool
Public Overridable Function WaitOne (timeout As TimeSpan) As Boolean

Parâmetros

timeout
TimeSpan

Um TimeSpan que representa o número de milissegundos para aguardar ou um TimeSpan que representa -1 milissegundos para aguardar indefinidamente.A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

Retornos

Boolean

true se a instância atual receber um sinal, caso contrário, false.true if the current instance receives a signal; otherwise, false.

Exceções

A instância atual já foi descartada.The current instance has already been disposed.

timeout é um número negativo diferente de -1 milissegundo, que representa um tempo limite infinito.timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. - ou --or- timeout é maior que MaxValue.timeout is greater than MaxValue.

A espera foi concluída porque um thread foi encerrado sem liberar um mutex.The wait completed because a thread exited without releasing a mutex. Essa exceção não é lançada no Windows 98 nem no Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

A instância atual é um proxy transparente para um WaitHandle em outro domínio de aplicativo.The current instance is a transparent proxy for a WaitHandle in another application domain.

Comentários

Se timeout for zero, o método não será bloqueado.If timeout is zero, the method does not block. Ele testa o estado do identificador de espera e retorna imediatamente.It tests the state of the wait handle and returns immediately.

O chamador desse método é bloqueado até que a instância atual receba um sinal ou um tempo limite ocorra.The caller of this method blocks until the current instance receives a signal or a time-out occurs. Use esse método para bloquear até que um WaitHandle receba um sinal de outro thread, como é gerado quando uma operação assíncrona é concluída.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Para obter mais informações, consulte a IAsyncResult interface.For more information, see the IAsyncResult interface.

Substitua esse método para personalizar o comportamento de classes derivadas.Override this method to customize the behavior of derived classes.

O valor máximo para timeout é Int32.MaxValue .The maximum value for timeout is Int32.MaxValue.

Chamar essa sobrecarga de método é o mesmo que chamar a WaitOne(TimeSpan, Boolean) sobrecarga e especificar false for exitContext .Calling this method overload is the same as calling the WaitOne(TimeSpan, Boolean) overload and specifying false for exitContext.

Aplica-se a

WaitOne(Int32, Boolean)

Bloqueia o thread atual até que o WaitHandle atual receba um sinal, usando um inteiro com sinal de 32 bits para especificar o intervalo de tempo e especificar se sairá do domínio de sincronização antes da espera.Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval and specifying whether to exit the synchronization domain before the wait.

public:
 virtual bool WaitOne(int millisecondsTimeout, bool exitContext);
public virtual bool WaitOne (int millisecondsTimeout, bool exitContext);
abstract member WaitOne : int * bool -> bool
override this.WaitOne : int * bool -> bool
Public Overridable Function WaitOne (millisecondsTimeout As Integer, exitContext As Boolean) As Boolean

Parâmetros

millisecondsTimeout
Int32

O número de milissegundos para aguardar ou Infinite (- 1) para aguardar indefinidamente.The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

exitContext
Boolean

true para sair do domínio de sincronização do contexto antes do tempo de espera (se estiver em um contexto sincronizado) e readquiri-lo posteriormente; caso contrário, false.true to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

Retornos

Boolean

true se a instância atual receber um sinal, caso contrário, false.true if the current instance receives a signal; otherwise, false.

Exceções

A instância atual já foi descartada.The current instance has already been disposed.

millisecondsTimeout é um número negativo diferente de -1, que representa um tempo limite infinito.millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

A espera foi concluída porque um thread foi encerrado sem liberar um mutex.The wait completed because a thread exited without releasing a mutex. Essa exceção não é lançada no Windows 98 nem no Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

A instância atual é um proxy transparente para um WaitHandle em outro domínio de aplicativo.The current instance is a transparent proxy for a WaitHandle in another application domain.

Exemplos

O exemplo a seguir mostra como a WaitOne(Int32, Boolean) sobrecarga do método se comporta quando é chamada em um domínio de sincronização.The following example shows how the WaitOne(Int32, Boolean) method overload behaves when it is called within a synchronization domain. Primeiro, um thread aguarda com exitContext definido como false e será bloqueado até que o tempo limite de espera expire.First, a thread waits with exitContext set to false and blocks until the wait timeout expires. Um segundo thread é executado depois que o primeiro thread é encerrado e aguarda com exitContext definido como true .A second thread executes after the first thread terminates and waits with exitContext set to true. A chamada para sinalizar o identificador de espera para esse segundo thread não está bloqueada e o thread é concluído antes do tempo limite de espera.The call to signal the wait handle for this second thread is not blocked, and the thread completes before the wait timeout.

using namespace System;
using namespace System::Threading;
using namespace System::Runtime::Remoting::Contexts;

[Synchronization(true)]
public ref class SyncingClass : ContextBoundObject
{
private:
    EventWaitHandle^ waitHandle;

public:
    SyncingClass()
    {
         waitHandle =
            gcnew EventWaitHandle(false, EventResetMode::ManualReset);
    }

    void Signal()
    {
        Console::WriteLine("Thread[{0:d4}]: Signalling...", Thread::CurrentThread->GetHashCode());
        waitHandle->Set();
    }

    void DoWait(bool leaveContext)
    {
        bool signalled;

        waitHandle->Reset();
        Console::WriteLine("Thread[{0:d4}]: Waiting...", Thread::CurrentThread->GetHashCode());
        signalled = waitHandle->WaitOne(3000, leaveContext);
        if (signalled)
        {
            Console::WriteLine("Thread[{0:d4}]: Wait released!!!", Thread::CurrentThread->GetHashCode());
        }
        else
        {
            Console::WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread::CurrentThread->GetHashCode());
        }
    }
};

public ref class TestSyncDomainWait
{
public:
    static void Main()
    {
        SyncingClass^ syncClass = gcnew SyncingClass();

        Thread^ runWaiter;

        Console::WriteLine("\nWait and signal INSIDE synchronization domain:\n");
        runWaiter = gcnew Thread(gcnew ParameterizedThreadStart(&TestSyncDomainWait::RunWaitKeepContext));
        runWaiter->Start(syncClass);
        Thread::Sleep(1000);
        Console::WriteLine("Thread[{0:d4}]: Signal...", Thread::CurrentThread->GetHashCode());
        // This call to Signal will block until the timeout in DoWait expires.
        syncClass->Signal();
        runWaiter->Join();

        Console::WriteLine("\nWait and signal OUTSIDE synchronization domain:\n");
        runWaiter = gcnew Thread(gcnew ParameterizedThreadStart(&TestSyncDomainWait::RunWaitLeaveContext));
        runWaiter->Start(syncClass);
        Thread::Sleep(1000);
        Console::WriteLine("Thread[{0:d4}]: Signal...", Thread::CurrentThread->GetHashCode());
        // This call to Signal is unblocked and will set the wait handle to
        // release the waiting thread.
        syncClass->Signal();
        runWaiter->Join();
    }

    static void RunWaitKeepContext(Object^ parm)
    {
        ((SyncingClass^)parm)->DoWait(false);
    }

    static void RunWaitLeaveContext(Object^ parm)
    {
        ((SyncingClass^)parm)->DoWait(true);
    }
};

int main()
{
    TestSyncDomainWait::Main();
}
// The output for the example program will be similar to the following:
//
// Wait and signal INSIDE synchronization domain:
//
// Thread[0004]: Waiting...
// Thread[0001]: Signal...
// Thread[0004]: Wait timeout!!!
// Thread[0001]: Signalling...
//
// Wait and signal OUTSIDE synchronization domain:
//
// Thread[0006]: Waiting...
// Thread[0001]: Signal...
// Thread[0001]: Signalling...
// Thread[0006]: Wait released!!!
using System;
using System.Threading;
using System.Runtime.Remoting.Contexts;

[Synchronization(true)]
public class SyncingClass : ContextBoundObject
{
    private EventWaitHandle waitHandle;

    public SyncingClass()
    {
         waitHandle =
            new EventWaitHandle(false, EventResetMode.ManualReset);
    }

    public void Signal()
    {
        Console.WriteLine("Thread[{0:d4}]: Signalling...", Thread.CurrentThread.GetHashCode());
        waitHandle.Set();
    }

    public void DoWait(bool leaveContext)
    {
        bool signalled;

        waitHandle.Reset();
        Console.WriteLine("Thread[{0:d4}]: Waiting...", Thread.CurrentThread.GetHashCode());
        signalled = waitHandle.WaitOne(3000, leaveContext);
        if (signalled)
        {
            Console.WriteLine("Thread[{0:d4}]: Wait released!!!", Thread.CurrentThread.GetHashCode());
        }
        else
        {
            Console.WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread.CurrentThread.GetHashCode());
        }
    }
}

public class TestSyncDomainWait
{
    public static void Main()
    {
        SyncingClass syncClass = new SyncingClass();

        Thread runWaiter;

        Console.WriteLine("\nWait and signal INSIDE synchronization domain:\n");
        runWaiter = new Thread(RunWaitKeepContext);
        runWaiter.Start(syncClass);
        Thread.Sleep(1000);
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode());
        // This call to Signal will block until the timeout in DoWait expires.
        syncClass.Signal();
        runWaiter.Join();

        Console.WriteLine("\nWait and signal OUTSIDE synchronization domain:\n");
        runWaiter = new Thread(RunWaitLeaveContext);
        runWaiter.Start(syncClass);
        Thread.Sleep(1000);
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode());
        // This call to Signal is unblocked and will set the wait handle to
        // release the waiting thread.
        syncClass.Signal();
        runWaiter.Join();
    }

    public static void RunWaitKeepContext(object parm)
    {
        ((SyncingClass)parm).DoWait(false);
    }

    public static void RunWaitLeaveContext(object parm)
    {
        ((SyncingClass)parm).DoWait(true);
    }
}

// The output for the example program will be similar to the following:
//
// Wait and signal INSIDE synchronization domain:
//
// Thread[0004]: Waiting...
// Thread[0001]: Signal...
// Thread[0004]: Wait timeout!!!
// Thread[0001]: Signalling...
//
// Wait and signal OUTSIDE synchronization domain:
//
// Thread[0006]: Waiting...
// Thread[0001]: Signal...
// Thread[0001]: Signalling...
// Thread[0006]: Wait released!!!
Imports System.Threading
Imports System.Runtime.Remoting.Contexts

<Synchronization(true)>
Public Class SyncingClass
    Inherits ContextBoundObject
    
    Private waitHandle As EventWaitHandle

    Public Sub New()
         waitHandle = New EventWaitHandle(false, EventResetMode.ManualReset)
    End Sub

    Public Sub Signal()
        Console.WriteLine("Thread[{0:d4}]: Signalling...", Thread.CurrentThread.GetHashCode())
        waitHandle.Set()
    End Sub

    Public Sub DoWait(leaveContext As Boolean)
        Dim signalled As Boolean

        waitHandle.Reset()
        Console.WriteLine("Thread[{0:d4}]: Waiting...", Thread.CurrentThread.GetHashCode())
        signalled = waitHandle.WaitOne(3000, leaveContext)
        If signalled Then
            Console.WriteLine("Thread[{0:d4}]: Wait released!!!", Thread.CurrentThread.GetHashCode())
        Else
            Console.WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread.CurrentThread.GetHashCode())
        End If
    End Sub
End Class

Public Class TestSyncDomainWait
    Public Shared Sub Main()
        Dim syncClass As New SyncingClass()

        Dim runWaiter As Thread

        Console.WriteLine(Environment.NewLine + "Wait and signal INSIDE synchronization domain:" + Environment.NewLine)
        runWaiter = New Thread(AddressOf RunWaitKeepContext)
        runWaiter.Start(syncClass)
        Thread.Sleep(1000)
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode())
        ' This call to Signal will block until the timeout in DoWait expires.
        syncClass.Signal()
        runWaiter.Join()

        Console.WriteLine(Environment.NewLine + "Wait and signal OUTSIDE synchronization domain:" + Environment.NewLine)
        runWaiter = New Thread(AddressOf RunWaitLeaveContext)
        runWaiter.Start(syncClass)
        Thread.Sleep(1000)
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode())
        ' This call to Signal is unblocked and will set the wait handle to
        ' release the waiting thread.
        syncClass.Signal()
        runWaiter.Join()
    End Sub

    Public Shared Sub RunWaitKeepContext(parm As Object)
        Dim syncClass As SyncingClass = CType(parm, SyncingClass)
        syncClass.DoWait(False)
    End Sub

    Public Shared Sub RunWaitLeaveContext(parm As Object)
        Dim syncClass As SyncingClass = CType(parm, SyncingClass)
        syncClass.DoWait(True)
    End Sub
End Class

' The output for the example program will be similar to the following:
'
' Wait and signal INSIDE synchronization domain:
'
' Thread[0004]: Waiting...
' Thread[0001]: Signal...
' Thread[0004]: Wait timeout!!!
' Thread[0001]: Signalling...
'
' Wait and signal OUTSIDE synchronization domain:
'
' Thread[0006]: Waiting...
' Thread[0001]: Signal...
' Thread[0001]: Signalling...
' Thread[0006]: Wait released!!!

Comentários

Se millisecondsTimeout for zero, o método não será bloqueado.If millisecondsTimeout is zero, the method does not block. Ele testa o estado do identificador de espera e retorna imediatamente.It tests the state of the wait handle and returns immediately.

AbandonedMutexException é novo no .NET Framework versão 2,0.AbandonedMutexException is new in the .NET Framework version 2.0. Em versões anteriores, o WaitOne método retorna true quando um mutex é abandonado.In previous versions, the WaitOne method returns true when a mutex is abandoned. Um mutex abandonado geralmente indica um erro de codificação sério.An abandoned mutex often indicates a serious coding error. No caso de um mutex de todo o sistema, isso pode indicar que um aplicativo foi encerrado abruptamente (por exemplo, usando o Gerenciador de tarefas do Windows).In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). A exceção contém informações úteis para depuração.The exception contains information useful for debugging.

O chamador desse método é bloqueado até que a instância atual receba um sinal ou um tempo limite ocorra.The caller of this method blocks until the current instance receives a signal or a time-out occurs. Use esse método para bloquear até que um WaitHandle receba um sinal de outro thread, como é gerado quando uma operação assíncrona é concluída.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Para obter mais informações, consulte a IAsyncResult interface.For more information, see the IAsyncResult interface.

Substitua esse método para personalizar o comportamento de classes derivadas.Override this method to customize the behavior of derived classes.

Anotações na saída do contextoNotes on Exiting the Context

O exitContext parâmetro não tem nenhum efeito, a menos que o WaitOne método seja chamado de dentro de um contexto gerenciado não padrão.The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. Isso pode acontecer se o thread estiver dentro de uma chamada para uma instância de uma classe derivada de ContextBoundObject .This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. Mesmo que você esteja executando um método em uma classe que não derive de ContextBoundObject , como String , você pode estar em um contexto não padrão se um ContextBoundObject estiver em sua pilha no domínio do aplicativo atual.Even if you are currently executing a method on a class that does not derive from ContextBoundObject, like String, you can be in a nondefault context if a ContextBoundObject is on your stack in the current application domain.

Quando seu código está sendo executado em um contexto não padrão, especificar true for exitContext faz com que o thread saia do contexto gerenciado não padrão (ou seja, para fazer a transição para o contexto padrão) antes de executar o WaitOne método.When your code is executing in a nondefault context, specifying true for exitContext causes the thread to exit the nondefault managed context (that is, to transition to the default context) before executing the WaitOne method. O thread retorna ao contexto não padrão original depois que a chamada para o WaitOne método é concluída.The thread returns to the original nondefault context after the call to the WaitOne method completes.

Isso pode ser útil quando a classe vinculada ao contexto tem SynchronizationAttribute .This can be useful when the context-bound class has SynchronizationAttribute. Nesse caso, todas as chamadas para membros da classe são sincronizadas automaticamente e o domínio de sincronização é o corpo completo do código para a classe.In that case, all calls to members of the class are automatically synchronized, and the synchronization domain is the entire body of code for the class. Se o código na pilha de chamadas de um membro chamar o WaitOne método e especificar true for exitContext , o thread sairá do domínio de sincronização, permitindo que um thread bloqueado em uma chamada para qualquer membro do objeto continue.If code in the call stack of a member calls the WaitOne method and specifies true for exitContext, the thread exits the synchronization domain, allowing a thread that is blocked on a call to any member of the object to proceed. Quando o WaitOne método retorna, o thread que fez a chamada deve aguardar para inserir novamente o domínio de sincronização.When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

Aplica-se a

WaitOne(TimeSpan, Boolean)

Bloqueia o thread atual até que a instância atual receba um sinal, usando um TimeSpan para especificar o intervalo de tempo e especificar se sairá do domínio de sincronização antes da espera.Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

public:
 virtual bool WaitOne(TimeSpan timeout, bool exitContext);
public virtual bool WaitOne (TimeSpan timeout, bool exitContext);
abstract member WaitOne : TimeSpan * bool -> bool
override this.WaitOne : TimeSpan * bool -> bool
Public Overridable Function WaitOne (timeout As TimeSpan, exitContext As Boolean) As Boolean

Parâmetros

timeout
TimeSpan

Um TimeSpan que representa o número de milissegundos para aguardar ou um TimeSpan que representa -1 milissegundos para aguardar indefinidamente.A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

exitContext
Boolean

true para sair do domínio de sincronização do contexto antes do tempo de espera (se estiver em um contexto sincronizado) e readquiri-lo posteriormente; caso contrário, false.true to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

Retornos

Boolean

true se a instância atual receber um sinal, caso contrário, false.true if the current instance receives a signal; otherwise, false.

Exceções

A instância atual já foi descartada.The current instance has already been disposed.

timeout é um número negativo diferente de -1 milissegundo, que representa um tempo limite infinito.timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. - ou --or- timeout é maior que MaxValue.timeout is greater than MaxValue.

A espera foi concluída porque um thread foi encerrado sem liberar um mutex.The wait completed because a thread exited without releasing a mutex. Essa exceção não é lançada no Windows 98 nem no Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

A instância atual é um proxy transparente para um WaitHandle em outro domínio de aplicativo.The current instance is a transparent proxy for a WaitHandle in another application domain.

Exemplos

O exemplo de código a seguir mostra como usar um identificador de espera para impedir que um processo seja encerrado enquanto aguarda um thread em segundo plano concluir a execução.The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   if ( autoEvent->WaitOne( TimeSpan(0,0,1), false ) )
   {
      Console::WriteLine( "Work method signaled." );
   }
   else
   {
      Console::WriteLine( "Timed out waiting for work "
      "method to signal." );
   }

   Console::WriteLine( "Main ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        if(autoEvent.WaitOne(new TimeSpan(0, 0, 1), false))
        {
            Console.WriteLine("Work method signaled.");
        }
        else
        {
            Console.WriteLine("Timed out waiting for work " +
                "method to signal.");
        }
        Console.WriteLine("Main ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
Imports System.Threading

Public Class WaitOne

    Shared autoEvent As New AutoResetEvent(False)

    <MTAThread> _
    Shared Sub Main()
        Console.WriteLine("Main starting.")

        ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent)

        ' Wait for work method to signal.
        If autoEvent.WaitOne(New TimeSpan(0, 0, 1), False) Then
            Console.WriteLine("Work method signaled.")
        Else
            Console.WriteLine("Timed out waiting for work " & _
                "method to signal.")
        End If

        Console.WriteLine("Main ending.")
    End Sub

    Shared Sub WorkMethod(stateInfo As Object) 
        Console.WriteLine("Work starting.")

        ' Simulate time spent working.
        Thread.Sleep(New Random().Next(100, 2000))

        ' Signal that work is finished.
        Console.WriteLine("Work ending.")
        CType(stateInfo, AutoResetEvent).Set()
    End Sub

End Class

Comentários

Se timeout for zero, o método não será bloqueado.If timeout is zero, the method does not block. Ele testa o estado do identificador de espera e retorna imediatamente.It tests the state of the wait handle and returns immediately.

AbandonedMutexException é novo no .NET Framework versão 2,0.AbandonedMutexException is new in the .NET Framework version 2.0. Em versões anteriores, o WaitOne método retorna true quando um mutex é abandonado.In previous versions, the WaitOne method returns true when a mutex is abandoned. Um mutex abandonado geralmente indica um erro de codificação sério.An abandoned mutex often indicates a serious coding error. No caso de um mutex de todo o sistema, isso pode indicar que um aplicativo foi encerrado abruptamente (por exemplo, usando o Gerenciador de tarefas do Windows).In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). A exceção contém informações úteis para depuração.The exception contains information useful for debugging.

O chamador desse método é bloqueado até que a instância atual receba um sinal ou um tempo limite ocorra.The caller of this method blocks until the current instance receives a signal or a time-out occurs. Use esse método para bloquear até que um WaitHandle receba um sinal de outro thread, como é gerado quando uma operação assíncrona é concluída.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Para obter mais informações, consulte a IAsyncResult interface.For more information, see the IAsyncResult interface.

Substitua esse método para personalizar o comportamento de classes derivadas.Override this method to customize the behavior of derived classes.

O valor máximo para timeout é Int32.MaxValue .The maximum value for timeout is Int32.MaxValue.

Anotações na saída do contextoNotes on Exiting the Context

O exitContext parâmetro não tem nenhum efeito, a menos que o WaitOne método seja chamado de dentro de um contexto gerenciado não padrão.The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. Isso pode acontecer se o thread estiver dentro de uma chamada para uma instância de uma classe derivada de ContextBoundObject .This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. Mesmo que você esteja executando um método em uma classe que não derive de ContextBoundObject , como String , você pode estar em um contexto não padrão se um ContextBoundObject estiver em sua pilha no domínio do aplicativo atual.Even if you are currently executing a method on a class that does not derive from ContextBoundObject, like String, you can be in a nondefault context if a ContextBoundObject is on your stack in the current application domain.

Quando seu código está sendo executado em um contexto não padrão, especificar true for exitContext faz com que o thread saia do contexto gerenciado não padrão (ou seja, para fazer a transição para o contexto padrão) antes de executar o WaitOne método.When your code is executing in a nondefault context, specifying true for exitContext causes the thread to exit the nondefault managed context (that is, to transition to the default context) before executing the WaitOne method. O thread retorna ao contexto não padrão original depois que a chamada para o WaitOne método é concluída.The thread returns to the original nondefault context after the call to the WaitOne method completes.

Isso pode ser útil quando a classe vinculada ao contexto tem SynchronizationAttribute .This can be useful when the context-bound class has SynchronizationAttribute. Nesse caso, todas as chamadas para membros da classe são sincronizadas automaticamente e o domínio de sincronização é o corpo completo do código para a classe.In that case, all calls to members of the class are automatically synchronized, and the synchronization domain is the entire body of code for the class. Se o código na pilha de chamadas de um membro chamar o WaitOne método e especificar true for exitContext , o thread sairá do domínio de sincronização, permitindo que um thread bloqueado em uma chamada para qualquer membro do objeto continue.If code in the call stack of a member calls the WaitOne method and specifies true for exitContext, the thread exits the synchronization domain, allowing a thread that is blocked on a call to any member of the object to proceed. Quando o WaitOne método retorna, o thread que fez a chamada deve aguardar para inserir novamente o domínio de sincronização.When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

Aplica-se a