ThreadPool.RegisterWaitForSingleObject 方法

定义

注册正在等待 WaitHandle 的委托。

重载

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

指定表示超时(以毫秒为单位)的 32 位无符号整数,注册一个委托等待 WaitHandle

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

注册一个等待 WaitHandle 的委托,并指定一个 TimeSpan 值来表示超时时间。

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

注册一个等待 WaitHandle 的委托,并指定一个 32 位有符号整数来表示超时值(以毫秒为单位)。

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

注册一个等待 WaitHandle 的委托,并指定一个 64 位有符号整数来表示超时值(以毫秒为单位)。

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

重要

此 API 不符合 CLS。

指定表示超时(以毫秒为单位)的 32 位无符号整数,注册一个委托等待 WaitHandle

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

参数

waitObject
WaitHandle

要注册的 WaitHandle。 使用 WaitHandle 而非 Mutex

callBack
WaitOrTimerCallback

waitObject 参数发出信号时调用的 WaitOrTimerCallback 委托。

state
Object

传递给委托的对象。

millisecondsTimeOutInterval
UInt32

以毫秒为单位的超时。 如果 millisecondsTimeOutInterval 参数为 0(零),函数将测试对象的状态并立即返回。 如果 millisecondsTimeOutInterval 为 -1,则函数的超时间隔永远不过期。

executeOnlyOnce
Boolean

如果为 true,表示在调用了委托后,线程将不再在 waitObject 参数上等待;如果为 false,表示每次完成等待操作后都重置计时器,直到注销等待。

返回

RegisteredWaitHandle

RegisteredWaitHandle,可用于取消已注册的等待操作。

属性

例外

millisecondsTimeOutInterval 参数小于 -1。

示例

以下示例演示如何在发出指定的等待句柄信号时使用 RegisterWaitForSingleObject 方法执行指定的回调方法。 在此示例中,回调方法是 WaitProc,等待句柄是 AutoResetEvent

该示例定义一个 TaskInfo 类,用于保存在执行回调时传递给回调的信息。 该示例创建一个 TaskInfo 对象,并为其分配一些字符串数据。 方法返回的 分配给 对象的 字段TaskInfo,以便回调方法有权访问 RegisteredWaitHandleHandleRegisterWaitForSingleObjectRegisteredWaitHandle

除了指定 TaskInfo 为要传递给回调方法的对象之外,对 RegisterWaitForSingleObject 方法的调用还 AutoResetEvent 指定任务将等待的 、 WaitOrTimerCallback 表示回调方法的 WaitProc 委托、一秒超时间隔和多个回调。

当主线程通过调用其 Set 方法向 发出信号AutoResetEvent时,WaitOrTimerCallback将调用委托。 方法 WaitProc 测试 RegisteredWaitHandle 以确定是否发生超时。 如果由于已发出等待句柄信号而调用回调,则 WaitProc 方法将取消注册 RegisteredWaitHandle,从而停止其他回调。 如果超时,任务将继续等待。 方法 WaitProc 以将消息打印到控制台结束。

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

注解

使用 RegisteredWaitHandle 完此方法返回的 时,调用其 RegisteredWaitHandle.Unregister 方法来释放对等待句柄的引用。 建议始终调用 RegisteredWaitHandle.Unregister 方法,即使为 executeOnlyOnce指定 true 。 如果调用 RegisteredWaitHandle.Unregister 方法而不是根据已注册的等待句柄的终结器,垃圾回收可以更高效地工作。

方法 RegisterWaitForSingleObject 将指定的委托排队到线程池。 发生以下任一情况时,工作线程将执行委托:

  • 指定的对象处于已发出信号的状态。

  • 超时间隔已过。

方法 RegisterWaitForSingleObject 检查指定对象的 WaitHandle的当前状态。 如果对象的状态未对齐,该方法将注册等待操作。 等待操作由线程池中的线程执行。 当对象的状态发出信号或超时间隔已过时,该委托由工作线程执行。 timeOutInterval如果参数不为 0 (零) 并且executeOnlyOnce参数为 false,则每次发出事件信号或超时间隔时,计时器都会重置。

重要

Mutex使用 为 waitObject 不会为回调提供相互排除,因为基础 Windows API 使用默认WT_EXECUTEDEFAULT标志,因此每个回调在单独的线程池线程上调度。 使用 Mutex最大计数为 1 的 , Semaphore 而不是 。

若要取消等待操作,请调用 RegisteredWaitHandle.Unregister 方法。

等待线程使用 Win32 WaitForMultipleObjects 函数监视已注册的等待操作。 因此,如果必须在对 的多个调用 RegisterWaitForSingleObject中使用相同的本机操作系统句柄,则必须使用 Win32 DuplicateHandle 函数复制句柄。 请注意,不应对传递给 的事件对象进行 RegisterWaitForSingleObject脉冲处理,因为等待线程可能不会检测到事件在重置之前已发出信号。

在返回之前,函数会修改某些类型的同步对象的状态。 仅针对其信号状态导致满足等待条件的对象进行修改。 例如,信号量计数减少一个。

版本信息

