AdsServer.OnReadAsync Method

Called when an ADS Read indication 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<ResultReadBytes> OnReadAsync(
    AmsAddress sender,
    uint invokeId,
    uint indexGroup,
    uint indexOffset,
    int readLength,
    CancellationToken cancel
)

Parameters

sender	Type: TwinCAT.Ads.AmsAddress The sender address of the request.
invokeId	Type: System.UInt32 The invoke identifier of the request.
indexGroup	Type: System.UInt32 The index group of the requested ADS service
indexOffset	Type: System.UInt32 The index offset of the requested ADS service
readLength	Type: System.Int32 The number of bytes to be read
cancel	Type: System.Threading.CancellationToken The cancellation token.

Return Value

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

Remarks

Overwrite this method in derived classes to react on ADS Read indications. The default implementation replies with an ADS ServiceNotSupported error code (0x701).

Reference

AdsServer Class

TwinCAT.Ads.Server Namespace