SystemServiceExtension.WaitUntilRestartedAsync Method

Waits until the SystemService Restart is detectd on the client (SystemService, Port 10000) (asynchronously)

Namespace:  TwinCAT.SystemService
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 6.0.328+39e3229

Syntax

C#

public static Task<bool> WaitUntilRestartedAsync(
    this IAdsConnection connection,
    TimeSpan pollingRate,
    TimeSpan waitTimeout,
    CancellationToken cancel
)

Parameters

connection

Type: TwinCAT.Ads.IAdsConnection
The client (should be an IAdsConnection on port 10000)

pollingRate

Type: System.TimeSpan
The polling rate (should be lower than the connection timeout).

waitTimeout

Type: System.TimeSpan
The wait timeout.

cancel

Type: System.Threading.CancellationToken
The cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value

Type: Task.Boolean.
A Task<System.Boolean> representing whether the restart is detected (true), or the timeout occurred (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).

Reference

SystemServiceExtension Class

TwinCAT.SystemService Namespace