从 .NET Framework 版本 2.0 开始,Thread.CurrentPrincipal属性值将传播到使用 RegisterWaitForSingleObject 方法排队的工作线程。 在早期版本中,不会传播主体信息。

另请参阅

适用于

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

注册一个等待 WaitHandle 的委托,并指定一个 TimeSpan 值来表示超时时间。

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

参数

waitObject
WaitHandle

要注册的 WaitHandle。 使用 WaitHandle 而非 Mutex

callBack
WaitOrTimerCallback

waitObject 参数发出信号时调用的 WaitOrTimerCallback 委托。

state
Object

传递给委托的对象。

timeout
TimeSpan

TimeSpan 表示的超时时间。 如果 timeout 为 0(零),则函数将测试对象的状态并立即返回。 如果 timeout 为 -1,则函数的超时间隔永远不过期。

executeOnlyOnce
Boolean

如果为 true,表示在调用了委托后,线程将不再在 waitObject 参数上等待;如果为 false,表示每次完成等待操作后都重置计时器,直到注销等待。

返回

RegisteredWaitHandle

封装本机句柄的 RegisteredWaitHandle

属性

例外

timeout 参数小于 -1。

参数 timeout 大于 Int32.MaxValue

注解

使用 RegisteredWaitHandle 完此方法返回的 时,调用其 RegisteredWaitHandle.Unregister 方法来释放对等待句柄的引用。 建议始终调用 RegisteredWaitHandle.Unregister 方法,即使为 executeOnlyOnce指定 true 。 如果调用 RegisteredWaitHandle.Unregister 方法而不是根据已注册的等待句柄的终结器,垃圾回收可以更高效地工作。

方法 RegisterWaitForSingleObject 将指定的委托排队到线程池。 发生以下任一情况时,工作线程将执行委托:

  • 指定的对象处于已发出信号的状态。

  • 超时间隔已过。

方法 RegisterWaitForSingleObject 检查指定对象的 WaitHandle的当前状态。 如果对象的状态未对齐,该方法将注册等待操作。 等待操作由线程池中的线程执行。 当对象的状态发出信号或超时间隔已过时,该委托由工作线程执行。 timeOutInterval如果参数不为 0 (零) 并且executeOnlyOnce参数为 false,则每次发出事件信号或超时间隔时,计时器都会重置。

重要

Mutex使用 为 waitObject 不会为回调提供相互排除,因为基础 Windows API 使用默认WT_EXECUTEDEFAULT标志,因此每个回调在单独的线程池线程上调度。 使用 Mutex最大计数为 1 的 , Semaphore 而不是 。

若要取消等待操作,请调用 RegisteredWaitHandle.Unregister 方法。

等待线程使用 Win32 WaitForMultipleObjects 函数监视已注册的等待操作。 因此,如果必须在对 的多个调用 RegisterWaitForSingleObject中使用相同的本机操作系统句柄,则必须使用 Win32 DuplicateHandle 函数复制句柄。 请注意,不应对传递给 的事件对象进行 RegisterWaitForSingleObject脉冲处理,因为等待线程可能不会检测到事件在重置之前已发出信号。

在返回之前,函数会修改某些类型的同步对象的状态。 仅针对其信号状态导致满足等待条件的对象进行修改。 例如,信号量计数减少一个。

版本信息

从 .NET Framework 版本 2.0 开始,Thread.CurrentPrincipal属性值将传播到使用 RegisterWaitForSingleObject 方法排队的工作线程。 在早期版本中,不会传播主体信息。

另请参阅

适用于

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

注册一个等待 WaitHandle 的委托,并指定一个 32 位有符号整数来表示超时值(以毫秒为单位)。

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

参数

waitObject
WaitHandle

要注册的 WaitHandle。 使用 WaitHandle 而非 Mutex

callBack
WaitOrTimerCallback

waitObject 参数发出信号时调用的 WaitOrTimerCallback 委托。

state
Object

传递给委托的对象。

millisecondsTimeOutInterval
Int32

以毫秒为单位的超时。 如果 millisecondsTimeOutInterval 参数为 0(零),函数将测试对象的状态并立即返回。 如果 millisecondsTimeOutInterval 为 -1,则函数的超时间隔永远不过期。

executeOnlyOnce
Boolean

如果为 true,表示在调用了委托后,线程将不再在 waitObject 参数上等待;如果为 false,表示每次完成等待操作后都重置计时器,直到注销等待。

返回

RegisteredWaitHandle

封装本机句柄的 RegisteredWaitHandle

属性

例外

millisecondsTimeOutInterval 参数小于 -1。

注解

使用 RegisteredWaitHandle 完此方法返回的 时,调用其 RegisteredWaitHandle.Unregister 方法来释放对等待句柄的引用。 建议始终调用 RegisteredWaitHandle.Unregister 方法,即使为 executeOnlyOnce指定 true 。 如果调用 RegisteredWaitHandle.Unregister 方法而不是根据已注册的等待句柄的终结器,垃圾回收可以更高效地工作。

方法 RegisterWaitForSingleObject 将指定的委托排队到线程池。 发生以下任一情况时,工作线程将执行委托:

  • 指定的对象处于已发出信号的状态。

  • 超时间隔已过。

