Note: This API is now obsolete.
Waits until the currently running (if any) asynchronous method is finished.
Namespace: MailBee.Pop3MailAssembly: MailBee.NET (in MailBee.NET.dll) Version: 12.5.0 build 687 for .NET 4.5
Syntax [ObsoleteAttribute("This method is obsolete in .NET 4.5+.")]
public void Wait()
<ObsoleteAttribute("This method is obsolete in .NET 4.5+.")>
Public Sub Wait
Exceptions Remarks Note |
---|
.NET 4.5+ apps should use XXXAsync methods which can be awaited. The current method is suitable for BeginXXX/EndXXX methods only which
are now deprecated. |
This method should only be used in WinForms applications in the scenarios when the application message loop
is blocked and events raised by asynchronous methods get no chance to be processed.
Caution |
---|
RaiseEventsViaMessageLoop property
must be set to false prior to using this method. This is required in order
to switch event marshalling mechanism from sending events to the application message loop
to the internal thread-independent event processor. |
Usually, when the developer uses asynchronous methods which might raise events,
it's not possible to use methods like WaitOne(Int32, Boolean),
since they would block the message loop and thus prevent events (which are raised
on the message loop thread) from getting processed. Wait method provides an alternative
approach which addresses the problem.
Another alternative (in WinForms application) to using Wait method
is to never block the application message loop. See BeginExecuteCustomCommand(String, Boolean, AsyncCallback, Object)
method for the code example.
Note |
---|
In many cases, it's easier not to use events at all but derive a new class from
Pop3 class and override corresponding OnEventName method in order
to get the developer-supplied code executed. See OnConnected(ConnectedEventArgs) method
documentation for more information. |
See Also