Bagikan melalui


ThreadPool.RegisterWaitForSingleObject Metode

Definisi

Mendaftarkan delegasi yang menunggu WaitHandle.

Overload

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

Mendaftarkan delegasi untuk WaitHandlemenunggu , menentukan bilangan bulat yang tidak ditandatangani 32-bit untuk waktu habis dalam milidetik.

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

Mendaftarkan delegasi untuk WaitHandlemenunggu , menentukan TimeSpan nilai untuk waktu habis.

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

Mendaftarkan delegasi untuk WaitHandlemenunggu , menentukan bilangan bulat yang ditandatangani 32-bit untuk waktu habis dalam milidetik.

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

Mendaftarkan delegasi untuk WaitHandlemenunggu , menentukan bilangan bulat yang ditandatangani 64-bit untuk waktu habis dalam milidetik.

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

Sumber:
ThreadPoolWorkQueue.cs
Sumber:
ThreadPoolWorkQueue.cs
Sumber:
ThreadPoolWorkQueue.cs

Penting

API ini bukan kompatibel CLS.

Mendaftarkan delegasi untuk WaitHandlemenunggu , menentukan bilangan bulat yang tidak ditandatangani 32-bit untuk waktu habis dalam milidetik.

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

Parameter

waitObject
WaitHandle

Untuk WaitHandle mendaftar. WaitHandle Gunakan selain Mutex.

callBack
WaitOrTimerCallback

WaitOrTimerCallback Delegasi untuk memanggil saat waitObject parameter diberi sinyal.

state
Object

Objek diteruskan ke delegasi.

millisecondsTimeOutInterval
UInt32

Waktu habis dalam milidetik. millisecondsTimeOutInterval Jika parameter adalah 0 (nol), fungsi akan menguji status objek dan segera kembali. Jika millisecondsTimeOutInterval adalah -1, interval waktu habis fungsi tidak pernah berlalu.

executeOnlyOnce
Boolean

true untuk menunjukkan bahwa utas tidak akan lagi menunggu parameter waitObject setelah delegasi dipanggil; false untuk menunjukkan bahwa timer diatur ulang setiap kali operasi tunggu selesai sampai penantian tidak terdaftar.

Mengembalikan

RegisteredWaitHandle yang dapat digunakan untuk membatalkan operasi tunggu terdaftar.

Atribut

Pengecualian

Parameternya millisecondsTimeOutInterval kurang dari -1.

Contoh

Contoh berikut menunjukkan cara menggunakan RegisterWaitForSingleObject metode untuk menjalankan metode panggilan balik tertentu ketika handel tunggu yang ditentukan diberi sinyal. Dalam contoh ini, metode panggilan balik adalah WaitProc, dan handel tunggu adalah AutoResetEvent.

Contoh mendefinisikan TaskInfo kelas untuk menyimpan informasi yang diteruskan ke panggilan balik saat dijalankan. Contohnya membuat TaskInfo objek dan menetapkannya beberapa data string. RegisteredWaitHandle yang dikembalikan oleh RegisterWaitForSingleObject metode ditetapkan ke Handle bidang TaskInfo objek sehingga metode panggilan balik memiliki akses ke RegisteredWaitHandle.

Selain menentukan TaskInfo sebagai objek untuk diteruskan ke metode panggilan balik, panggilan ke RegisterWaitForSingleObject metode menentukan AutoResetEvent bahwa tugas akan menunggu, WaitOrTimerCallback delegasi yang mewakili WaitProc metode panggilan balik, interval waktu habis satu detik, dan beberapa panggilan balik.

Ketika utas AutoResetEvent utama memberi sinyal dengan memanggil metodenya Set , WaitOrTimerCallback delegasi dipanggil. Metode ini WaitProc menguji RegisteredWaitHandle untuk menentukan apakah waktu habis terjadi. Jika panggilan balik dipanggil karena handel tunggu diberi sinyal, WaitProc metode membatalkan pendaftaran RegisteredWaitHandle, menghentikan panggilan balik tambahan. Dalam kasus waktu habis, tugas terus menunggu. Metode WaitProc berakhir dengan mencetak pesan ke konsol.

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