方法 RegisterWaitForSingleObject 检查指定对象的 WaitHandle的当前状态。 如果对象的状态未对齐,该方法将注册等待操作。 等待操作由线程池中的线程执行。 当对象的状态发出信号或超时间隔已过时,该委托由工作线程执行。 timeOutInterval如果参数不为 0 (零) 并且executeOnlyOnce参数为 false,则每次发出事件信号或超时间隔时,计时器都会重置。

重要

Mutex使用 为 waitObject 不会为回调提供相互排除,因为基础 Windows API 使用默认WT_EXECUTEDEFAULT标志,因此每个回调在单独的线程池线程上调度。 使用 Mutex最大计数为 1 的 , Semaphore 而不是 。

若要取消等待操作,请调用 RegisteredWaitHandle.Unregister 方法。

等待线程使用 Win32 WaitForMultipleObjects 函数监视已注册的等待操作。 因此,如果必须在对 的多个调用 RegisterWaitForSingleObject中使用相同的本机操作系统句柄,则必须使用 Win32 DuplicateHandle 函数复制句柄。 请注意,不应对传递给 的事件对象进行 RegisterWaitForSingleObject脉冲处理,因为等待线程可能不会检测到事件在重置之前已发出信号。

在返回之前,函数会修改某些类型的同步对象的状态。 仅针对其信号状态导致满足等待条件的对象进行修改。 例如,信号量计数减少一个。

版本信息

从 .NET Framework 版本 2.0 开始,Thread.CurrentPrincipal属性值将传播到使用 RegisterWaitForSingleObject 方法排队的工作线程。 在早期版本中,不会传播主体信息。

另请参阅

适用于

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

注册一个等待 WaitHandle 的委托,并指定一个 64 位有符号整数来表示超时值(以毫秒为单位)。

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

参数

waitObject
WaitHandle

要注册的 WaitHandle。 使用 WaitHandle 而非 Mutex

callBack
WaitOrTimerCallback

waitObject 参数发出信号时调用的 WaitOrTimerCallback 委托。

state
Object

传递给委托的对象。

millisecondsTimeOutInterval
Int64

以毫秒为单位的超时。 如果 millisecondsTimeOutInterval 参数为 0(零),函数将测试对象的状态并立即返回。 如果 millisecondsTimeOutInterval 为 -1,则函数的超时间隔永远不过期。

executeOnlyOnce
Boolean

如果为 true,表示在调用了委托后,线程将不再在 waitObject 参数上等待;如果为 false,表示每次完成等待操作后都重置计时器,直到注销等待。

返回

RegisteredWaitHandle

封装本机句柄的 RegisteredWaitHandle

属性

例外

millisecondsTimeOutInterval 参数小于 -1。

注解

使用 RegisteredWaitHandle 完此方法返回的 时,调用其 RegisteredWaitHandle.Unregister 方法来释放对等待句柄的引用。 建议始终调用 RegisteredWaitHandle.Unregister 方法,即使为 executeOnlyOnce指定 true 。 如果调用 RegisteredWaitHandle.Unregister 方法而不是根据已注册的等待句柄的终结器,垃圾回收可以更高效地工作。

方法 RegisterWaitForSingleObject 将指定的委托排队到线程池。 发生以下任一情况时,工作线程将执行委托:

  • 指定的对象处于已发出信号的状态。

  • 超时间隔已过。

方法 RegisterWaitForSingleObject 检查指定对象的 WaitHandle的当前状态。 如果对象的状态未对齐,该方法将注册等待操作。 等待操作由线程池中的线程执行。 当对象的状态发出信号或超时间隔已过时,该委托由工作线程执行。 timeOutInterval如果参数不为 0 (零) 并且executeOnlyOnce参数为 false,则每次发出事件信号或超时间隔时,计时器都会重置。

重要

Mutex使用 为 waitObject 不会为回调提供相互排除,因为基础 Windows API 使用默认WT_EXECUTEDEFAULT标志,因此每个回调在单独的线程池线程上调度。 使用 Mutex最大计数为 1 的 , Semaphore 而不是 。

若要取消等待操作,请调用 RegisteredWaitHandle.Unregister 方法。

等待线程使用 Win32 WaitForMultipleObjects 函数监视已注册的等待操作。 因此,如果必须在对 的多个调用 RegisterWaitForSingleObject中使用相同的本机操作系统句柄,则必须使用 Win32 DuplicateHandle 函数复制句柄。 请注意,不应对传递给 的事件对象进行 RegisterWaitForSingleObject脉冲处理,因为等待线程可能不会检测到事件在重置之前已发出信号。

在返回之前,函数会修改某些类型的同步对象的状态。 仅针对其信号状态导致满足等待条件的对象进行修改。 例如,信号量计数减少一个。

版本信息

从 .NET Framework 版本 2.0 开始,Thread.CurrentPrincipal属性值将传播到使用 RegisterWaitForSingleObject 方法排队的工作线程。 在早期版本中,不会传播主体信息。

另请参阅

适用于