ConnectionStateExtensionWaitForTargetStateAsync Method
Waits until the target AdsServer reaches the requested state (asynchronous)
Namespace: TwinCAT.Ads.Extensions
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll)
Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470
Syntax
C#
public static Task<ResultWriteControl> WaitForTargetStateAsync(
this IAdsConnection client,
IList<AdsState> endingStates,
TimeSpan pollingRate,
TimeSpan waitTimeout,
CancellationToken cancel
)Parameters
|
client IAdsConnection |
The client. |
|
The requested states / endingStates | |
|
pollingRate TimeSpan |
The polling rate. |
|
waitTimeout TimeSpan |
The timeout. |
|
cancel CancellationToken |
The cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Return Value
Task
ResultWriteControl
A Task<System.Boolean> representing if the requested state
was reached (true), or the method ran into timeout (false).
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IAdsConnection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Remarks
The polling rate should not be faster than the client timeout.
Reference
ConnectionStateExtension Class TwinCAT.Ads.Extensions Namespace
Beckhoff Automation GmbH & Co. KG 2001-2026