Keterangan

Ketika Anda selesai menggunakan RegisteredWaitHandle yang dikembalikan oleh metode ini, panggil metodenya RegisteredWaitHandle.Unregister untuk merilis referensi ke handel tunggu. Kami menyarankan agar Anda selalu memanggil RegisteredWaitHandle.Unregister metode , bahkan jika Anda menentukan true untuk executeOnlyOnce. Pengumpulan sampah bekerja lebih efisien jika Anda memanggil RegisteredWaitHandle.Unregister metode alih-alih tergantung pada finalizer handel tunggu yang terdaftar.

Metode ini RegisterWaitForSingleObject mengantre delegasi yang ditentukan ke kumpulan utas. Utas pekerja akan menjalankan delegasi ketika salah satu hal berikut ini terjadi:

  • Objek yang ditentukan dalam status disinyalkan.
  • Interval waktu habis berlalu.

Metode RegisterWaitForSingleObject memeriksa status saat ini dari objek WaitHandleyang ditentukan. Jika status objek tidak ditandatangani, metode mendaftarkan operasi tunggu. Operasi tunggu dilakukan oleh utas dari kumpulan utas. Delegasi dijalankan oleh utas pekerja ketika status objek menjadi sinyal atau interval waktu habis berlalu. timeOutInterval Jika parameter bukan 0 (nol) dan executeOnlyOnce parameternya adalah false, timer direset setiap kali peristiwa disinyalkan atau interval waktu habis berlalu.

Penting

Mutex Menggunakan untuk waitObject tidak memberikan pengecualian bersama untuk panggilan balik karena Windows API yang mendasar menggunakan bendera defaultWT_EXECUTEDEFAULT, sehingga setiap panggilan balik dikirim pada utas kumpulan utas terpisah. Alih-alih Mutex, gunakan Semaphore dengan jumlah maksimum 1.

Untuk membatalkan operasi tunggu, panggil RegisteredWaitHandle.Unregister metode .

Utas tunggu menggunakan fungsi Win32 WaitForMultipleObjects untuk memantau operasi tunggu terdaftar. Oleh karena itu, jika Anda harus menggunakan handel sistem operasi asli yang sama dalam beberapa panggilan ke RegisterWaitForSingleObject, Anda harus menduplikasi handel menggunakan fungsi Win32 DuplicateHandle . Perhatikan bahwa Anda tidak boleh meniru objek peristiwa yang diteruskan ke RegisterWaitForSingleObject, karena utas tunggu mungkin tidak mendeteksi bahwa peristiwa diberi sinyal sebelum diatur ulang.

Sebelum kembali, fungsi memodifikasi status beberapa jenis objek sinkronisasi. Modifikasi hanya terjadi untuk objek yang status sinyalnya menyebabkan kondisi tunggu terpenuhi. Misalnya, jumlah semaphore berkurang satu.

Lihat juga

Berlaku untuk

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

Sumber:
ThreadPoolWorkQueue.cs
Sumber:
ThreadPoolWorkQueue.cs
Sumber:
ThreadPoolWorkQueue.cs

Mendaftarkan delegasi untuk WaitHandlemenunggu , menentukan TimeSpan nilai untuk waktu habis.

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

Parameter

waitObject
WaitHandle

Untuk WaitHandle mendaftar. WaitHandle Gunakan selain Mutex.

callBack
WaitOrTimerCallback

WaitOrTimerCallback Delegasi untuk memanggil saat waitObject parameter diberi sinyal.

state
Object

Objek diteruskan ke delegasi.

timeout
TimeSpan

Waktu habis diwakili oleh TimeSpan. Jika timeout adalah 0 (nol), fungsi menguji status objek dan segera kembali. Jika timeout adalah -1, interval waktu habis fungsi tidak pernah berlalu.

executeOnlyOnce
Boolean

