AdsServer.OnReadConfirmationAsync Method

Called when an ADS Read confirmation is received.

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

Syntax

C#

protected virtual Task<AdsErrorCode> OnReadConfirmationAsync(
    AmsAddress targetAddress,
    uint invokeId,
    AdsErrorCode result,
    ReadOnlyMemory<byte> readData,
    CancellationToken cancel
)

Parameters

targetAddress	Type: TwinCAT.Ads.AmsAddress The sender's AMS address
invokeId	Type: System.UInt32 The invoke id provided by this server during the corresponding request
result	Type: TwinCAT.Ads.AdsErrorCode The ADS error code provided by the sender
readData	Type: System.ReadOnlyMemory.Byte. The read data buffer
cancel	Type: System.Threading.CancellationToken The cancellation token.

Return Value

Type: Task.AdsErrorCode.
A task that represents the asynchronous OnReadConfirmationAsync(AmsAddress, UInt32, AdsErrorCode, ReadOnlyMemory.Byte., CancellationToken) operation. The Task.TResult. parameter contains the AdsErrorCode as Result.

Remarks

Overwrite this method in derived classes to react on ADS Read confirmations. The Default implementaton just returns NoError. Because the Confirmation is the last step in the ADS communication an Error will just be logged, but not processed any further. For a functional AdsServer, this confirmation handler doesn't need to be overloaded!

Reference

AdsServer Class

TwinCAT.Ads.Server Namespace