AdsServerOnReadAsync Method

Called when an ADS Read indication is received.


Namespace: TwinCAT.Ads.Server
Assembly: TwinCAT.Ads.Server (in TwinCAT.Ads.Server.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

Syntax

C#

protected virtual Task<ResultReadBytes> OnReadAsync(
    AmsAddress sender,
    uint invokeId,
    uint indexGroup,
    uint indexOffset,
    int readLength,
    CancellationToken cancel
)

Parameters

sender  AmsAddress

The sender address of the request.

invokeId  UInt32

The invoke identifier of the request.

indexGroup  UInt32

The index group of the requested ADS service

indexOffset  UInt32

The index offset of the requested ADS service

readLength  Int32

The number of bytes to be read

cancel  CancellationToken

The cancellation token.

Return Value

Task ResultReadBytes
A task that represents the asynchronous ReadIndicationAsync(AmsAddress, UInt32, UInt32, UInt32, Int32, CancellationToken) operation. The TaskTResult 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

Beckhoff Automation GmbH & Co. KG 2001-2026