true untuk menunjukkan bahwa utas tidak akan lagi menunggu parameter waitObject setelah delegasi dipanggil; false untuk menunjukkan bahwa timer diatur ulang setiap kali operasi tunggu selesai sampai penantian tidak terdaftar.

Mengembalikan

RegisteredWaitHandle yang merangkum handel asli.

Atribut

Pengecualian

Parameternya timeout kurang dari -1.

Parameter timeout lebih besar dari Int32.MaxValue.

Keterangan

Ketika Anda selesai menggunakan RegisteredWaitHandle yang dikembalikan oleh metode ini, panggil metodenya RegisteredWaitHandle.Unregister untuk merilis referensi ke handel tunggu. Kami menyarankan agar Anda selalu memanggil RegisteredWaitHandle.Unregister metode , bahkan jika Anda menentukan true untuk executeOnlyOnce. Pengumpulan sampah bekerja lebih efisien jika Anda memanggil RegisteredWaitHandle.Unregister metode alih-alih tergantung pada finalizer handel tunggu yang terdaftar.

Metode ini RegisterWaitForSingleObject mengantre delegasi yang ditentukan ke kumpulan utas. Utas pekerja akan menjalankan delegasi ketika salah satu hal berikut ini terjadi:

  • Objek yang ditentukan dalam status disinyalkan.
  • Interval waktu habis berlalu.

Metode RegisterWaitForSingleObject memeriksa status saat ini dari objek WaitHandleyang ditentukan. Jika status objek tidak ditandatangani, metode mendaftarkan operasi tunggu. Operasi tunggu dilakukan oleh utas dari kumpulan utas. Delegasi dijalankan oleh utas pekerja ketika status objek menjadi sinyal atau interval waktu habis berlalu. timeOutInterval Jika parameter bukan 0 (nol) dan executeOnlyOnce parameternya adalah false, timer direset setiap kali peristiwa disinyalkan atau interval waktu habis berlalu.

Penting

Mutex Menggunakan untuk waitObject tidak memberikan pengecualian bersama untuk panggilan balik karena Windows API yang mendasar menggunakan bendera defaultWT_EXECUTEDEFAULT, sehingga setiap panggilan balik dikirim pada utas kumpulan utas terpisah. Alih-alih Mutex, gunakan Semaphore dengan jumlah maksimum 1.

Untuk membatalkan operasi tunggu, panggil RegisteredWaitHandle.Unregister metode .

Utas tunggu menggunakan fungsi Win32 WaitForMultipleObjects untuk memantau operasi tunggu terdaftar. Oleh karena itu, jika Anda harus menggunakan handel sistem operasi asli yang sama dalam beberapa panggilan ke RegisterWaitForSingleObject, Anda harus menduplikasi handel menggunakan fungsi Win32 DuplicateHandle . Perhatikan bahwa Anda tidak boleh meniru objek peristiwa yang diteruskan ke RegisterWaitForSingleObject, karena utas tunggu mungkin tidak mendeteksi bahwa peristiwa diberi sinyal sebelum diatur ulang.

Sebelum kembali, fungsi memodifikasi status beberapa jenis objek sinkronisasi. Modifikasi hanya terjadi untuk objek yang status sinyalnya menyebabkan kondisi tunggu terpenuhi. Misalnya, jumlah semaphore berkurang satu.

Lihat juga

Berlaku untuk

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

Sumber:
ThreadPoolWorkQueue.cs
Sumber:
ThreadPoolWorkQueue.cs
Sumber:
ThreadPoolWorkQueue.cs

Mendaftarkan delegasi untuk WaitHandlemenunggu , menentukan bilangan bulat yang ditandatangani 32-bit untuk waktu habis dalam milidetik.

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

Parameter

waitObject
WaitHandle

Untuk WaitHandle mendaftar. WaitHandle Gunakan selain Mutex.

callBack
WaitOrTimerCallback

WaitOrTimerCallback Delegasi untuk memanggil saat waitObject parameter diberi sinyal.

state
Object

Objek yang diteruskan ke delegasi.

millisecondsTimeOutInterval
Int32

Waktu habis dalam milidetik. millisecondsTimeOutInterval Jika parameter adalah 0 (nol), fungsi akan menguji status objek dan segera kembali. Jika millisecondsTimeOutInterval adalah -1, interval waktu habis fungsi tidak pernah berlalu.

executeOnlyOnce
Boolean

true untuk menunjukkan bahwa utas tidak akan lagi menunggu parameter waitObject setelah delegasi dipanggil; false untuk menunjukkan bahwa timer diatur ulang setiap kali operasi tunggu selesai sampai penantian tidak terdaftar.

Mengembalikan

RegisteredWaitHandle yang merangkum handel asli.

Atribut

Pengecualian

Parameternya millisecondsTimeOutInterval kurang dari -1.

Keterangan

Ketika Anda selesai menggunakan RegisteredWaitHandle yang dikembalikan oleh metode ini, panggil metodenya RegisteredWaitHandle.Unregister untuk merilis referensi ke handel tunggu. Kami menyarankan agar Anda selalu memanggil RegisteredWaitHandle.Unregister metode , bahkan jika Anda menentukan true untuk executeOnlyOnce. Pengumpulan sampah bekerja lebih efisien jika Anda memanggil RegisteredWaitHandle.Unregister metode alih-alih tergantung pada finalizer handel tunggu yang terdaftar.

Metode ini RegisterWaitForSingleObject mengantre delegasi yang ditentukan ke kumpulan utas. Utas pekerja akan menjalankan delegasi ketika salah satu hal berikut ini terjadi:

  • Objek yang ditentukan dalam status disinyalkan.
  • Interval waktu habis berlalu.

Metode RegisterWaitForSingleObject memeriksa status saat ini dari objek WaitHandleyang ditentukan. Jika status objek tidak ditandatangani, metode mendaftarkan operasi tunggu. Operasi tunggu dilakukan oleh utas dari kumpulan utas. Delegasi dijalankan oleh utas pekerja ketika status objek menjadi sinyal atau interval waktu habis berlalu. timeOutInterval Jika parameter bukan 0 (nol) dan executeOnlyOnce parameternya adalah false, timer direset setiap kali peristiwa disinyalkan atau interval waktu habis berlalu.

Penting

Mutex Menggunakan untuk waitObject tidak memberikan pengecualian bersama untuk panggilan balik karena Windows API yang mendasar menggunakan bendera defaultWT_EXECUTEDEFAULT, sehingga setiap panggilan balik dikirim pada utas kumpulan utas terpisah. Alih-alih Mutex, gunakan Semaphore dengan jumlah maksimum 1.

Untuk membatalkan operasi tunggu, panggil RegisteredWaitHandle.Unregister metode .

Utas tunggu menggunakan fungsi Win32 WaitForMultipleObjects untuk memantau operasi tunggu terdaftar. Oleh karena itu, jika Anda harus menggunakan handel sistem operasi asli yang sama dalam beberapa panggilan ke RegisterWaitForSingleObject, Anda harus menduplikasi handel menggunakan fungsi Win32 DuplicateHandle . Perhatikan bahwa Anda tidak boleh meniru objek peristiwa yang diteruskan ke RegisterWaitForSingleObject, karena utas tunggu mungkin tidak mendeteksi bahwa peristiwa diberi sinyal sebelum diatur ulang.

Sebelum kembali, fungsi memodifikasi status beberapa jenis objek sinkronisasi. Modifikasi hanya terjadi untuk objek yang status sinyalnya menyebabkan kondisi tunggu terpenuhi. Misalnya, jumlah semaphore berkurang satu.

Lihat juga

Berlaku untuk

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

Sumber:
ThreadPoolWorkQueue.cs
Sumber:
ThreadPoolWorkQueue.cs
Sumber:
ThreadPoolWorkQueue.cs

Mendaftarkan delegasi untuk WaitHandlemenunggu , menentukan bilangan bulat yang ditandatangani 64-bit untuk waktu habis dalam milidetik.

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

Parameter

waitObject
WaitHandle

Untuk WaitHandle mendaftar. WaitHandle Gunakan selain Mutex.

callBack
WaitOrTimerCallback

WaitOrTimerCallback Delegasi untuk memanggil saat waitObject parameter diberi sinyal.

state
Object

Objek diteruskan ke delegasi.

millisecondsTimeOutInterval
Int64

Waktu habis dalam milidetik. millisecondsTimeOutInterval Jika parameter adalah 0 (nol), fungsi akan menguji status objek dan segera kembali. Jika millisecondsTimeOutInterval adalah -1, interval waktu habis fungsi tidak pernah berlalu.

executeOnlyOnce
Boolean

true untuk menunjukkan bahwa utas tidak akan lagi menunggu parameter waitObject setelah delegasi dipanggil; false untuk menunjukkan bahwa timer diatur ulang setiap kali operasi tunggu selesai sampai penantian tidak terdaftar.

Mengembalikan

RegisteredWaitHandle yang merangkum handel asli.

Atribut

Pengecualian

Parameternya millisecondsTimeOutInterval kurang dari -1.

Keterangan

Ketika Anda selesai menggunakan RegisteredWaitHandle yang dikembalikan oleh metode ini, panggil metodenya RegisteredWaitHandle.Unregister untuk merilis referensi ke handel tunggu. Kami menyarankan agar Anda selalu memanggil RegisteredWaitHandle.Unregister metode , bahkan jika Anda menentukan true untuk executeOnlyOnce. Pengumpulan sampah bekerja lebih efisien jika Anda memanggil RegisteredWaitHandle.Unregister metode alih-alih tergantung pada finalizer handel tunggu yang terdaftar.

Metode ini RegisterWaitForSingleObject mengantre delegasi yang ditentukan ke kumpulan utas. Utas pekerja akan menjalankan delegasi ketika salah satu hal berikut ini terjadi:

  • Objek yang ditentukan dalam status disinyalkan.
  • Interval waktu habis berlalu.

Metode RegisterWaitForSingleObject memeriksa status saat ini dari objek WaitHandleyang ditentukan. Jika status objek tidak ditandatangani, metode mendaftarkan operasi tunggu. Operasi tunggu dilakukan oleh utas dari kumpulan utas. Delegasi dijalankan oleh utas pekerja ketika status objek menjadi sinyal atau interval waktu habis berlalu. timeOutInterval Jika parameter bukan 0 (nol) dan executeOnlyOnce parameternya adalah false, timer direset setiap kali peristiwa disinyalkan atau interval waktu habis berlalu.

Penting

Mutex Menggunakan untuk waitObject tidak memberikan pengecualian bersama untuk panggilan balik karena Windows API yang mendasar menggunakan bendera defaultWT_EXECUTEDEFAULT, sehingga setiap panggilan balik dikirim pada utas kumpulan utas terpisah. Alih-alih Mutex, gunakan Semaphore dengan jumlah maksimum 1.

Untuk membatalkan operasi tunggu, panggil RegisteredWaitHandle.Unregister metode .

Utas tunggu menggunakan fungsi Win32 WaitForMultipleObjects untuk memantau operasi tunggu terdaftar. Oleh karena itu, jika Anda harus menggunakan handel sistem operasi asli yang sama dalam beberapa panggilan ke RegisterWaitForSingleObject, Anda harus menduplikasi handel menggunakan fungsi Win32 DuplicateHandle . Perhatikan bahwa Anda tidak boleh meniru objek peristiwa yang diteruskan ke RegisterWaitForSingleObject, karena utas tunggu mungkin tidak mendeteksi bahwa peristiwa diberi sinyal sebelum diatur ulang.

Sebelum kembali, fungsi memodifikasi status beberapa jenis objek sinkronisasi. Modifikasi hanya terjadi untuk objek yang status sinyalnya menyebabkan kondisi tunggu terpenuhi. Misalnya, jumlah semaphore berkurang satu.

Lihat juga

Berlaku untuk